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

package/Documentation/Navigation-Documentation-actorsite-global.txt

@@ -0,0 +1,363 @@
+[
+  {
+    "heading": "Introduction",
+    "refs": [
+      {
+        "name": "Be 100% more efficient",
+        "link": "Be-100-more-efficient"
+      },
+      {
+        "name": "Trigger, Mock, and Intercept anything",
+        "link": "actorjs-trigger-mock-and-intercept-anything"
+      },
+      {
+        "name": "Advanced Visualization",
+        "link": "advanced-visualization"
+      },
+      {
+        "name": "Debugging",
+        "link": "debugging"
+      },
+      {
+        "name": "The Development Environment",
+        "link": "the-development-environment"
+      },
+      {
+        "name": "The Test Environment",
+        "link": "the-test-environment"
+      },
+	  {
+        "name": "Divide and Reuse",
+        "link": "divide-and-reuse"
+      },
+      {
+        "name": "The Architecture",
+        "link": "the-architecture"
+      },
+      {
+        "name": "Why ActorJs?",
+        "link": "why-actorjs"
+      },
+      {
+        "name": "Think Ahead",
+        "link": "think-ahead"
+      }
+    ]
+  },
+  {
+    "heading": "API:s",
+    "refs": [
+      {
+        "name": "Actor API/Actor",
+        "link": "actor-api/actor"
+      },
+      {
+        "name": "Actor API/ActorPart",
+        "link": "actor-api/actor-part"
+      },
+      {
+        "name": "Actor API/Async",
+        "link": "actor-api/async"
+      },
+      {
+        "name": "Actor API/Client Stack",
+        "link": "actor-api/client-stack"
+      },
+      {
+        "name": "Actor API/Content",
+        "link": "actor-api/content"
+      },
+      {
+        "name": "Actor API/Logger",
+        "link": "actor-api/logger"
+      },
+      {
+        "name": "Actor API/Process",
+        "link": "actor-api/process"
+      },
+      {
+        "name": "Actor API/Server Stack",
+        "link": "actor-api/server-stack"
+      },
+      {
+        "name": "Actor API/Shared Data",
+        "link": "actor-api/shared-data"
+      },
+      {
+        "name": "Actor API/Test Data",
+        "link": "actor-api/test-data"
+      },
+      {
+        "name": "Actor API/Timer",
+        "link": "actor-api/timer"
+      },
+      {
+        "name": "Actor API/Verification Data",
+        "link": "actor-api/verification-data"
+      },
+      {
+        "name": "ConnectionWorker API/Logger",
+        "link": "connection-worker-api/logger"
+      },
+      {
+        "name": "Nodejs API/Fs",
+        "link": "nodejs-api/fs"
+      },
+      {
+        "name": "Stack API/AsciiDictionary",
+        "link": "stack-api/ascii-dictionary"
+      },
+      {
+        "name": "Stack API/BitByte",
+        "link": "stack-api/bit-byte"
+      },
+      {
+        "name": "Stack API/BinaryLog",
+        "link": "stack-api/binary-log"
+      },
+      {
+        "name": "Stack API/ContentBase",
+        "link": "stack-api/content-base"
+      },
+      {
+        "name": "Stack API/IpLog",
+        "link": "stack-api/ip-log"
+      },
+      {
+        "name": "Stack API/LogInner",
+        "link": "stack-api/log-inner"
+      },
+      {
+        "name": "Stack API/LogPartText",
+        "link": "stack-api/log-part-text"
+      },
+      {
+        "name": "Stack API/LogPartError",
+        "link": "stack-api/log-part-error"
+      },
+      {
+        "name": "Stack API/LogPartRef",
+        "link": "stack-api/log-part-ref"
+      }
+    ]
+  },
+  {
+    "heading": "Stacks",
+    "refs": [
+      {
+        "name": "[[stack]]",
+        "link": ""
+      }
+    ]
+  },
+  {
+    "heading": "Abstractions",
+    "refs": [
+      {
+        "name": "Addressing",
+        "link": "abstractions/addressing"
+      },
+      {
+        "name": "Actor",
+        "link": "abstractions/actor/actor"
+      },
+      {
+        "name": "- Actor Originating",
+        "link": "abstractions/actor/actor-originating"
+      },
+      {
+        "name": "- Actor Terminating",
+        "link": "abstractions/actor/actor-terminating"
+      },
+      {
+        "name": "- Actor Proxy",
+        "link": "abstractions/actor/actor-proxy"
+      },
+      {
+        "name": "- Actor Local",
+        "link": "abstractions/actor/actor-local"
+      },
+      {
+        "name": "- Actor Condition",
+        "link": "abstractions/actor/actor-condition"
+      },
+      {
+        "name": "ActorPart",
+        "link": "abstractions/actorpart/actorpart"
+      },
+      {
+        "name": "Content",
+        "link": "abstractions/content"
+      },
+      {
+        "name": "Function Test",
+        "link": "abstractions/functions-test"
+      },
+      {
+        "name": "Function Under Test",
+        "link": "abstractions/functions-unde-test"
+      },
+      {
+        "name": "Load",
+        "link": "abstractions/load-test"
+      },
+      {
+        "name": "Repo",
+        "link": "abstractions/repo"
+      },
+      {
+        "name": "Shared Data",
+        "link": "abstractions/shared-data"
+      },
+      {
+        "name": "Stack",
+        "link": "abstractions/stack/stack"
+      },
+      {
+        "name": "- Stack Connection",
+        "link": "abstractions/stack/connection"
+      },
+	  {
+        "name": "- Stack Server Connection",
+        "link": "abstractions/stack/server-connection"
+      },
+      {
+        "name": "- Stack Client Connection",
+        "link": "abstractions/stack/client-connection"
+      },
+      {
+        "name": "- Stack Encoder",
+        "link": "abstractions/stack/encoder"
+      },
+      {
+        "name": "- Stack Decoder",
+        "link": "abstractions/stack/decoder"
+      },
+      {
+        "name": "- Stack Message",
+        "link": "abstractions/stack/message"
+      },
+      {
+        "name": "- Stack Worker",
+        "link": "abstractions/stack/worker"
+      },
+      {
+        "name": "System Configuration Floor",
+        "link": "abstractions/configuration-floor"
+      },
+      {
+        "name": "System To Test",
+        "link": "abstractions/system-to-test"
+      },
+      {
+        "name": "System Under Test",
+        "link": "abstractions/system-under-test"
+      },
+      {
+        "name": "Test Case",
+        "link": "abstractions/test-case/test-case"
+      },
+      {
+        "name": "Test Data",
+        "link": "abstractions/test-data"
+      },
+      {
+        "name": "Test Suite",
+        "link": "abstractions/test-suite"
+      },
+      {
+        "name": "Verification Data",
+        "link": "abstractions/verification-data"
+      }
+    ]
+  },
+  {
+    "heading": "Markup",
+    "refs": [
+      {
+        "name": "Introduction",
+        "link": "markup-markup"
+      },
+      {
+        "name": "Simple/Api-Status",
+        "link": "markup-api-status"
+      },
+      {
+        "name": "Simple/Anchor",
+        "link": "markup-anchor"
+      },
+      {
+        "name": "Simple/Documentation-Status",
+        "link": "markup-documentation-status"
+      },
+      {
+        "name": "Simple/Embed",
+        "link": "markup-embed"
+      },
+      {
+        "name": "Simple/I.e.",
+        "link": "markup-ie"
+      },
+      {
+        "name": "Simple/Note",
+        "link": "markup-note"
+      },
+      {
+        "name": "Simple/Reference",
+        "link": "markup-ref"
+      },
+      {
+        "name": "Complex/Chart/Line",
+        "link": "markup-chart-line"
+      },
+      {
+        "name": "Complex/Document",
+        "link": "markup-documentation"
+      },
+      {
+        "name": "Complex/Flowchart",
+        "link": "markup-flowchart"
+      },
+      {
+        "name": "Complex/Objects",
+        "link": "markup-html"
+      },
+      {
+        "name": "Complex/Image",
+        "link": "markup-image"
+      },
+      {
+        "name": "Complex/Lab",
+        "link": "markup-lab"
+      },
+      {
+        "name": "Complex/Navigation",
+        "link": "markup-navigation"
+      },
+      {
+        "name": "Complex/Node Diagram",
+        "link": "markup-node-diagram"
+      },
+      {
+        "name": "Complex/Sequence Diagram",
+        "link": "markup-sequence-diagram"
+      },
+      {
+        "name": "Complex/State Machine",
+        "link": "markup-state-machine"
+      },
+      {
+        "name": "Complex/Table",
+        "link": "markup-table"
+      },
+      {
+        "name": "Complex/Test Case",
+        "link": "markup/markup-test-case"
+      },
+      {
+        "name": "Complex/Test Suite",
+        "link": "markup/markup-test-suite"
+      }
+    ]
+  }
+]

