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

package/Workshop/Document-global-mock-with-icap.txt

@@ -0,0 +1,94 @@
+# **4) Mock with ICAP**
+
+---
+## ***Use the Image AI Service***
+
+---
+#### **Purpose**
+Learn how to ***mock*** the [[REF=, STACK_ICAP]] stack. ***Mock*** with a [[REF=, ABS_Terminating_Actor]].
+Learn how to use multiple ***mocks***.
+Learn how to use ***[[REF=, ABS_Test_Data]]*** with the [[REF=, API_Actor_Test_Data]].
+
+---
+#### **Task**
+1) Mock ***ImageService*** and reply with ***Kate***.
+1) Mock ***AIService*** and reply with requested transformation.
+2) Load the ***ActorDemo*** site and click the **"Goto:** Image AI**"** button.
+3) Click the ***"mask"*** button and verify that the image has changed.
+
+---
+#### **Analyze**
+```node
+Config(nodeWidth: 70, nodeHeight: 35, nodeWidthBetween: 45, nodeHeightBetween: 25, widthBias: 30, heightBias: 30, border: true, backgroundColor: default)
+
+Nodes[Browser(; ; White), ActorDemo(; ; Honeydew), UserService(; ; White)]
+Nodes[, , AIService(; ; White)]
+
+
+Browser => ActorDemo[http]: http
+ActorDemo => UserService[http]: http
+ActorDemo => AIService[icap]: icap
+```
+
+The ***Image AI*** page uses the backend nodes ***ImageService*** and ***AIService***.
+* [[REF=, STACK_HTTP]] is the protocol between the ***Browser*** and ***ActorDemo*** so we will use the [[REF=, STACK_PUPPETEER]] stack to test this page.
+* [[REF=, STACK_HTTP]] is the protocol between the ***ActorDemo*** and ***ImageService*** so we will use the [[REF=, STACK_HTTP]] stack to ***mock*** the ***ImageService***, described in [2) Mock with HTTP
+](/workshop/mock-with-http)
+* [[REF=, STACK_ICAP]] is the protocol between the ***ActorDemo*** and ***AIService*** so we will use the [[REF=, STACK_ICAP]] stack to ***mock*** the ***AIService***
+
+  * The ***AIService*** has one **REST API** method.
+    1) **AiGetImages**:
+      1.1) **protocol**: IACP
+      1.2) **Method**: RESPMOD
+      1.3) **url**: api/v1/image/ais/[**name**]/[**transformations**]
+            1.3.1) **name**: *The name of the AI instance*
+            1.3.2) **transformations**: *A comma-separated list with the names of the AI transformations*
+      1.4) **body**: *The original [[REF=, STACK_HTTP]] request and its response*
+      1.4) **returns**: *An [[REF=, STACK_HTTP]] response with the modified Image*
+
+```seq
+Config(nodeWidth: 280, nodeMessageHeight: 17, nodeEventHeight: 10, nodeCommentHeight: 26, widthBias: 60, heightBias: 30, lineNumbers: false, border: true, backgroundColor: #EAFEEA)
+
+Nodes[Browser, ActorDemo, ImageService, AIService]
+ActorDemo -o ImageService[http]: 
+ActorDemo -o AIService[icap]: 
+Browser browser [puppeteer]: srcActorDemo
+Browser page [puppeteer]: page1
+Browser -o ActorDemo[http]: 
+Browser => ActorDemo[http]: GET http://localhost:9045/start
+ActorDemo => Browser[http]: 200 OK
+Browser /**/ ActorDemo[http]: Loading site (js, css, images, REST API, ... .)
+Browser click [puppeteer]: id = #from_start_to_image_ai
+Browser => ActorDemo[http]: POST http://actordemo:9045/abs-data/AiGetImages
+ActorDemo => ImageService[http]: GET api/v1/image/get-images
+ImageService => ActorDemo[http]: 200 OK
+ActorDemo => Browser[http]: 200 OK
+Browser => ActorDemo[http]: POST http://actordemo:9045/abs-data/AiGetImage
+ActorDemo => ImageService[http]: GET api/v1/image/get-image/Kate
+ImageService => ActorDemo[http]: 200 OK
+ActorDemo => Browser[http]: 200 OK
+Browser click [puppeteer]: id = #button_Kate_mask
+Browser => ActorDemo[http]: POST http://actordemo:9045/abs-data/AiGetImage
+ActorDemo => ImageService[http]: GET api/v1/image/get-image/Kate
+ImageService => ActorDemo[http]: 200 OK
+ActorDemo => AIService[icap]: RESPMOD api/v1/image/ais/Kate/mask
+AIService => ActorDemo[icap]: 200 OK
+ActorDemo => Browser[http]: 200 OK
+AIService -x ActorDemo[icap]: 
+ImageService -x ActorDemo[http]: 
+Browser  -x ActorDemo[http]: 
+```
+
+---
+#### **Conclusion**
+1) Create an [[REF=, ABS_Originating_Actor]] with the [[REF=, STACK_PUPPETEER]] stack.
+  1.1 **Click** the button with ***selector***: #from_start_to_image_ai
+2) Create a [[REF=, ABS_Terminating_Actor]] with the [[REF=, STACK_HTTP]] stack.
+  2.1 Answer the [[REF=, STACK_HTTP]] REST API ***request*** AiGetImages. Answer with [{name:'Kate',mime:'images/jpeg',ais:['Rio', 'feathers', 'mask']}].
+  2.2 Answer the [[REF=, STACK_HTTP]] REST API ***request*** AiGetImage/Kate ***two times***. Answer with the image requested.
+3) Create a [[REF=, ABS_Terminating_Actor]] with the [[REF=, STACK_ICAP]] stack.
+  3.1 Answer the [[REF=, STACK_ICAP]] REST API ***request*** image/ais/Kate/mask. Answer with the transformed image.
+
+---
+#### **Solution**
++ Test Case: [UseImageAI](/../test-cases/ActorDemo/ImageIA/UseImageAI)

