@bitdiver/model - npm Package Compare versions

Comparing version 3.2.0 to 3.2.1

dist/src/index.d.ts

@@ -8,2 +8,3 @@ export { EnvironmentRun } from './EnvironmentRun';
 export { generateLogs } from './generateLogs';
+export { StepLoggerInterface } from './interfaceStepLogger';
 export { STATUS_OK, STATUS_UNKNOWN, STATUS_WARNING, STATUS_ERROR, STATUS_FATAL, StepType, DIR_BASE_DATA } from './constants';

package.json

 {
   "name": "@bitdiver/model",
-  "version": "3.2.0",
+  "version": "3.2.1",
   "description": "",
@@ -5,0 +5,0 @@ "main": "dist/src/index.js",

README.md

@@ -198,5 +198,70 @@ @bitdiver/model / [Exports](docApi/modules.md)
 
-Unresolved directive in index.adoc - include::environmentRun.adoc\[\]
+## EnvironmemntRun
 
-Unresolved directive in index.adoc -
-include::environmentTestcase.adoc\[\]
+The run environment is the context which lives for the whole execution
+of the run. This context could be used to store configurations or other
+data which needs to be provided to each test case. This context could be
+read and written by each step in each test case.
+
+The data is stored in a map.
+
+**EnvironmemntRun properties**
+
+    {
+      id: 'uuid'             
+      name: 'suite name'     
+      status: STATUS_OK      
+      description: 'a desc'  
+      startTime: Date.now()  
+      this.map = new Map()   
+    }
+
+-   The id is a uuid. It will be generated when the environment is
+    created.
+
+-   The name of the suite.
+
+-   The overall status of this run. If one test case has an error the
+    complete run get the status error.
+
+-   Any description for this run.
+
+-   The timestamp the run was started.
+
+-   This map is used to store the context information.
+
+## EnvironmemntTestcase
+
+The test case environment is the context which lives for the whole
+execution of the test case. For each test case an own environment will
+be created. This context is the right place to transport data from one
+step to a following step in the test case.
+
+The data is stored in a map.
+
+**EnvironmemntRun properties**
+
+    {
+      id: 'uuid'             
+      name: 'suite name'     
+      status: STATUS_OK      
+      description: 'a desc'  
+      running: true          
+      this.map = new Map()   
+    }
+
+-   The id is a uuid. It will be generated when the environment is
+    created.
+
+-   The name of the suite.
+
+-   The overall status of this run. If one test case has an error the
+    complete run get the status error.
+
+-   Any description for this run.
+
+-   if a test case has failed the running status will be switched to
+    false. So there will be no execution of further steps for this test
+    case.
+
+-   This map is used to store the context information.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

42379

increased by4.44%

Lines of code

803

increased by0.12%

Number of lines in readme file

267

increased by32.18%

No dependency changes