package/Documentation/abstractions/Document-global-addressing.txt

@@ -0,0 +1,81 @@
+# **Addressing Abstraction**
+
+## **Description**
+
+In most cases, we do not handle IP addresses directly. Instead, we define Networks, Interfaces, AddressInterfaces, Addresses and Ports. ActorJs automatically selects the IP addresses to use depending on the existing IP addresses available on your computer and how the computer is configured. To achieve this, [[REF=, ABS_Actor]]s use names of Networks and Interfaces instead of hard-coded IP addresses. 
+
+You will need to Stage your [[REF=, ABS_System_Under_Test]]. When Staging*,* ActorJs will use available Interfaces and IP addresses along with your configuration to resolve all addresses needed by the [[REF=, ABS_Actor]]s. If ActorJs runs out of addresses or networks, it will reuse existing ones. You will then have a reduced system, but the [[REF=, ABS_Test_Case]]s will still work as long as you do not have Port conflicts. This means that a developer can use just one IP address when developing.
+
+### **Addressing abstractions**
+* **Network**: A unique name representing an address space for communication between entities on the same network.
+* **Interface**: Name used by ActorJs to retrieve an IP address. Each Interface points to a Network.
+* **Port**: Port number to be used.
+* **AddressInterface**: Hard-coded IP address.
+* **Address**: Used by [[REF=, ABS_Actor]]s. A combination of an Interface and a Port or an AddressInterface and a port.
+<BR/>
+#### **Addressing abstractions dependencies**
+```node
+Config(nodeWidth: 90, nodeHeight: 20, nodeWidthBetween: 25, nodeHeightBetween: 15, widthBias: 30, heightBias: 30, border: true, backgroundColor: default)
+
+Nodes[, Address]
+Nodes[Port, , AddressInterface, Interface]
+Nodes[, , , Network]
+Nodes[, Sut]
+
+
+Address => Port[, , top]: 
+Address => Interface[, , top]: 
+Address => AddressInterface[, , top]: 
+Address => Sut[]: 
+AddressInterface => Sut[, bottom]: 
+Interface => Sut[, bottom]: 
+Interface => Network[]: 
+Network => Sut[, bottom]: 
+```
+
+#### **Transport Layer**
+The Transport Layer is separated from the Protocol Layer. It means that you can use any of the Transport Layers to any of the Protocols in ActorJs, even if the Protocol of selves does not support it. The implemented transports are:
+* **udp**: User Datagram Protocol
+* **tcp**: Transmission Control Protocol
+* **tls**: Transport Layer Security
+* **mc**: Multicast over UDP
+
+#### **Addresses**
+There are three types of Addresses:
+* **src**: [[REF=, TOOL_Addressing_Src]].
+* **dst**: [[REF=, TOOL_Addressing_Dst]].
+* **srv**: [[REF=, TOOL_Addressing_Srv]].
+
+**Transport:** udp**, tcp & tls.
+
+**Transport:** mc.
+
+```node
+Config(nodeWidth: 70, nodeHeight: 70, nodeWidthBetween: 25, nodeHeightBetween: 25, widthBias: 30, heightBias: 30, border: true, backgroundColor: default)
+
+Nodes[Client, , Server]
+
+
+Client => Server[http]: Get /img.png
+<g>
+  <line x1="120" y1="30" x2="100" y2="65"stroke="black" />
+  <text x="110" y="26" font-weight="bold">src</text>
+  <line x1="200" y1="30" x2="220" y2="65"stroke="black" />
+  <text x="180" y="26" font-weight="bold">dst</text>
+  <line x1="200" y1="100" x2="220" y2="65"stroke="black" />
+  <text x="180" y="110" font-weight="bold">srv</text>
+<g/>
+```
+
+An address has a reference to one interface and one port. This reference is defined in the [[REF=, TOOL_Addressing]].
+
+## **Define Addresses for your System Under Test**
+The scenography of your Test Environment is divided into three parts:
+1) Actor Clients
+2) System Under Test (SUT)
+3) Actor Servers
+
+```lab
+Network(N1, IPv4, 172.16.0.0/23, Actor IPv4 network 1, true, false)
+
+```

