create example with suite name

.github/workflows/test-e2e.yml

@@ -18,7 +18,7 @@ jobs:
           step_name: 'init and run'
           client_scan_token: ${{ secrets.CLIENT_SCAN_TOKEN_DEMO }}
           cli_version: 'latest'
-          traffic_env: 'crapi-demo1'
+          traffic_env: 'staging'
           include_url_regex: '13.58.254.175'
           traceable_server: ${{ secrets.TRACEABLE_SERVER_DEMO }}
       - name: Stop Scan
@@ -27,7 +27,7 @@ jobs:
         with:
           step_name: 'stop'
           client_scan_token: ${{ secrets.CLIENT_SCAN_TOKEN_DEMO }}
-          traffic_env: 'crapi-demo1'
+          traffic_env: 'staging'
           traceable_server: ${{ secrets.TRACEABLE_SERVER_DEMO }}
   functionalTest:
     runs-on: ubuntu-20.04

.github/workflows/test-traceable-ast-init-and-run-with-suite.yml

@@ -0,0 +1,38 @@
+name: Test Traceable AST Init And Run Action With AST Scan Suite
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  InitAndRunAstScan:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Init and run scan action
+        uses: Traceableai/ast-action@main
+        with:
+          step_name: 'init and run'
+          client_scan_token: ${{ secrets.CLIENT_SCAN_TOKEN_DEMO }}
+          cli_version: '1.10.2-rc.23'
+          scan_suite: 'github-actions-repo-suite'
+          traceable_server: ${{ secrets.TRACEABLE_SERVER_DEMO }}
+      - name: Stop Scan
+        if: always()
+        uses: Traceableai/ast-action@main
+        with:
+          step_name: 'stop'
+          client_scan_token: ${{ secrets.CLIENT_SCAN_TOKEN_DEMO }}
+          traceable_server: ${{ secrets.TRACEABLE_SERVER_DEMO }}
+  functionalTest:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Run a loop as functional test
+        run: |
+          for ((i=1;i<=100;i++)); 
+          do 
+             echo $i
+          done

.github/workflows/test-traceable-ast-init-and-run.yml

@@ -17,16 +17,16 @@ jobs:
         with:
           step_name: 'init and run'
           client_scan_token: ${{ secrets.CLIENT_SCAN_TOKEN_DEMO }}
-          cli_version: 'latest'
-          traffic_env: 'crapi-demo1'
+          cli_version: '1.10.2-rc.23'
+          traffic_env: 'staging'
           traceable_server: ${{ secrets.TRACEABLE_SERVER_DEMO }}
       - name: Stop Scan
         if: always()
         uses: Traceableai/ast-action@main
         with:
           step_name: 'stop'
           client_scan_token: ${{ secrets.CLIENT_SCAN_TOKEN_DEMO }}
-          traffic_env: 'crapi-demo1'
+          traffic_env: 'staging'
           traceable_server: ${{ secrets.TRACEABLE_SERVER_DEMO }}
   functionalTest:
     runs-on: ubuntu-20.04

.github/workflows/test-traceable-ast-init-traceable-ast-run.yml

@@ -16,7 +16,8 @@ jobs:
         with:
           step_name: 'init'
           client_scan_token: ${{ secrets.CLIENT_SCAN_TOKEN }}
-          traffic_env: 'samarth-crapi'
+          traffic_env: 'staging'
+          cli_version: '1.10.2-rc.23'
           traceable_server: ${{ secrets.TRACEABLE_SERVER }}
           traceable_cli_download_path: https://downloads.traceable.ai/cli/rc/latest/traceable-cli-latest-linux-x86_64.tar.gz
       - name: Run a loop as functional test
@@ -28,15 +29,16 @@ jobs:
       - name: Run scan action
         uses: Traceableai/ast-action@main
         with:
+          log_level: 'debug'
           step_name: 'run'
           client_scan_token: ${{ secrets.CLIENT_SCAN_TOKEN }}
-          traffic_env: 'samarth-crapi'
-          cli_version: 'latest'
+          traffic_env: 'staging'
+          cli_version: '1.10.2-rc.23'
       - name: Abort Scan
         uses: Traceableai/ast-action@main
         if: always()
         with:
           step_name: 'stop'
           client_scan_token: ${{ secrets.CLIENT_SCAN_TOKEN_DEMO }}
-          traffic_env: 'crapi-demo1'
+          traffic_env: 'staging'
           traceable_server: ${{ secrets.TRACEABLE_SERVER_DEMO }}

README.md

@@ -125,8 +125,49 @@ jobs:
           done
 
 ```
-2. As you can see in the above workflow, we have initiated the scan with initiate scan action step which takes client_scan_token, traffic_env, and traceable_server as input. 
-3. In the next step we are executing functional tests and then running the scan in the step after that which take client_scan_token,traffic_env, and cli_version as input. 
+```
+name: Test Traceable AST Init And Run Action With AST Scan Suite
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  InitAndRunAstScan:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Init and run scan action
+        uses: Traceableai/ast-action@main
+        with:
+          step_name: 'init and run'
+          client_scan_token: ${{ secrets.CLIENT_SCAN_TOKEN_DEMO }}
+          cli_version: 'latest'
+          scan_suite: 'github-actions-test-suite'
+          traceable_server: ${{ secrets.TRACEABLE_SERVER_DEMO }}
+      - name: Stop Scan
+        if: always()
+        uses: Traceableai/ast-action@main
+        with:
+          step_name: 'stop'
+          client_scan_token: ${{ secrets.CLIENT_SCAN_TOKEN_DEMO }}
+          traceable_server: ${{ secrets.TRACEABLE_SERVER_DEMO }}
+  functionalTest:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Run a loop as functional test
+        run: |
+          for ((i=1;i<=100;i++)); 
+          do 
+             echo $i
+          done
+```
+2. As you can see in the above workflow, we have initiated the scan with initiate scan action step which takes client_scan_token, traffic_env, and traceable_server as input. You can configure other parameters as well as mentioned in the documentation.
+3. Alternatively you can create a scan-suite on the Traceable.AI Platform and configure assets, attacks, evaluation criteria etc. on the platform itself. You can spawn a scan from the suite configuration by specifying just the `scan_suite` parameter with value as suite name.
+4. In the next step we are executing functional tests and then running the scan in the step after that which take client_scan_token,traffic_env, and cli_version as input.