@aj-shadow/actorjs-documentation-text 0.0.0-aj-beta.221

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (160) hide show
  1. package/.gitattributes +26 -0
  2. package/Documentation/Document-global-Be-100-more-efficient.txt +31 -0
  3. package/Documentation/Document-global-actorjs-trigger-mock-and-intercept-anything.txt +21 -0
  4. package/Documentation/Document-global-advanced-visualization.txt +28 -0
  5. package/Documentation/Document-global-debugging.txt +4 -0
  6. package/Documentation/Document-global-divide-and-reuse.txt +37 -0
  7. package/Documentation/Document-global-general-separation.txt +2 -0
  8. package/Documentation/Document-global-markup-anchor.txt +6 -0
  9. package/Documentation/Document-global-markup-api-status.txt +39 -0
  10. package/Documentation/Document-global-markup-chart-line.txt +18 -0
  11. package/Documentation/Document-global-markup-documentation-status.txt +39 -0
  12. package/Documentation/Document-global-markup-documentation.txt +72 -0
  13. package/Documentation/Document-global-markup-embed.txt +6 -0
  14. package/Documentation/Document-global-markup-flowchart.txt +88 -0
  15. package/Documentation/Document-global-markup-html.txt +122 -0
  16. package/Documentation/Document-global-markup-ie.txt +18 -0
  17. package/Documentation/Document-global-markup-image.txt +55 -0
  18. package/Documentation/Document-global-markup-lab.txt +63 -0
  19. package/Documentation/Document-global-markup-markup.txt +21 -0
  20. package/Documentation/Document-global-markup-navigation.txt +25 -0
  21. package/Documentation/Document-global-markup-node-diagram.txt +163 -0
  22. package/Documentation/Document-global-markup-note.txt +6 -0
  23. package/Documentation/Document-global-markup-ref.txt +6 -0
  24. package/Documentation/Document-global-markup-sequence-diagram.txt +215 -0
  25. package/Documentation/Document-global-markup-state-machine.txt +121 -0
  26. package/Documentation/Document-global-markup-table.txt +34 -0
  27. package/Documentation/Document-global-navigation-pane.txt +3 -0
  28. package/Documentation/Document-global-navigation.txt +2 -0
  29. package/Documentation/Document-global-specialized-javascript-editors.txt +2 -0
  30. package/Documentation/Document-global-stacks-connection.txt +2 -0
  31. package/Documentation/Document-global-stacks-server.txt +2 -0
  32. package/Documentation/Document-global-test-environment-overview.txt +15 -0
  33. package/Documentation/Document-global-the-architecture.txt +51 -0
  34. package/Documentation/Document-global-the-development-environment.txt +5 -0
  35. package/Documentation/Document-global-the-test-environment.txt +15 -0
  36. package/Documentation/Document-global-think-ahead.txt +35 -0
  37. package/Documentation/Document-global-thinking-in-actors-unlimited.txt +1 -0
  38. package/Documentation/Document-global-what-is-a-stack.txt +2 -0
  39. package/Documentation/Document-global-why-actorjs.txt +52 -0
  40. package/Documentation/Document-global-why-actors-unlimited.txt +182 -0
  41. package/Documentation/Document-global-x-test-case-tool.txt +2 -0
  42. package/Documentation/Navigation-Documentation-actorjs-global.txt +372 -0
  43. package/Documentation/Navigation-Documentation-actorsite-global.txt +363 -0
  44. package/Documentation/abstractions/Document-global-addressing.txt +81 -0
  45. package/Documentation/abstractions/Document-global-configuration-floor.txt +2 -0
  46. package/Documentation/abstractions/Document-global-content.txt +3 -0
  47. package/Documentation/abstractions/Document-global-functions-test.txt +4 -0
  48. package/Documentation/abstractions/Document-global-functions-unde-test.txt +2 -0
  49. package/Documentation/abstractions/Document-global-load-test.txt +3 -0
  50. package/Documentation/abstractions/Document-global-repo.txt +79 -0
  51. package/Documentation/abstractions/Document-global-shared-data.txt +5 -0
  52. package/Documentation/abstractions/Document-global-system-to-test.txt +2 -0
  53. package/Documentation/abstractions/Document-global-system-under-test.txt +3 -0
  54. package/Documentation/abstractions/Document-global-test-data.txt +251 -0
  55. package/Documentation/abstractions/Document-global-test-suite.txt +37 -0
  56. package/Documentation/abstractions/Document-global-verification-data.txt +103 -0
  57. package/Documentation/abstractions/actor/Document-global-actor-condition.txt +74 -0
  58. package/Documentation/abstractions/actor/Document-global-actor-local.txt +44 -0
  59. package/Documentation/abstractions/actor/Document-global-actor-originating.txt +100 -0
  60. package/Documentation/abstractions/actor/Document-global-actor-proxy.txt +119 -0
  61. package/Documentation/abstractions/actor/Document-global-actor-terminating.txt +101 -0
  62. package/Documentation/abstractions/actor/Document-global-actor.txt +90 -0
  63. package/Documentation/abstractions/actor/Document-global-execution-states.txt +21 -0
  64. package/Documentation/abstractions/actorpart/Document-global-actorpart.txt +2 -0
  65. package/Documentation/abstractions/stack/Document-global-client-connection.txt +3 -0
  66. package/Documentation/abstractions/stack/Document-global-connection.txt +3 -0
  67. package/Documentation/abstractions/stack/Document-global-decoder.txt +3 -0
  68. package/Documentation/abstractions/stack/Document-global-encoder.txt +3 -0
  69. package/Documentation/abstractions/stack/Document-global-message.txt +4 -0
  70. package/Documentation/abstractions/stack/Document-global-server-connection.txt +3 -0
  71. package/Documentation/abstractions/stack/Document-global-stack.txt +12 -0
  72. package/Documentation/abstractions/stack/Document-global-worker.txt +3 -0
  73. package/Documentation/abstractions/test-case/Document-global-phases.txt +30 -0
  74. package/Documentation/abstractions/test-case/Document-global-test-case-result.txt +23 -0
  75. package/Documentation/abstractions/test-case/Document-global-test-case.txt +199 -0
  76. package/Documentation/actor-api/Document-global-actor-part.txt +7 -0
  77. package/Documentation/actor-api/Document-global-actor.txt +375 -0
  78. package/Documentation/actor-api/Document-global-async.txt +176 -0
  79. package/Documentation/actor-api/Document-global-client-stack.txt +215 -0
  80. package/Documentation/actor-api/Document-global-content.txt +106 -0
  81. package/Documentation/actor-api/Document-global-logger.txt +426 -0
  82. package/Documentation/actor-api/Document-global-process.txt +7 -0
  83. package/Documentation/actor-api/Document-global-server-stack.txt +213 -0
  84. package/Documentation/actor-api/Document-global-shared-data.txt +259 -0
  85. package/Documentation/actor-api/Document-global-test-data.txt +816 -0
  86. package/Documentation/actor-api/Document-global-timer.txt +70 -0
  87. package/Documentation/actor-api/Document-global-verification-data.txt +624 -0
  88. package/Documentation/connection-worker-api/Document-global-logger.txt +3 -0
  89. package/Documentation/documentation-references.json +199 -0
  90. package/Documentation/embedded/Document-global-test-case-result.txt +10 -0
  91. package/Documentation/howto/Document-global-create-actor.txt +1 -0
  92. package/Documentation/howto/Document-global-create-stack.txt +1 -0
  93. package/Documentation/howto/Document-global-create-test-case.txt +1 -0
  94. package/Documentation/howto/Document-global-create-test-suite.txt +1 -0
  95. package/Documentation/howto/Document-global-define-addresses.txt +1 -0
  96. package/Documentation/howto/Document-global-define-fut.txt +1 -0
  97. package/Documentation/howto/Document-global-define-sut.txt +16 -0
  98. package/Documentation/howto/Document-global-full-workflow.txt +143 -0
  99. package/Documentation/howto/Document-global-normal-workflow.txt +58 -0
  100. package/Documentation/howto/Document-global-prerequisites.txt +8 -0
  101. package/Documentation/howto/prerequisites/Document-global-install-actorjs.txt +64 -0
  102. package/Documentation/howto/prerequisites/Document-global-install-git.txt +26 -0
  103. package/Documentation/howto/prerequisites/Document-global-install-nodejs.txt +19 -0
  104. package/Documentation/markup/Document-global-markup-test-case.txt +6 -0
  105. package/Documentation/markup/Document-global-markup-test-suite.txt +13 -0
  106. package/Documentation/markup/embed/Document-global-inner_markup_tc.txt +164 -0
  107. package/Documentation/nodejs-api/Document-global-fs.txt +7 -0
  108. package/Documentation/stack-api/Document-global-ascii-dictionary.txt +108 -0
  109. package/Documentation/stack-api/Document-global-binary-log.txt +91 -0
  110. package/Documentation/stack-api/Document-global-bit-byte.txt +80 -0
  111. package/Documentation/stack-api/Document-global-content-base.txt +169 -0
  112. package/Documentation/stack-api/Document-global-ip-log.txt +101 -0
  113. package/Documentation/stack-api/Document-global-log-inner.txt +152 -0
  114. package/Documentation/stack-api/Document-global-log-part-error.txt +12 -0
  115. package/Documentation/stack-api/Document-global-log-part-ref.txt +80 -0
  116. package/Documentation/stack-api/Document-global-log-part-text.txt +81 -0
  117. package/Documentation/tools/Document-global-actors.txt +196 -0
  118. package/Documentation/tools/Document-global-addressing.txt +38 -0
  119. package/Documentation/tools/Document-global-content.txt +1 -0
  120. package/Documentation/tools/Document-global-global-test-data.txt +197 -0
  121. package/Documentation/tools/Document-global-stacks.txt +1 -0
  122. package/Documentation/tools/Document-global-test-case-analyze.txt +3 -0
  123. package/Documentation/tools/Document-global-test-case-debug.txt +16 -0
  124. package/Documentation/tools/Document-global-test-case-definition.txt +37 -0
  125. package/Documentation/tools/Document-global-test-case-execution.txt +28 -0
  126. package/Documentation/tools/Document-global-test-case-log.txt +95 -0
  127. package/Documentation/tools/Document-global-test-case-sequence-diagram.txt +17 -0
  128. package/Documentation/tools/Document-global-test-case-specification.txt +3 -0
  129. package/Documentation/tools/Document-global-test-cases.txt +11 -0
  130. package/Documentation/tools/Document-global-tool-test-suite.txt +202 -0
  131. package/Education/Document-global-add-your-first-addresses.txt +75 -0
  132. package/Education/Document-global-define-your-first-sut.txt +18 -0
  133. package/Education/Document-global-make-your-first-actors.txt +35 -0
  134. package/Education/Document-global-make-your-first-test-case.txt +43 -0
  135. package/Education/Document-global-make-your-first-test-suite.txt +29 -0
  136. package/Education/Document-global-share-your-work.txt +35 -0
  137. package/Education/Navigation-Education-actorjs-global.txt +31 -0
  138. package/LICENSE.txt +96 -0
  139. package/README.md +5 -0
  140. package/Workshop/Document-global-actordemo-image-ai.txt +5 -0
  141. package/Workshop/Document-global-actordemo-login.txt +10 -0
  142. package/Workshop/Document-global-actordemo-site.txt +3 -0
  143. package/Workshop/Document-global-actordemo-start.txt +5 -0
  144. package/Workshop/Document-global-actordemo-the-architecture.txt +27 -0
  145. package/Workshop/Document-global-introduction-actor.txt +84 -0
  146. package/Workshop/Document-global-introduction-actorjs.txt +42 -0
  147. package/Workshop/Document-global-introduction-stack.txt +25 -0
  148. package/Workshop/Document-global-introduction-system-under-test.txt +102 -0
  149. package/Workshop/Document-global-introduction-test-case.txt +50 -0
  150. package/Workshop/Document-global-introduction-test-suite.txt +31 -0
  151. package/Workshop/Document-global-login-with-puppeter.txt +45 -0
  152. package/Workshop/Document-global-mock-with-http.txt +83 -0
  153. package/Workshop/Document-global-mock-with-icap.txt +94 -0
  154. package/Workshop/Document-global-prerequisites-actorJs.txt +18 -0
  155. package/Workshop/Document-global-prerequisites-actordemo.txt +15 -0
  156. package/Workshop/Document-global-trigger-with-http.txt +93 -0
  157. package/Workshop/Document-global-trigger-with-puppeter.txt +49 -0
  158. package/Workshop/Navigation-Workshop-actorjs-global.txt +86 -0
  159. package/npm-shrinkwrap.json +13 -0
  160. package/package.json +10 -0
