Studio:Workspace Setup: Difference between revisions

From STRIDE Wiki
Jump to navigation Jump to search
(New page: This article outlines standards for placement of STRIDE solution files and folders. =Folder Layout= <Solution Root> Documents ''-- relevant documents'' [[#Custo...)
 
m (Text replace - 'Category:Project Organization' to 'Category:Studio:Project Organization')
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This article outlines standards for placement of STRIDE solution files and folders.
This article outlines the recommended organization for a Test Workspace. The [[WorkspaceSetup.pl]] utility script should be used to create the workspace. The ''command line'' script will automatically create a workspace with the passed in ''name'':


  WorkspaceSetup.pl -w ''name''


=Folder Layout=


<Solution Root>
The auto-generated workspace will contain the following logical folders. For more [[WorkspaceSetup.pl | details]] refer to WorkspaceSetup.pl. 
  [[#Documents|Documents]] ''-- relevant documents''
      [[#Customer|Customer]]
      [[#S2|S2]]
  [[#Source|Source]] ''-- customer target source''
  [[#Target|Target]] ''-- instrumented target binary and STRIDE databse''
  [[#TestAssets|TestAssets]] ''-- test assets''
      [[#TestWorkspace|TestWorkspace]]
      [[#TestUnits|TestUnits]]
      [[#TestScripts|TestScripts]]
      [[#SCL|SCL]]
      [[#UtilityScripts|UtilityScripts]]


=Folder Contents=
<Script Files>
  [[#setup|setup]] ''-- relevant setup fixtures''
  [[#test|test]] ''-- test assets''
  [[#teardown|teardown]] ''-- relevant teardown fixtures''
  [[#utility|utility]] ''-- utilities and libraries''


== Documents ==
Test Suites and Test Cases shall be placed under the '''test''' folder.
;Customer
:<ul><li>customer-supplied documents that are not included or linked on the project portal wiki</li></ul>
;S2
:<ul><li>S2-generated documents that are not included or linked in the project portal wiki</li><li>S2-generated documents that have been uploaded to the project portal wiki and embedded in a wiki page. (e.g. Visio drawings, screen shots, etc.)</li></ul>


==Source==
Customer source code required to build the target is stored here.


Subfolder organization should follow that used by the customer.


==Target==
Local target app built from Visual Studio (customer source + IM)
Workspace database (.sidb) built from STRIDE Studio
==TestAssets==
Note: If there are multiple components, each requiring a unique set of TestAssets, than a sub-folder should be created representing the name of the component under test.


The following hierarchy is recommended:
[[Category:Studio:Project Organization]]
 
;TestWorkspace
: STRIDE workspace (.ssw) file goes here
;TestUnits
: If the workspace has test units defined, source files go here
;TestScripts
: Test scripts
;SCL
: Header files comprising this project's SCL go here as well as any s2instrument option files
;UtilityScripts
: Helper scripts and modules go here
 
[[Category:Project Organization]]
[[Category:Practice]]

Latest revision as of 22:34, 20 August 2009

This article outlines the recommended organization for a Test Workspace. The WorkspaceSetup.pl utility script should be used to create the workspace. The command line script will automatically create a workspace with the passed in name: 

 WorkspaceSetup.pl -w name


The auto-generated workspace will contain the following logical folders. For more details refer to WorkspaceSetup.pl. 

<Script Files>
  setup -- relevant setup fixtures
  test -- test assets
  teardown -- relevant teardown fixtures
  utility -- utilities and libraries

Test Suites and Test Cases shall be placed under the test folder.

Retrieved from "https://www.stridewiki.com/index.php?title=Studio:Workspace_Setup&oldid=10828"