SASUnit / Tickets / #64 Write development guidelines

Unit testing for SAS(TM)-programs

#64 Write development guidelines

Milestone: default

Status: accepted

Owner: Andreas Mangold

Labels: None

Release: v1.1

Configuration: not_relevant

Specify_other_Configuration:

Ticket_Type: Enhancement_Request

Component: Documentation

Priority: 3-moderate

Updated: 2022-01-25

Created: 2012-07-24

Creator: Andreas Mangold

Private: No

When writing [wiki:Development Guidelines], please follow the [wiki:Documentation Guidelines]. Development guidelines should be structured as follows:

[wiki:Quality Guidelines]
- Run tests for example project in batch mode until successful
- Check appearance of reports
  - ... Checklist ...
- Run test suite in inline mode (as soon as available) and check
- Run tests for SASUnit until
  - All test are green
  - except for test with “must be red” in description, which must be red
  - and except for test with “must be gray”, which must be gray
  - Run any special tests
    - Usage of special environments for execution environment (autoexec, config, …)
    - Moving projects
    - ...
[wiki:Ticket Management Guidelines] mostly done
[wiki:Programming Guidelines]
- Comments and source code documentation
- Refactoring
- General naming conventions for datasets, variables, macro symbols and macro programs
- Structure and naming conventions for files in the tst-folder
- Structure and naming conventions of macro programs for assertions
- Structure and naming conventions of macro programs for reporting
- How to deal with Temporary data
- Testing of parameters in macros for end users
- Using NLS
[wiki:Source Code Management Guidelines]
- Usage of subversion
- repository structure
- linking of commits to tickets
[wiki:Deployment Guidelines], see [bugs:#7]
- Relevant environment information
  - control and reporting environment
    - SAS version
    - SAS language setting
    - OS and version
    - OS language setting
  - execution environment (might be different in future versions of SASUnit)
    - SAS version
    - SAS language setting
    - OS and version
    - OS language setting
- deployment process
  - test all relevant combinations of environments
  - write cmd-files for all combinations of environments tested successfully
  - document SASUnit version number in
  - prepare readme.txt
    - document tested combinations of environments in deployment
    - document assumptions for paths (should follow SAS defaults for the respective environment)
    - document main configuration settings in included SAS configuration files
    - document any changes needed in command files or SAS programs when paths are not as assumed
    - check and perform any necessary updates in short documentation
  - run doxygen
  - run sasunit
  - run german report generation
  - select relevant files
[wiki:Documentation Guidelines] mostly done

Description has changed:

Diff:

--- old
+++ new
@@ -1,10 +1,10 @@
 When writing [wiki:Development Guidelines], please follow the [wiki:Documentation Guidelines]. Development guidelines should be structured as follows: 

-* Quality Guidelines
+* [wiki:Quality Guidelines]

     * Run tests for example project in batch mode until successful
     * Check appearance of reports
-        * Checklist has to be written
-    * Run test suite in inline mode (when available)
+        * ... Checklist ...
+    * Run test suite in inline mode (as soon as available) and check
     * Run tests for SASUnit until 
         * All test are green 
         * except for test with “must be red” in description, which must be red
@@ -12,21 +12,23 @@
         * Run any special tests
             * Usage of special environments for execution environment (autoexec, config, …)
             * Moving projects
-            * …
-* Ticket Management Guidelines
-* Programming Guidelines
+            * ...
+* [wiki:Ticket Management Guidelines] mostly done
+* [wiki:Programming Guidelines]
     * Comments and source code documentation
     * Refactoring
     * General naming conventions for datasets, variables, macro symbols and macro programs
-    * Naming conventions for files in the tst-folder
-    * Naming conventions for macro programs for asserts 
-    * Naming conventions for macro programs for reporting formats 
+    * Structure and naming conventions for files in the tst-folder
+    * Structure and naming conventions of macro programs for assertions
+    * Structure and naming conventions of macro programs for reporting  
     * How to deal with Temporary data
     * Testing of parameters in macros for end users
     * Using NLS
-    * Writing new Assertions
-* Source Code Management Guidelines
-* Deployment Guidelines
+* [wiki:Source Code Management Guidelines]
+    * Usage of subversion
+    * repository structure
+    * linking of commits to tickets
+* [wiki:Deployment Guidelines], see [bugs:#7]
     * Relevant environment information
         * control and reporting environment
             * SAS version
@@ -52,4 +54,4 @@
         * run sasunit
         * run german report generation
         * select relevant files
-* Documentation Guidelines 
+* [wiki:Documentation Guidelines] mostly done

assigned_to: Andreas Mangold

Anonymous

Add attachments
Cancel
You seem to have CSS turned off. Please don't fill out this field.

You seem to have CSS turned off. Please don't fill out this field.

Klaus Landwich - 2015-02-05

Milestone: v1.5 --> v2.0
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
- Anonymous
  
  Add attachments
  Cancel
  You seem to have CSS turned off. Please don't fill out this field.
  
  You seem to have CSS turned off. Please don't fill out this field.

Klaus Landwich - 2015-02-05

In our last developer meeting we discussed this topic. As long as the programming is exclusively done by HMS employees, there is no urgent need to outline these documents, so we will push it to the next milestone.

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
- Anonymous
  
  Add attachments
  Cancel
  You seem to have CSS turned off. Please don't fill out this field.
  
  You seem to have CSS turned off. Please don't fill out this field.

Klaus Landwich - 2022-01-25

Milestone: v2.1 --> default
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
- Anonymous
  
  Add attachments
  Cancel
  You seem to have CSS turned off. Please don't fill out this field.
  
  You seem to have CSS turned off. Please don't fill out this field.

Anonymous

Write development guidelines

Unit testing for SAS(TM)-programs

Milestone

Searches

Help

#64 Write development guidelines

Related

Discussion