package/Documentation/abstractions/Document-global-configuration-floor.txt

@@ -0,0 +1,2 @@
+# **System Configuration Floor Abstraction**
+## **Description**

package/Documentation/abstractions/Document-global-content.txt

@@ -0,0 +1,3 @@
+# **Content Abstraction**
+
+## **Description**

package/Documentation/abstractions/Document-global-functions-test.txt

@@ -0,0 +1,4 @@
+# **Function Test Abstraction**
+## **Description**
+A [[REF=, ABS_Function_Test]] is a [[REF=, ABS_Test_Case]] testing a function of the [[REF=, ABS_System_Under_Test]].
+

package/Documentation/abstractions/Document-global-functions-unde-test.txt

@@ -0,0 +1,2 @@
+# **Function Under Test Abstraction**
+## **Description**

package/Documentation/abstractions/Document-global-load-test.txt

@@ -0,0 +1,3 @@
+# **Load Abstraction**
+
+## **Description**

package/Documentation/abstractions/Document-global-repo.txt

@@ -0,0 +1,79 @@
+# **Repo Abstraction**
+## **Description**
+ActorJs uses git repos to store code, data, content and more. Use the [[IE=aj status]] command to display all repos and their git status. The command will do a git fetch and then a git status to be able to show as much information as possible.
+
+### **aj status - with added repos**
+![](/abs-images/images/aj-status-repo-added.png)
+
+
+### **aj status - without any repos**
+![](/abs-images/images/aj-status-no-repo.png)
+
+## **Repo types**
+ActorJs users can use three types of repos: 
+* **[[REF=, ABS_Repo_ActorJs_Content]]s**
+* **[[REF=, ABS_Repo_ActorJs_Data]]s**
+* **[[REF=, ABS_Repo_Documentation]]s**
+
+## **Repo ownership**
+There are three types of repo ownership: Global Repo, Local Repo, or Personal Repo.
+* **Global Repos**: Owned by ActorJs; only users at ActorJs can push updates.
+* **Local Repos**: Owned by the customer, only users specified by the customer can push updates. All [[REF=, ABS_Repo]]s must be created in folders predefined by ActorJs, see below. You can use the ActorJs wizard to create [[REF=, ABS_Repo]]s or you can create them manually. If you use the wizard, you must use the default branch, and this branch must be called ***main***. If you do not create the [[REF=, ABS_Repo]]s, the folders will still be created and you can work with them instead, but if you want to store your work and share it, you need to connect to a [[REF=, ABS_Repo]]. There are two mandatory repos:
+  * **actorjs-content-local:** A binary [[REF=, ABS_Repo]] to store [[REF=, ABS_Content]] used by [[REF=, ABS_Actor]]s in [[REF=, ABS_Test_Case]]s.
+  * **actorjs-data-local:** See [[REF=, ABS_Repo_ActorJs_Data]]s.
+* **Personal Repos**: the Personal Repos are not real repos; they are virtual repos inside a Local Repo. However, a Personal Repo's data is associated exclusively with the logged-in user, and only this user can change the data. `Not implemented yet.`
+
+## **Repo file location**
+All repos have a specific folder location. This can be helpful in trouble shooting, for example, or if you want to find and edit specific files outside ActorJs.
+
+![](/abs-images/images/actorjs-folder-repos.png)
+
+[[ANCHOR={"id":"actorjs-data-repo","visible":true}]]
+### **Data repos**
+ActorJs generates data as json objects, markup, or JavaScript code. This means that the data is easy to merge. A Data repo ia a text [[REF=, ABS_Repo]] for storing Repo configurations, [[REF=, ABS_System_Under_Test]] configurations, [[REF=, ABS_Test_Suite]]s, [[REF=, ABS_Test_Case]]s, [[REF=, ABS_Stack]]s, [[REF=, ABS_Actor]]s, [[REF=, ABS_Test_Data]], and [[REF=, ABS_Content]] configurations. 
+* **actorjs-data-local** is mandatory. If the user does not create this repo,  ActorJs will automatically create the corresponding folder.
+*  **other repos** can be created, but for now they are limited to the following content: [[REF=, ABS_System_Under_Test]] configurations, [[REF=, ABS_Test_Suite]]s, [[REF=, ABS_Test_Case]]s.
+[[ANCHOR={"id":"global-data-repo","visible":true}]]
+
+[[ANCHOR={"id":"actorjs-content-repo","visible":true}]]
+### **Content repos**
+Contains [[REF=, ABS_Content]] used by [[REF=, ABS_Test_Case]]s.
+
+
+[[ANCHOR={"id":"actorjs-documentation-repo","visible":true}]]
+### **Documentation repos**
+Future plus services may use repos for documentation. Stay tuned!
+
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>

package/Documentation/abstractions/Document-global-shared-data.txt

@@ -0,0 +1,5 @@
+# **Shared Data Abstraction**
+## **Description**
+[[REF=, ABS_Actor]]s can shared data with each other with the [[REF=, ABS_Shared_Data]] abstraction. One [[REF=, ABS_Actor]] can publish data and other [[REF=, ABS_Actor]]s can use it. They can also wait for the data both asynchronously or synchronization.
+
+See how to use it in the [[REF=, API_Actor_Shared_Data]].

package/Documentation/abstractions/Document-global-system-to-test.txt

@@ -0,0 +1,2 @@
+# **System To Test Abstraction**
+## **Description**

package/Documentation/abstractions/Document-global-system-under-test.txt

@@ -0,0 +1,3 @@
+# **System Under Test Abstraction**
+
+## **Description**