package/Workshop/Document-global-prerequisites-actorJs.txt

@@ -0,0 +1,18 @@
+# **Prerequisites - ActorJs**
+
+### **Create folders**
+
+To install ActorJs, we start by creating the folders we need:
+
+1) **Run** the ***Node.js command prompt*** in Windows and use a ***terminal*** in Linux and Mac. 
+`Do not use other environments for the workshop since they are not verified to work.`
+
+2) Choose a location and **create** a folder where your ActorJs files will be stored. A good name would be ***"ActorJs"***.
+
+3) **Create** a sub-folder named ***"workshop"*** in the ***"ActorJs"*** folder.
+
+4) **Create** a sub-folder named ***"actorjs"*** in the ***"workshop"*** folder.
+***
+
+### **Download ActorJs**
+See the instructions at [[REF=, NPM_ACTORJS]] and install ActorJs in the ***"actorjs"*** folder.

package/Workshop/Document-global-prerequisites-actordemo.txt

@@ -0,0 +1,15 @@
+# **Prerequisites - ActorDemo**
+
+### **Create folders**
+
+To install ActorDemo, we start by creating the folders we need:
+1) **Run** the ***Node.js command prompt*** in Windows and use a ***terminal*** in Linux and Mac. 
+`Do not use other environments for the workshop since they are not verified to work.`
+
+
+4) **Create** a sub-folder named ***"actordemo"*** in the newly created ***"workshop"*** folder.
+
+***
+
+### **Download ActorDemo**
+See the instructions at [[REF=, NPM_ACTORDEMO]] and install ActorDemo in the ***"actordemo"*** folder.

package/Workshop/Document-global-trigger-with-http.txt