@@ -0,0 +1,95 @@
1
+ # The Log Tab
2
+
3
+ The Log tab shows the logs of the Test Case and its [Actors](actors). The logs are shown in real time. A log consists of following data:
4
+ **type:** The type of log.
5
+ * **Engine:** Engine logs are created by ActorJs.
6
+ * **Debug:** Logs with debugging information.
7
+ * **Error:** Logs showing what went wrong.
8
+ * **Warning:** Logs that warns the user of things that might be wrong. i.e. deprecation och miss using.
9
+ * **IP:** Log showing the communication done by the [Actors](actors).
10
+ * **Success:** Verification Success log. Showing data of the verifications done.
11
+ * **Failure:** Verification Failure log. Showing data of the verifications done.
12
+
13
+ **date:** The timestamp of the log.
14
+ * *format:* `weekday`, `day` `month` `year` `hour`:`minute`:`second` GMT : `milliseconds with three decimals`
15
+ * *example:* Mon, 03 Oct 2016 22:52:05 GMT : 901.764
16
+
17
+ **actor:** The name of the Actor and the instance id of it.
18
+ * *format:* `the name of the actor`[`instance id`]. The instance id is from 1 - n.
19
+ * *example:* DemoLogLocal[1]
20
+
21
+ **log:** The log which can be in different formats. The type of log defines what format log will be in.
22
+ * *text:* Just simple text.
23
+ * *tree:* A tree view to be able to have hidden data that is shown when wanted. **`TO BE DONE`**
24
+
25
+ **file name:** Link to the implementation of the [Actor](actors).
26
+
27
+ ## Example - The Case Start
28
+ ```object
29
+ [log_start](Mon. 03 Oct 2016 22:52:05 GMT : 901.764)
30
+ ```
31
+
32
+ ## Example - The Case End
33
+ ```object
34
+ [log_end](Failure, 0.321ms)
35
+ ```
36
+
37
+ ## Example - The Test Data Log
38
+ ```object
39
+ [log](TestData, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo test data log., Actors-global.demo.log.DemoLogLocal.js)
40
+ ```
41
+
42
+ ## Example - The Engine Log
43
+ ```object
44
+ [log](Engine, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo engine log., Actors-global.demo.log.DemoLogLocal.js)
45
+ ```
46
+
47
+ ## Example - The Debug Log
48
+ ```object
49
+ [log](Debug, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo debug log., Actors-global.demo.log.DemoLogLocal.js)
50
+ ```
51
+
52
+ ## Example - The Error Log
53
+ ```object
54
+ [log](Error, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo error log., Actors-global.demo.log.DemoLogLocal.js)
55
+ ```
56
+
57
+ ## Example - The Warning Log
58
+ ```object
59
+ [log](Warning, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo warninglog., Actors-global.demo.log.DemoLogLocal.js)
60
+ ```
61
+
62
+ ## Example - The IP Log
63
+ ```object
64
+ [log](IP, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo ip log., Actors-global.demo.log.DemoLogLocal.js)
65
+ ```
66
+
67
+ ## Example - The Success Log
68
+ ```object
69
+ [log](Success, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo success log., Actors-global.demo.log.DemoLogLocal.js)
70
+ ```
71
+
72
+ ## Example - The Failure Log
73
+ ```object
74
+ [log](Failure, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo failure log., Actors-global.demo.log.DemoLogLocal.js)
75
+ ```
76
+
77
+ ## Demo
78
+ See the logs in the demo [DemoLog001](/test-cases/Actor/Demo/DemoLog001/execution).
79
+
80
+ ## API
81
+ Use the [Logger API](logger) in Actors API to write logs in your [Actors](actors).
82
+
83
+ ## Toolbar
84
+ The **log buttons** to execute the Test Case are:
85
+ <br/>
86
+
87
+ ```object
88
+ [button](glyphicon-play test_case_log, **Run:** Execute the Test Case.)
89
+ [br]
90
+ [button](glyphicon-play test_case_log_slow, **Run Slow:** Execute the Test Case in a **visualized** way by a short delay between the different states of the [Actors](actors). The delay is set as [Test Data](test-datas). The default value is set in the [TestDataEnvironment](/test-data/environment) tables.)
91
+ [br]
92
+ [button](glyphicon-stop test_case_log, **Stop:** Stop executing the Test Case.)
93
+ [br]
94
+ [button](glyphicon-erase test_case_log, **Clear:** Remove all logs.)
95
+ ```
@@ -0,0 +1,17 @@
1
+ # The Sequence Diagram Tab
2
+
3
+ ***`TO BE DONE`***
4
+
5
+ ## Toolbar
6
+ The **sequence diagram buttons** to execute the Test Case are:
7
+ <br/>
8
+
9
+ ```object
10
+ [button](glyphicon-play test_case_sequence-diagram, **Run:** Execute the Test Case.)
11
+ [br]
12
+ [button](glyphicon-play test_case_sequence-diagram_slow, **Run Slow:** Execute the Test Case in a **visualized** way by a short delay between the different states of the [Actors](actors). The delay is set as [Test Data](test-datas). The default value is set in the [TestDataEnvironment](/test-data/environment) tables.)
13
+ [br]
14
+ [button](glyphicon-stop test_case_sequence-diagram, **Stop:** Stop executing the Test Case.)
15
+ [br]
16
+ [button](glyphicon-erase test_case_sequence-diagram, **Clear:** Remove all sequence diagrams.)
17
+ ```
@@ -0,0 +1,3 @@
1
+ # The Specification Tab
2
+
3
+ ***`TO BE DONE`***
@@ -0,0 +1,11 @@
1
+ # **Test Cases - Tool**
2
+ The [[REF=, TOOL_Test_Case]] is used to create, edit, delete and run [[REF=, ABS_Test_Case]]s.
3
+
4
+ ## **Test Case Tool Tabs**
5
+ + [[REF=, TOOL_Test_Case_Definition]]
6
+ + [[REF=, TOOL_Test_Case_Execution]]
7
+ + [[REF=, TOOL_Test_Case_Log]]
8
+ + [[REF=, TOOL_Test_Case_Sequence_Diagram]]
9
+ + [[REF=, TOOL_Test_Case_Debug]]
10
+ + [[REF=, TOOL_Test_Case_Specification]]
11
+ + [[REF=, TOOL_Test_Case_Analyze]]
@@ -0,0 +1,202 @@
1
+ <a name="topOfPage"></a>
2
+ # Test Suite Tool
3
+ The Test Suite Tool is used to create, specify and run [Test Suite](test-suites)s.
4
+
5
+ ***`TBD, just copiet from older version of 'Test Case Tool'. Should be split the same way as for 'Test Case Tool'.`***
6
+
7
+ ## Test Case Tabs
8
+ [The Definition Tab](#test-case-definition)
9
+ [The Execution Tab](#test-case-execution)
10
+ [The Log Tab](#test-case-execution)
11
+ [The Sequence Diagram Tab](#test-case-sequence-diagram)
12
+ [The Specification Tab](#test-case-specification)
13
+ [The Analyze Tab](#test-case-analyze)
14
+
15
+ ### The Definition Tab<a name="test-case-definition" class="markup_bookmark" href="#topOfPage">#</a>
16
+
17
+ #### Content
18
+ The Definition tab visualizes the definition of a Test Case and generates images of the tables defining the Test Case. [Test Case Markup](markup-test-case) is used to define the Test Case.
19
+
20
+ ```tc
21
+ |Actor |
22
+ |name |type |phase|execution|src|dst|srv|testData|verification|
23
+ |Actors.engine.EmptyVerifyActorStatesInitLocal|local|pre | | | | | | |
24
+ |Actors.engine.EmptyOrig |orig | | | | | | | |
25
+ |Actors.engine.EmptyVerifyActorStatesLocal |local|post | | | | | | |
26
+
27
+ |TestDataTestCase |
28
+ |key |value |description|
29
+ |defaultValue|["[1.1, 2.2]", "[3.3, 4.4]"]| |
30
+ |defaultType |[string] | |
31
+
32
+ |VerificationTestCase |
33
+ |key |value |operation|type |description|
34
+ |stateControl[]|[1, 0, 1, 1, 1]| |[number]| |
35
+ ```
36
+
37
+ #### Buttons
38
+ The the **markup buttons** to update the Test Case is:
39
+
40
+ ```object
41
+ [button](glyphicon-edit, **`Edit:`**`Test Case Markup`. Start editing the [Test Case Markup](markup-test-case).)
42
+ [br]
43
+ [button](glyphicon-save-file, **`Save:`**`Test Case Markup`. Save the updated [Test Case Markup](markup-test-case).)
44
+ [br]
45
+ [button](glyphicon-remove-circle, **`Close:`**`Test Case Markup`. Close the [Test Case Markup](markup-test-case) without saving the changes.)
46
+ [br]
47
+ [button](glyphicon-question-sign, **`Help:`**`Test Case Markup`. Go to the [Test Case Markup](markup-test-case) help.)
48
+ ```
49
+
50
+ ### The Execution Tab<a name="test-case-execution" class="markup_bookmark" href="#topOfPage">#</a>
51
+ #### Content
52
+ The Execution tab shows the *execution result*, *start time* and *duration* of the Test Case.
53
+ **result:** The result of the Test Case.
54
+ * **none:** There are no Actors that have been executed.
55
+ * **n/a:**
56
+ * **n_impl:**
57
+ * **success:**
58
+ * **n_exec:**
59
+ * **interrupt:**
60
+ * **error:**
61
+ * **failure:** Verification failure, one or more Actors have reported a failure.
62
+ * **timeout:**
63
+
64
+ **time:** The time when the Test Case started.
65
+ * *format:* `weekday`, `day` `month` `year` `hour`:`minute`:`second` GMT : `milliseconds with three decimals`
66
+ * *example:* Mon, 03 Oct 2016 22:52:05 GMT : 901.764
67
+
68
+ **duration:** The duration of the Test Case.
69
+ * *format:* `milliseconds with three decimals`ms
70
+ * *example:* 0.570ms
71
+
72
+ #### Buttons
73
+ The the **execution buttons** to execute the Test Case is:
74
+ ```object
75
+ [button](glyphicon-play test_case_execution, **`Run:`**`Test Case in the Execution tab`. Execute the Test Case.)
76
+ [br]
77
+ [button](glyphicon-play test_case_execution_slow, **`Run Slow:`**`Test Case in the Execution tab`. Execute the Test Case in a **visualized** way by a short delay between the different states of the [Actors](actors). The delay is set as [Test Data](test-datas). The default value is set in the [TestDataEnvironment](/test-data/environment) tables.)
78
+ [br]
79
+ [button](glyphicon-stop test_case_execution, **`Stop:`**`Test Case`. Stop executing the Test Case.)
80
+ [br]
81
+ [button](glyphicon-erase test_case_execution, **`Clear:`**`Execution`. Remove all execution data.)
82
+ ```
83
+
84
+ ### The Log Tab<a name="test-case-log" class="markup_bookmark" href="#topOfPage">#</a>
85
+ #### Content
86
+ The Log tab shows the logs of the Test Case and its [Actors](actors). The logs are shown in real time. A log consists of following data:
87
+ **type:** The type of log.
88
+ * **Engine:** Engine logs are created by ActorJs.
89
+ * **Debug:** Logs with debugging information.
90
+ * **Error:** Logs showing what went wrong.
91
+ * **Warning:** Logs that warns the user of things that might be wrong. i.e. deprecation och miss using.
92
+ * **IP:** Log showing the communication done by the [Actors](actors).
93
+ * **Success:** Verification Success log. Showing data of the verifications done.
94
+ * **Failure:** Verification Failure log. Showing data of the verifications done.
95
+
96
+ **date:** The timestamp of the log.
97
+ * *format:* `weekday`, `day` `month` `year` `hour`:`minute`:`second` GMT : `milliseconds with three decimals`
98
+ * *example:* Mon, 03 Oct 2016 22:52:05 GMT : 901.764
99
+
100
+ **actor:** The name of the Actor and the instance id of it.
101
+ * *format:* `the name of the actor`[`instance id`]. The instance id is from 1 - n.
102
+ * *example:* DemoLogLocal[1]
103
+
104
+ **log:** The log which can be in different formats. The type of log defines what format log will be in.
105
+ * *text:* Just simple text.
106
+ * *tree:* A tree view to be able to have hidden data that is shown when wanted. **`TO BE DONE`**
107
+
108
+ **file name:** Link to the implementation of the [Actor](actors).
109
+
110
+ #### Example - The Case Start
111
+ ```object
112
+ [log_start](Mon. 03 Oct 2016 22:52:05 GMT : 901.764)
113
+ ```
114
+
115
+ #### Example - The Case End
116
+ ```object
117
+ [log_end](Failure, 0.321ms)
118
+ ```
119
+
120
+ #### Example - The Test Data Log
121
+ ```object
122
+ [log](TestData, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo test data log., Actors-global.demo.log.DemoLogLocal.js)
123
+ ```
124
+
125
+ #### Example - The Engine Log
126
+ ```object
127
+ [log](Engine, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo engine log., Actors-global.demo.log.DemoLogLocal.js)
128
+ ```
129
+
130
+ #### Example - The Debug Log
131
+ ```object
132
+ [log](Debug, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo debug log., Actors-global.demo.log.DemoLogLocal.js)
133
+ ```
134
+
135
+ #### Example - The Error Log
136
+ ```object
137
+ [log](Error, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo error log., Actors-global.demo.log.DemoLogLocal.js)
138
+ ```
139
+
140
+ #### Example - The Warning Log
141
+ ```object
142
+ [log](Warning, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo warninglog., Actors-global.demo.log.DemoLogLocal.js)
143
+ ```
144
+
145
+ #### Example - The IP Log
146
+ ```object
147
+ [log](IP, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo ip log., Actors-global.demo.log.DemoLogLocal.js)
148
+ ```
149
+
150
+ #### Example - The Success Log
151
+ ```object
152
+ [log](Success, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo success log., Actors-global.demo.log.DemoLogLocal.js)
153
+ ```
154
+
155
+ #### Example - The Failure Log
156
+ ```object
157
+ [log](Failure, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo failure log., Actors-global.demo.log.DemoLogLocal.js)
158
+ ```
159
+
160
+ #### Demo
161
+ See the logs in the demo [DemoLog001](/test-cases/Actor/Demo/DemoLog001/execution).
162
+
163
+ #### API
164
+ Use the [Logger API](logger) in Actors API to write logs in your [Actors](actors).
165
+
166
+ #### Buttons
167
+ The the **log buttons** to execute the Test Case is:
168
+ ```object
169
+ [button](glyphicon-play test_case_log, **`Run:`**`Test Case in the Log tab`. Execute the Test Case.)
170
+ [br]
171
+ [button](glyphicon-play test_case_log_slow, **`Run Slow:`**`Test Case in the Log tab`. Execute the Test Case in a **visualized** way by a short delay between the different states of the [Actors](actors). The delay is set as [Test Data](test-datas). The default value is set in the [TestDataEnvironment](/test-data/environment) tables.)
172
+ [br]
173
+ [button](glyphicon-stop test_case_log, **`Stop:`**`Test Case`. Stop executing the Test Case.)
174
+ [br]
175
+ [button](glyphicon-erase test_case_log, **`Clear:`**`Log`. Remove all logs.)
176
+ ```
177
+
178
+ ### The Sequence Diagram Tab<a name="test-case-sequence-diagram" class="markup_bookmark" href="#topOfPage">#</a>
179
+ #### Content
180
+ ***`TO BE DONE`***
181
+
182
+ #### Buttons
183
+ The the **log buttons** to execute the Test Case is:
184
+ ```object
185
+ [button](glyphicon-play test_case_sequence-diagram, **`Run:`**`Test Case in the Sequence Diagram tab`. Execute the Test Case.)
186
+ [br]
187
+ [button](glyphicon-play test_case_sequence-diagram_slow, **`Run Slow:`**`Test Case in the Sequence Diagram tab`. Execute the Test Case in a **visualized** way by a short delay between the different states of the [Actors](actors). The delay is set as [Test Data](test-datas). The default value is set in the [TestDataEnvironment](/test-data/environment) tables.)
188
+ [br]
189
+ [button](glyphicon-stop test_case_sequence-diagram, **`Stop:`**`Test Case`. Stop executing the Test Case.)
190
+ [br]
191
+ [button](glyphicon-erase test_case_sequence-diagram, **`Clear:`**`Sequence Diagram`. Remove all sequence diagrams.)
192
+ ```
193
+
194
+ ### The Specification Tab<a name="test-case-specification" class="markup_bookmark" href="#topOfPage">#</a>
195
+ #### Content
196
+ ***`TO BE DONE`***
197
+
198
+ ### The Analyze Tab<a name="test-case-analyze" class="markup_bookmark" href="#topOfPage">#</a>
199
+ #### Content
200
+ ***`TO BE DONE`***
201
+
202
+
@@ -0,0 +1,75 @@
1
+ # **5. Add your first Addresses**
2
+ See the the video: [[REF=, VIDEOS_FIRST_ADDRESSES]].
3
+
4
+ ## **Purpose**
5
+ Learn the basics of adding [[REF=, ABS_Addressing_Address]]es.
6
+
7
+ #### **5.1 Stage the SUT**
8
+ * Click the [[IE= *Goto: Stage*]] button
9
+ * System Under Test: select ***MyFirstSut***
10
+ * Click the [[IE= *Stage*]] button
11
+
12
+ #### **5.2 In Address tools, select the iNetwork tool**
13
+ * Click the [[IE= *Open: Markup*]] button
14
+ * In the **AddressesNetworkInterfaceLocal** table, enter data as follows:
15
+ * **networkName**: ***MyFirstNetwork***
16
+ * **sut**: ***MyFirstSut***
17
+ * **family**: ***IPv4***
18
+ * Click the [[IE= *Save: Markup*]] button.
19
+
20
+ #### **5.3 In Address tools, select the iClient tool**
21
+ * Click the [[IE= *Open: Markup*]] button
22
+ * In the **AddressesClientInterfaceLocal** table, enter data as follows:
23
+ * **interfaceName**: ***MyFirstClientInterface***
24
+ * **sut**: ***MyFirstSut***
25
+ * **type**: ***ip***
26
+ * **networkName**: ***MyFirstNetwork***
27
+ * Click the [[IE= *Save: Markup*]] button.
28
+
29
+ #### **5.4 In Address tools, select the Src tool**
30
+ * Click the [[IE= *Open: Markup*]] button
31
+ * In the **AddressesSrcLocal** table, enter data as follows:
32
+ * **addressName**: ***MyFirstSrcAddress***
33
+ * **interfaceName**: ***MyFirstClientInterface***
34
+ * **sut**: ***MyFirstSut***
35
+ * Click the [[IE= *Save: Markup*]] button.
36
+
37
+ #### **5.5 In Address tools, select the iServer tool**
38
+ * Click the [[IE= *Open: Markup*]] button
39
+ * In the **AddressesServerInterfaceLocal** table, enter data as follows:
40
+ * **interfaceName**: ***MyFirstServerInterface***
41
+ * **sut**: ***MyFirstSut***
42
+ * **type**: ***ip***
43
+ * **networkName**: ***MyFirstNetwork***
44
+ * Click the [[IE= *Save: Markup*]] button.
45
+
46
+ #### **5.6 In Address tools, select the Srv tool**
47
+ * Click the [[IE= *Open: Markup*]] button
48
+ * In the **AddressesSrvLocal** table, enter data as follows:
49
+ * **addressName**: ***MyFirstSrvAddress***
50
+ * **interfaceName**: ***MyFirstServerInterface***
51
+ * **sut**: ***MyFirstSut***
52
+ * **port**: ***9999***
53
+ * Click the [[IE= *Save: Markup*]] button
54
+
55
+ #### **5.7 Add the Addresses to the Test Case**
56
+ * Open the **Test Cases tool** in another tab and click ***MyFirstSut***, ***MyFirstFut***, and ***MyFirstTestCase***
57
+ * Click the [[IE= *Open: Markup*]] button
58
+ * In the **src** column and **MyFirstActorOrig** row of the **Actor** table, enter ***MyFirstSrcAddress***
59
+ * In the **dst** column and **MyFirstActorOrig** row of the **Actor** table, enter ***MyFirstSrvAddress***
60
+ * In the **srv** column and **MyFirstActorTerm** row of the **Actor** table, enter ***MyFirstSrvAddress***
61
+ Make sure that each [[REF=, ABS_Addressing_Address]] is inserted in its correct row and column in the table.
62
+ * Click the [[IE= *Save: Markup*]] button
63
+
64
+ #### **5.8 Stage the SUT**
65
+ * Click the **ActorJs icon** in the upper left-hand corner of the **ActorJs window**
66
+ * Click the [[IE= *Goto: Stage*]] button
67
+ * **System Under Test**: select ***MyFirstSut***
68
+ * Click the [[IE= *Stage*]] button
69
+
70
+ #### **5.9 Run the Test Case**
71
+ * Go back to the **Test Cases tool** and select ***MyFirstTestCase***
72
+ * Click the [[IE= *Run: in the sequence-diagram tab*]] button
73
+
74
+ <br />
75
+ [[IE=DONE]]
@@ -0,0 +1,18 @@
1
+ # **1. Define your first SUT**
2
+ See the the video: [[REF=, VIDEOS_FIRST_SUT]].
3
+
4
+ ## **Purpose**
5
+ Learn the basics of defining a [[REF=, ABS_System_Under_Test]].
6
+
7
+ #### **1.1 From Core Tools, select the SUTs tool**
8
+
9
+ #### **1.2 Click the [[IE= *Add: System Under Test*]] button**
10
+
11
+ #### **1.3 Enter data in the dialog as follows**
12
+ * **Name**: ***MyFirstSut***
13
+ * **Repo**: select ***actorjs-data-local***
14
+
15
+ #### **1.4 Click the *Add* button in the dialog**
16
+
17
+ <br />
18
+ [[IE=DONE]]
@@ -0,0 +1,35 @@
1
+ # **2. Make your first Actors**
2
+ See the the video: [[REF=, VIDEOS_FIRST_ACTORS]].
3
+
4
+ ## **Purpose**
5
+ Learn the basics of creating [[REF=, ABS_Actor]]s.
6
+
7
+ #### **2.1 From Core tools, select the Actors tool**
8
+
9
+ #### **2.2 Click the Actors-local folder**
10
+ Folders and files you put here will be stored in your local [[REF=, ABS_Repo]], ***actorjs-data-local***.
11
+
12
+ #### **2.3 Click the [[IE= *New: Folder*]] button**
13
+ * **Name**: ***my-first-actors***
14
+ * Click the ***New*** button in the dialog
15
+
16
+ #### **2.4 Click the [[IE= *New: File*]] button**
17
+ * **Name**: ***MyFirstActor***
18
+ * **Type**: select ***Originating***
19
+ * **Stack**: select ***socket***
20
+ * **Template**: select ***hello-world-tcp***
21
+ * Click the ***New*** button in the dialog
22
+
23
+ #### **2.5 Click the my-first-actors folder**
24
+
25
+ #### **2.6 Click the [[IE= *New: File*]] button**
26
+ * **Name**: ***MyFirstActor***
27
+ * **Type**: select ***Terminating***
28
+ * **Stack**: select ***socket***
29
+ * **Template**: select ***hello-world-tcp***
30
+ * Click the ***New*** button in the dialog
31
+
32
+ #### **2.7 Click the [[IE= *Save: Project*]] button**
33
+
34
+ <br />
35
+ [[IE=DONE]]
@@ -0,0 +1,43 @@
1
+ # **3. Make your first Test Case**
2
+ See the the video: [[REF=, VIDEOS_FIRST_TEST_CASE]].
3
+
4
+ ## **Purpose**
5
+ Learn the basics of creating a [[REF=, ABS_Test_Case]].
6
+
7
+ #### **3.1 From Core Tools, select the Test Cases tool**
8
+
9
+ #### **3.2 In the Sut table, click *MyFirstSut***
10
+
11
+ #### **3.3 Click the [[IE= *Add: Function Under Test*]] button**
12
+ * Name: ***MyFirstFut***
13
+ * Click the ***Add*** button in the dialog
14
+
15
+ #### **3.4 In the Fut table, click *MyFirstFut***
16
+
17
+ #### **3.5 Click the [[IE= *Add: Test Case*]] button**
18
+ * **Name**: ***MyFirstTestCase***
19
+ * **Wizard**: select ***none***
20
+ * Click the ***Add*** button in the dialog
21
+
22
+ #### **3.6 In the Tc table, click *MyFirstTestCase***
23
+
24
+ #### **3.7 Add *MyFirstActorOrig* to the Test Case**
25
+ * Click the [[IE= *Open: Markup*]] button
26
+ * In the **type** column of the **Actor** table, enter ***orig***
27
+ * Open the **Actors tool** in another tab and click ***MyFirstActorOrig.js***
28
+ * Click the [[IE= *Copy: Markup name*]] button
29
+ * Go back to the **Test Case tool**, and in the **name** column of the **Actor** table, paste the markup name of the [[REF=, ABS_Actor]]
30
+ * Click the [[IE= *Save: Markup*]] button
31
+
32
+ #### **3.8 Add *MyFirstActorTerm* to the Test Case**
33
+ * Click the [[IE= *Open: Markup*]] button
34
+ * In the **type** column of the **Actor** table, enter ***term***
35
+ * Open the **Actors tool** in another tab and click ***MyFirstActorTerm.js***
36
+ * Click the [[IE= *Copy: Markup name*]] button
37
+ * Go back to the **Test Cases tool**, and in the **name** column of the **Actor** table, paste the markup name of the [[REF=, ABS_Actor]]
38
+ * Click the [[IE= *Save: Markup*]] button
39
+
40
+ #### **3.9 Click the [[IE= *Run: in the sequence-diagram tab*]] button**
41
+
42
+ <br />
43
+ [[IE=DONE]]
@@ -0,0 +1,29 @@
1
+ # **4. Make your first Test Suite**
2
+ See the the video: [[REF=, VIDEOS_FIRST_TEST_SUITE]].
3
+
4
+ ## **Purpose**
5
+ Learn the basics of creating a [[REF=, ABS_Test_Suite]].
6
+
7
+ #### **4.1 From Core tools, select the Test Suites tool**
8
+
9
+ #### **4.2 In the Sut table, click *MyFirstSut***
10
+
11
+ #### **4.3 In the Fut table, click *MyFirstFut***
12
+
13
+ #### **4.4 Click the [[IE= *Add: Test Suite*]] button**
14
+ * **Name**: ***MyFirstTestSuite***
15
+ * Click the ***Add*** button in the dialog
16
+
17
+ #### **4.5 In the Ts table, click *MyFirstTestSuite***
18
+
19
+ #### **4.6 Add *MyFirstTc* to the Test Suite**
20
+ * Click the [[IE= *Open: Markup*]] button
21
+ * Open the **Test Cases tool** in another tab and click ***MyFirstSut***, ***MyFirstFut***, and ***MyFirstTestCase***
22
+ * Click the [[IE= *Copy: Markup name*]] button
23
+ * Go back to the **Test Suites tool**, and in the **name** column of the **TestSuiteAbstraction** table, paste the markup name of the [[REF=, ABS_Test_Case]]
24
+ * Click the [[IE= *Save: Markup*]] button
25
+
26
+ #### **4.7 Click the [[IE= *Run: in the execution tab*]] button**
27
+
28
+ <br />
29
+ [[IE=DONE]]
@@ -0,0 +1,35 @@
1
+ # **6. Share your work**
2
+ See the the video: [[REF=, VIDEOS_SHARE_YOUR_WORK]].
3
+
4
+ ## **Purpose**
5
+ Learn the basics of pushing updates to the actorjs-data-local [[REF=, ABS_Repo]], and how to e-mail the [[REF=, ABS_Test_Case]] to your team members.
6
+
7
+ #### **6.1 View the status of your repos.**
8
+ * Open a new terminal/console and go to the ***actorjs*** [[REF=, ABS_Repo]]. This is where you started **ActorJs**.
9
+ * Do an [[IE=aj status]] to see the status of your repos.
10
+ * Now you can see that you have ***Changes not staged for commit:***
11
+
12
+ #### **6.2 Push the files**
13
+ * Go to the ***actorjs-data-local*** [[REF=, ABS_Repo]]. [[IE=cd Data\actorjs-data-local]].
14
+ * Do [[IE=git add .]] if you want to push all changes, or do **git add** only for the files you want to push.
15
+ * Do [[IE=git commit -m "[your comment]"]].
16
+ * Do [[IE=git push]].
17
+
18
+ #### **6.3 Inform your team members**
19
+ * Open an e-mail client.
20
+ * Open the **Test Cases tool** in another tab and click ***MyFirstSut***, ***MyFirstFut***, and ***MyFirstTestCase***. Copy the url.
21
+ * Write a message to your team members, and then paste the url for your [[REF=, ABS_Test_Case]] in the e-mail.
22
+
23
+ #### **6.4 Act on an e-mail from a team member**
24
+ * Go to the ***actorjs-data-local*** [[REF=, ABS_Repo]]. [[IE=cd Data\actorjs-data-local]].
25
+ * Do [[IE=git pull]]. Stash before doing the pull if you need to do so.
26
+ * Go to the **actorjs** [[REF=, ABS_Repo]]. [[IE=cd ..\\..]].
27
+ * Build **ActorJs**. Do [[IE=aj debug]].
28
+
29
+ #### **6.5 Run the Test Case**
30
+ * Click the link in the [[REF=, _ABS_Test_Case]] in e-mail. This will start a browser for the [[REF=, ABS_Test_Case]] referred to in the e-mail.
31
+
32
+ #### **6.6 Click the [[IE= *Run: in the sequence-diagram tab*]] button**
33
+
34
+ <br />
35
+ [[IE=DONE]]
@@ -0,0 +1,31 @@
1
+ [
2
+ {
3
+ "heading": "Get Started",
4
+ "refs": [
5
+ {
6
+ "name": "1. Define your first SUT",
7
+ "link": "define-your-first-sut"
8
+ },
9
+ {
10
+ "name": "2. Make your first Actors",
11
+ "link": "make-your-first-actors"
12
+ },
13
+ {
14
+ "name": "3. Make your first Test Case",
15
+ "link": "make-your-first-test-case"
16
+ },
17
+ {
18
+ "name": "4. Make your first Test Suite",
19
+ "link": "make-your-first-test-suite"
20
+ },
21
+ {
22
+ "name": "5. Add your first Addresses",
23
+ "link": "add-your-first-addresses"
24
+ },
25
+ {
26
+ "name": "6. Share your work",
27
+ "link": "share-your-work"
28
+ }
29
+ ]
30
+ }
31
+ ]