Studio:Folder Layout: Difference between revisions

From STRIDE Wiki
Jump to navigation Jump to search
Line 53: Line 53:


[[Category:Project Organization]]
[[Category:Project Organization]]
[[Category:Practice]]

Revision as of 16:56, 5 June 2009

This article outlines standards for placement of STRIDE solution files and folders.


Folder Layout

<Solution Root>
  Documents -- relevant documents
     Customer
     S2
  Source -- customer target source
  Target -- instrumented target binary and STRIDE database
  TestAssets -- test assets
     Doc
     TestWorkspace
     TestUnits
     TestScripts
     SCL
     UtilityScripts

Folder Contents

Documents

Customer
  • customer-supplied documents that are not included or linked on the project portal wiki
S2
  • S2-generated documents that are not included or linked in the project portal wiki
  • 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.)

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) and STRIDE 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:

Doc
Test assets code documentation goes here. This folder is created and used automatically by the CreateDocs.pl script.
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
Non-shared helper scripts and modules go here