@@ -0,0 +1,93 @@
+# **4) Trigger with HTTP**
+
+---
+## ***Change the configuration of ActorDemo with its REST API***
+
+---
+#### **Purpose**
+Learn how to ***trigger*** and test ***REST API*** with the [[REF=, STACK_HTTP]] stack. ***Trigger*** with a [[REF=, ABS_Condition_Actor]].
+Learn how to use different ***Test Case phases***.
+Learn how to use ***[[REF=, ABS_Verification_Data]]*** to verify with the [[REF=, API_Actor_Verification_Data]].
+
+---
+#### **Task**
+1) In the ***precondition phase*** change the configuration ***authorization*** to ***true*** with ***ActorDemos*** REST API.
+2) Load the ***ActorDemo*** site and verify that the **"Goto:** Login**"** button is enabled and **"Goto:** Image AI**"** button is disabled.
+3) In the ***postcondition phase*** change the configuration ***authorization*** to ***false*** with ***ActorDemos*** REST API.
+
+---
+#### **Analyze**
+```node
+Config(nodeWidth: 70, nodeHeight: 35, nodeWidthBetween: 45, nodeHeightBetween: 0, widthBias: 30, heightBias: 30, border: true, backgroundColor: default)
+
+Nodes[Browser(; ; White)]
+Nodes[, ActorDemo(; ; Honeydew)]
+Nodes[Admin(; ; White)]
+
+
+Browser => ActorDemo[http]: http
+Admin => ActorDemo[http]: http
+```
+
+The ***start*** page does not use any backend nodes.
+* [[REF=, STACK_HTTP]] is the protocol between the ***Browser*** and ***ActorDemo*** so we will use the [[REF=, STACK_PUPPETEER]] stack to test this page.
+* [[REF=, STACK_HTTP]] is the protocol between ***Admin*** and ***ActorDemo*** so we will use the [[REF=, STACK_HTTP]] stack to update the config of ***ActorDemo***.
+  * The ***ActorDemo*** has one **REST API** method.
+    1) **Config**:
+      1.1) **protocol**: HTTP
+      1.2) **Method**: PATCH
+      1.3) **url**: abs-api/config/[**name**]
+            1.3.1) **name**: *The name of the Configuration*
+      1.4) **body**: *The new config value*
+      1.4) **returns**: 204 No Content
+
+```seq
+Title:                           Precondition Phase
+Config(nodeWidth: 320, nodeMessageHeight: 17, nodeEventHeight: 10, nodeCommentHeight: 12, widthBias: 50, heightBias: 30, lineNumbers: false, border: true, backgroundColor: #E7F5FB)
+
+Nodes[Admin, ActorDemo]
+Admin -o ActorDemo[http]: 
+Admin => ActorDemo[http]: PATCH http://actordemo:9045/abs-api/config
+ActorDemo => Admin[http]: 204 No Content
+Admin -x ActorDemo[http]: 
+```
+
+```seq
+Title:                           Execution Phase
+Config(nodeWidth: 320, nodeMessageHeight: 17, nodeEventHeight: 10, nodeCommentHeight: 26, widthBias: 50, heightBias: 30, lineNumbers: false, border: true, backgroundColor: #EAFEEA)
+
+Nodes[Browser, ActorDemo]
+Browser browser [puppeteer]: srcActorDemo
+Browser page [puppeteer]: page1
+Browser -o ActorDemo[http]: 
+Browser => ActorDemo[http]: GET http://localhost:9045/start
+ActorDemo => Browser[http]: 200 OK
+Browser /**/ ActorDemo[http]: Loading site (js, css, images, REST API, ... .)
+Browser == [puppeteer]: button #from_start_to_login is enabled
+Browser == [puppeteer]: button #from_start_to_image_ai is enabled
+Browser -x ActorDemo[http]: 
+```
+
+```seq
+Title:                           Postcondition Phase
+Config(nodeWidth: 320, nodeMessageHeight: 17, nodeEventHeight: 10, nodeCommentHeight: 12, widthBias: 50, heightBias: 30, lineNumbers: false, border: true, backgroundColor: #FFFFE6)
+
+Nodes[Admin, ActorDemo]
+Admin -o ActorDemo[http]: 
+Admin => ActorDemo[http]: PATCH http://actordemo:9045/abs-api/config
+ActorDemo => Admin[http]: 204 No Content
+Admin -x ActorDemo[http]: 
+```
+
+---
+#### **Conclusion**
+1) Create an [[REF=, ABS_Condition_Actor]] with the [[REF=, STACK_HTTP]] stack.
+  1.1 In precondition set the ***authorization*** config to ***true***.
+  1.2 In postcondition reset the ***authorization*** config to ***false***.
+2) Create an [[REF=, ABS_Originating_Actor]] with the [[REF=, STACK_PUPPETEER]] stack.
+  1.1 Verify that the button with ***selector***: #from_start_to_login is ***enabled***.
+  1.1 Verify that the button with ***selector***: #from_start_to_image_ai is ***disabled***.
+
+---
+#### **Solution**
++ Test Case: [StartAuthorizationOn](/../test-cases/ActorDemo/Start/StartAuthorizationOn)

package/Workshop/Document-global-trigger-with-puppeter.txt

