Studio:WorkspaceSetup.pl: Difference between revisions
No edit summary |
|||
Line 1: | Line 1: | ||
The WorkspaceSetup.pl script (found in the STRIDE ''scripts'' directory) provides a command line tool for creating workspaces | The WorkspaceSetup.pl script (found in the STRIDE ''scripts'' directory) provides a command line tool for creating canonical STRIDE Studio workspaces suitable for organizing your test scripts. This script requires perl for execution as well as the STRIDE Test Utilities. | ||
==Usage== | ==Usage== | ||
Line 14: | Line 14: | ||
;-d | --dirworkspace = WorkspaceDirectory | ;-d | --dirworkspace = WorkspaceDirectory | ||
:Specifies the directory in which to create the new workspace. Defaults to the current directory. | :Specifies the directory in which to create the new workspace. Defaults to the current directory. | ||
;-c | --workspaceconfig = MyConfig.pm | ;-c | --workspaceconfig = MyConfig.pm | ||
:Allows users to specify a different WorkspaceConfig file to use when creating the workspace. This allows framework users to generate a workspace with custom config parameters. | :Allows users to specify a different WorkspaceConfig file to use when creating the workspace. This allows framework users to generate a workspace with custom config parameters. | ||
Line 40: | Line 23: | ||
The workspaces that are created by WorkspaceSetup will have the following files and folders (items in '''<brackets>''' indicate folders): | The workspaces that are created by WorkspaceSetup will have the following files and folders (items in '''<brackets>''' indicate folders): | ||
'''< Script Files | '''< Script Files >''' | ||
'''<[[#setup Folder|setup]]>''' | '''<[[#setup Folder|setup]]>''' | ||
[[Creating Frameworks#StartPrintLog.pl|StartPrintLog.pl]] | [[Creating Frameworks#StartPrintLog.pl|StartPrintLog.pl]] | ||
'''<[[#test Folder|test]]>''' | |||
'''<[[#test Folder|test]] | |||
'''<[[#teardown Folder|teardown]]>''' | '''<[[#teardown Folder|teardown]]>''' | ||
[[Creating Frameworks#StopPrintLog.pl|StopPrintLog.pl]] | [[Creating Frameworks#StopPrintLog.pl|StopPrintLog.pl]] | ||
[[Creating Frameworks#TweakResults.pl|TweakResults.pl]] | [[Creating Frameworks#TweakResults.pl|TweakResults.pl]] | ||
'''<[[#utility Folder|utility]]>''' | '''<[[#utility Folder|utility]]>''' | ||
'''<[[#recovery Folder|recovery]]>''' | '''<[[#recovery Folder|recovery]]>''' | ||
[[Creating Frameworks#OnError.pl (framework)| | [[Creating Frameworks#OnError.pl (framework)|s2OnError.pl]] | ||
'''< Source Files >''' | '''< Source Files >''' | ||
===setup Folder=== | ===setup Folder=== | ||
This folder | This folder is intended to contain the scripts necessary to prepare the device for testing. For the canonical workspace, we add a script that opens a traceview to capture srPrint* output messages. Users might choose to add scripts for starting and initializing the device under test. | ||
===test Folder=== | ===test Folder=== | ||
This folder | This folder is intended to contain the test scripts to be executed on the device. It is created by this setup and test script writers are free to organize test scripts however they want in this folder. This folder also has the "OnRunConnect" property set to true so that a target connection will be initiated when it is executed. The connection is established using your global connection settings (see STRIDE Studio reference guide for more information). | ||
===teardown Folder=== | ===teardown Folder=== | ||
This folder contains the scripts necessary to cleanup after testing is completed. | This folder contains the scripts necessary to cleanup after testing is completed. This might involve, for example, stopping the device. The canonical workspace contains one script to process the srPrint* info sent to the logging traceview and another to adjust the hierarchy of the final report results. | ||
===utility Folder=== | ===utility Folder=== | ||
This folder | This folder should be used to hold utility libraries that are associated with the workspace. This directory is not included in execution; as such, the files therin are provided for convenience to the users. | ||
===recovery Folder=== | ===recovery Folder=== | ||
This folder contains the | This folder contains the sample s2OnError script that we provide. This is intended as a template for customization depending on your device's needs. | ||
This | |||
== See Also == | == See Also == |
Revision as of 22:04, 2 December 2008
The WorkspaceSetup.pl script (found in the STRIDE scripts directory) provides a command line tool for creating canonical STRIDE Studio workspaces suitable for organizing your test scripts. This script requires perl for execution as well as the STRIDE Test Utilities.
Usage
Summary
WorkspaceSetup.pl -w MyWorkspace -d "MyDir" -f fxname [-g fxdir -p pkg -q pkgdir -s customsettings -c customconfig -l]
- Parameters
- -w | --workspacename = WorkspaceName
- Specifies the name new workspace to be created. This workspace will be created in the directory specified by the --dirworkspace argument or in the current directory (if no workspace directory is specified). Defaults to 'MyWorkspace'.
- -d | --dirworkspace = WorkspaceDirectory
- Specifies the directory in which to create the new workspace. Defaults to the current directory.
- -c | --workspaceconfig = MyConfig.pm
- Allows users to specify a different WorkspaceConfig file to use when creating the workspace. This allows framework users to generate a workspace with custom config parameters.
- -l | --launch
- Launches STRIDE Studio and opens the newly created workspace.
Workspace Layout
The workspaces that are created by WorkspaceSetup will have the following files and folders (items in <brackets> indicate folders):
< Script Files > <setup> StartPrintLog.pl <test> <teardown> StopPrintLog.pl TweakResults.pl <utility> <recovery> s2OnError.pl
< Source Files >
setup Folder
This folder is intended to contain the scripts necessary to prepare the device for testing. For the canonical workspace, we add a script that opens a traceview to capture srPrint* output messages. Users might choose to add scripts for starting and initializing the device under test.
test Folder
This folder is intended to contain the test scripts to be executed on the device. It is created by this setup and test script writers are free to organize test scripts however they want in this folder. This folder also has the "OnRunConnect" property set to true so that a target connection will be initiated when it is executed. The connection is established using your global connection settings (see STRIDE Studio reference guide for more information).
teardown Folder
This folder contains the scripts necessary to cleanup after testing is completed. This might involve, for example, stopping the device. The canonical workspace contains one script to process the srPrint* info sent to the logging traceview and another to adjust the hierarchy of the final report results.
utility Folder
This folder should be used to hold utility libraries that are associated with the workspace. This directory is not included in execution; as such, the files therin are provided for convenience to the users.
recovery Folder
This folder contains the sample s2OnError script that we provide. This is intended as a template for customization depending on your device's needs.