@@ -0,0 +1,49 @@
+# **1) Trigger with Puppeteer**
+
+---
+## ***Goto the start page***
+
+---
+#### **Purpose**
+Learn how to ***trigger*** and ***GUI test*** with the [[REF=, STACK_PUPPETEER]] stack. ***Trigger*** with an [[REF=, ABS_Originating_Actor]].
+
+---
+#### **Task**
+1) Load the ***ActorDemo*** site and click the ***"hat"*** button and verify that the image has changed.
+
+---
+#### **Analyze**
+
+```node
+Config(nodeWidth: 80, nodeHeight: 50, nodeWidthBetween: 75, nodeHeightBetween: 25, widthBias: 30, heightBias: 30, border: true, backgroundColor: default)
+
+Nodes[Browser(; ; White), ActorDemo(; ; Honeydew)]
+
+
+Browser => ActorDemo[http]: http
+```
+The ***start*** page does not use any backend nodes. 
+* [[REF=, STACK_HTTP]] is the protocol between the ***Browser*** and ***ActorDemo*** so we will use the [[REF=, STACK_PUPPETEER]] stack to test this page.
+
+```seq
+Config(nodeWidth: 260, nodeMessageHeight: 17, nodeEventHeight: 10, nodeCommentHeight: 26, widthBias: 60, heightBias: 30, lineNumbers: false, border: true, backgroundColor: #EAFEEA)
+
+Nodes[Browser, ActorDemo]
+Browser browser [puppeteer]: srcActorDemo
+Browser page [puppeteer]: page1
+Browser -o ActorDemo[http]: 
+Browser => ActorDemo[http]: GET http://localhost:9045/start
+ActorDemo => Browser[http]: 200 OK
+Browser /**/ ActorDemo[http]: Loading site (js, css, images, REST API, ... .)
+Browser click [puppeteer]: id = #button_bob_hat
+Browser -x ActorDemo[http]: 
+```
+
+---
+#### **Conclusion**
+1) Create an [[REF=, ABS_Originating_Actor]] with the [[REF=, STACK_PUPPETEER]] stack.
+  1.1) **Click** the button with ***selector***: #button_bob_hat
+
+---
+#### **Solution**
++ Test Case: [StartChangeImage](/../test-cases/ActorDemo/Start/StartChangeImage)

package/Workshop/Navigation-Workshop-actorjs-global.txt

@@ -0,0 +1,86 @@
+[
+  {
+    "heading": "Introduction",
+    "refs": [
+      {
+        "name": "ActorJs",
+        "link": "introduction-actorjs"
+      },
+      {
+        "name": "Actor",
+        "link": "introduction-actor"
+      },
+      {
+        "name": "Stack",
+        "link": "introduction-stack"
+      },
+      {
+        "name": "System Under Test",
+        "link": "introduction-system-under-test"
+      },
+      {
+        "name": "Test Case",
+        "link": "introduction-test-case"
+      },
+      {
+        "name": "Test Suite",
+        "link": "introduction-test-suite"
+      }
+    ]
+  },
+  {
+    "heading": "Prerequisites",
+    "refs": [
+      {
+        "name": "ActorJs",
+        "link": "prerequisites-actorJs"
+      },
+      {
+        "name": "ActorDemo",
+        "link": "prerequisites-actordemo"
+      }
+    ]
+  },
+  {
+    "heading": "ActorDemo",
+    "refs": [
+      {
+        "name": "ActorDemo site",
+        "link": "actordemo-site"
+      },
+      {
+        "name": "The Architecture",
+        "link": "actordemo-the-architecture"
+      },
+      {
+        "name": "- Start page",
+        "link": "actordemo-start"
+      },
+      {
+        "name": "- Image AI page",
+        "link": "actordemo-image-ai"
+      }
+    ]
+  },
+  {
+    "heading": "Tasks",
+    "refs": [
+      {
+        "name": "1) Trigger with Puppeteer",
+        "link": "trigger-with-puppeter"
+      },
+      {
+        "name": "2) Mock with HTTP",
+        "link": "mock-with-http"
+      },
+      {
+        "name": "3) Mock with ICAP",
+        "link": "mock-with-icap"
+      },
+      {
+        "name": "4) Trigger with HTTP",
+        "link": "trigger-with-http"
+      }
+    ]
+  }
+]

package/npm-shrinkwrap.json

@@ -0,0 +1,13 @@
+{
+  "name": "@aj-shadow/actorjs-documentation-text",
+  "version": "0.0.0-aj-beta.221",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "@aj-shadow/actorjs-documentation-text",
+      "version": "0.0.0-aj-beta.221",
+      "license": "SEE LICENSE IN LICENSE.txt"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@aj-shadow/actorjs-documentation-text",
+  "version": "0.0.0-aj-beta.221",
+  "release-step": "delivery",
+  "description": "Library used by @actorjs/actorjs",
+  "author": "ActorJs",
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "repository": "https://gitlab.com/actorjs-shadow-delivery-public/actorjs-documentation-text.git",
+  "dependencies": {}
+}