docs(jobs): Update content for GHA

Signed-off-by: Peter Mikus <peter.mikus@icloud.com>
Change-Id: Ia3e35e479bffe08a9e44e3afa6f9c43989ae3ffe

Author: Peter Mikus

.github/actions/csit-comment-dispatch/action.yml

@@ -40,13 +40,13 @@ runs:
           exit 1
         fi
 
-        # Split <command> (expected format: <trigger>-<dut>-<node>)
+        # Split <command> (expected format: <project>-<dut>-<node>)
         set +e
-        IFS=- read -r -d '' trigger dut node < <(printf %s $command)
+        IFS=- read -r -d '' project dut node < <(printf %s $command)
         set -e
 
-        if [[ -z "${trigger:-}" || -z "${dut:-}" || -z "${node:-}" ]]; then
-          echo "::error::Malformed command: '$command'. Expected format '<trigger>-<dut>-<node>'."
+        if [[ -z "${project:-}" || -z "${dut:-}" || -z "${node:-}" ]]; then
+          echo "::error::Malformed command: '$command'. Expected format '<project>-<dut>-<node>'."
           exit 1
         fi
 

docs/content/methodology/per_patch_testing.md

@@ -5,8 +5,6 @@ weight: 5
 
 # Per-patch Testing
 
-Updated for CSIT git commit id: d8ec3f8673346c0dc93e567159771f24c1bf74fc.
-
 A methodology similar to trending analysis is used for comparing performance
 before a DUT code change is merged. This can act as a verify job to disallow
 changes which would decrease performance without a good reason.
@@ -18,10 +16,13 @@ They allow full tag expressions, all types of perf tests are supported.
 
 There are jobs available for multiple types of testbeds,
 based on various processors.
-Their Gerrit triggers words are of the form "perftest-{node_arch}"
-where the node_arch combinations currently supported are:
-2n-icx, 2n-clx, 2n-spr, 2n-zn2, 3n-icx, 3n-tsh, 3n-alt, 2n-tx2, 3n-snr,
-3na-spr, 3nb-spr.
+Their Gerrit triggers words are of the form
+"gha-run csit-{dut}-{node_arch} {testype}", where:
+
+- dut: [vpp, dpdk, trex]
+- testype: [perftest, bisecttest]
+- node_arch: [3n-oct, 3n-emr, 2n-emr, 2n-grc, 2n-icx, 2n-spr, 2n-zn2, 3n-icx,
+3n-alt, 3n-snr, 3na-spr, 3nb-spr]
 
 ## Test selection
 
@@ -35,47 +36,20 @@ to accidentally select too high number of tests, blocking the testbed for days.
 What follows is a list of explanations and recommendations
 to help users to select the minimal set of tests cases.
 
-### Verify cycles
-
-When Gerrit schedules multiple jobs to run for the same patch set,
-it waits until all runs are complete.
-While it is waiting, it is possible to trigger more jobs
-(adding runs to the set Gerrit is waiting for), but it is not possible
-to trigger more runs for the same job, until Gerrit is done waiting.
-After Gerrit is done waiting, it becames possible to trigger
-the same job again.
-
-Example. User triggers one set of tests on 2n-icx and immediately
-also triggers other set of tests on 3n-icx. Then the user notices
-2n-icx run ended early because of a typo in tag expression.
-When the user tries to re-trigger 2n-icx (with a fixed tag expression),
-that comment is ignored by Jenkins.
-Only when 3n-icx job finishes, the user can trigger 2n-icx again.
-
-### One comment many jobs
-
-In the past, the CSIT code which parses for perftest trigger comments
-was buggy, which lead to bad behavior (as in selection all performance test,
-because "perftest" is also a robot tag) when user included multiple
-perftest trigger words in the same comment.
-
-The worst bugs were fixed since then, but it is still recommended
-to use just one trigger word per Gerrit comment, just to be safe.
-
 ### Multiple test cases in run
 
 While Robot supports OR operator, it does not support parentheses,
 so the OR operator is not very useful.
 It is recommended to use space instead of OR operator.
 
 Example template:
-perftest-2n-icx {tag_expression_1} {tag_expression_2}
+gha-run csit-vpp-2n-emr perftest {tag_expression_1} {tag_expression_2}
 
 See below for more concrete examples.
 
 ### Suite tags
 
-Traditionally, CSIT maintains broad Robot tags that can be used to select tests.
+CSIT maintains broad Robot tags that can be used to select tests.
 
 But it is not recommended to use them for test selection,
 as it is not that easy to determine how many test cases are selected.
@@ -86,12 +60,6 @@ and use its suite tag. For example, "ethip4-ip4base" is a suite tag
 selecting just one suite in CSIT git repository,
 avoiding all scale, container, and other simialr variants.
 
-Note that CSIT uses "autogen" code generator,
-so the robot running in Jenkins has access to more suites
-than visible just by looking into CSIT git repository.
-Thus, suite tag is not enough to select precisely the intended suite,
-and user is encouraged to narrow down to a single test case within a suite.
-
 ### Fully specified tag expressions
 
 Here is one template to select a single test case:
@@ -115,9 +83,9 @@ and more for dot1q and other encapsulated traffic;
 
 As there are more test cases than CSIT can periodically test,
 it is possible to encounter an old test case that currently fails.
-To avoid that, you can look at "job spec" files we use for periodic testing,
-for example
-[this one](https://raw.githubusercontent.com/FDio/csit/master/resources/job_specs/report_iterative/2n-spr/vpp-mrr-00.md).
+To avoid that, you can look at "job specifications" files we use for periodic
+testing, for example
+[this one](https://github.com/FDio/csit/blob/master/resources/job_specifications/test_groups.yaml).
 
 ### Shortening triggers
 
@@ -167,7 +135,7 @@ but wants to test both NIC drivers (not AF_XDP), both apps in VM,
 and both 1 and 2 parallel links.
 
 After shortening, this is the trigger comment fianlly used:
-perftest-3n-icx mrrANDnic_intel-e810cqAND1cAND64bAND?lbvpplacp-dot1q-l2xcbase-eth-2vhostvr1024-1vm\*NOTdrv_af_xdp
+gha-run csit-vpp-3n-icx perftest mrrANDnic_intel-e810cqAND1cAND64bAND?lbvpplacp-dot1q-l2xcbase-eth-2vhostvr1024-1vm\*NOTdrv_af_xdp
 
 ## Basic operation
 

docs/content/methodology/test/_index.md

@@ -15,5 +15,4 @@ weight: 3
 - [Hoststack]({{< relref "/methodology/test/hoststack/" >}})
 - [Generic Segmentation Offload]({{< relref "/methodology/test/generic_segmentation_offload" >}})
 - [Reconfiguration]({{< relref "/methodology/test/reconfiguration" >}})
-- [VPP Device]({{< relref "/methodology/test/vpp_device" >}})
 - [Reassembly]({{< relref "/methodology/test/reassembly" >}})

docs/content/methodology/test/reassembly.md

@@ -1,6 +1,6 @@
 ---
 title: "Reassembly"
-weight: 10
+weight: 9
 ---
 
 # Packet reassembly performance

docs/content/methodology/test/vpp_device.md

@@ -18,64 +18,58 @@ The trigger consist of
 
 ### Report
 
-Both iterative and coverage jobs are triggered by user from gerrit.
+Both iterative and coverage jobs are triggered by user from github action panel.
 
 #### Iterative jobs
 
-Trigger name:
-  - csit-vpp-report-iter-`node`-`arch`-perftest
-
 Default values:
   - iterative test set - the same as it is used for periodical jobs
   - test type: mrr
 
-Mandatory trigger parameters:
+Mandatory workflow parameters:
   - no mandatory parameters - default values are used in that case
 
-Optional trigger parameters:
+Optional workflow parameters:
   - test set
   - test type
 
 Examples:
 
-1. csit-vpp-report-iter-2n-emr-perftest
+1. <no input>
    - Generates default test set and default test type.
 
-2. csit-vpp-report-iter-2n-emr-perftest #ndrpdr
+2. #ndrpdr
    - Generates default test set and ndrpdr tests.
 
-3. csit-vpp-report-iter-2n-emr-perftest #2n-emr-vpp-hoststack
+3. #2n-emr-vpp-hoststack
 
-   csit-vpp-report-iter-2n-emr-perftest #2n-emr-vpp-hoststack #hoststack
+   #2n-emr-vpp-hoststack #hoststack
    - Generates hoststack test set.
    - It is not necessary to specify the test type as it is defined in the name
      of the test set, so both examples are equal and correct.
 
 #### Coverage jobs
 
-Trigger name:
-  - csit-vpp-report-cov-`node`-`arch`-perftest
-
 Default values:
   - test type: ndrpdr
 
-Mandatory trigger parameters:
+Mandatory workflow parameters:
   - test set
 
-Optional trigger parameters:
+Optional workflow parameters:
   - test type, default value: ndrpdr
 
 Examples:
 
-1. csit-vpp-report-cov-2n-emr-perftest #2n-emr-vpp-cov-ip4-00
+1. #2n-emr-vpp-cov-ip4-00
    - Generates the defined test set, ndrpdr tests.
 
 ### Development
 
 #### Verify jobs
 
 Trigger name:
-  - csit-`node`-`arch`-perftest `tags`
+  - gha-run csit-`dut`-`node`-`arch` perftest `tags`
 
 Default values:
   - iterative test set - the same as it is used for periodical jobs
@@ -90,16 +84,16 @@ Optional trigger parameters:
 
 Examples:
 
-1. csit-2n-emr-perftest `tags`
+1. gha-run csit-vpp-2n-emr perftest `tags`
    - Generates iterative mrr tests, runs only those selected by tags.
 
-2. csit-2n-emr-perftest `tags` #2n-emr-vpp-cov-ip4-00 #ndrpdr
+2. gha-run csit-vpp-2n-emr perftest `tags` #2n-emr-vpp-cov-ip4-00 #ndrpdr
    - Generates defined test set, ndrpdr tests, runs only those selected by tags.
 
 #### Bisect jobs
 
 Trigger name:
-  - bisecttest-`node`-`arch` `commit` `tags`
+  - gha-run csit-`dut`-`node`-`arch` bisecttest `commit` `tags`
 
 Default values:
   - iterative test set - the same as it is used for periodical jobs
@@ -114,10 +108,10 @@ Optional trigger parameters:
 
 Examples:
 
-1. bisecttest-2n-emr `commit` `tags`
+1. gha-run csit-vpp-2n-emr bisecttest `commit` `tags`
    - Generates iterative mrr tests, runs only those selected by tags.
 
-2. bisecttest-2n-emr `commit` `tags` #2n-emr-vpp-cov-ip4-00 #ndrpdr
+2. gha-run csit-vpp-2n-emr bisecttest `commit` `tags` #2n-emr-vpp-cov-ip4-00 #ndrpdr
    - Generates defined test set, ndrpdr tests, runs only those selected by tags.
 
 #### Special cases
@@ -138,11 +132,11 @@ test(s).
 
 Examples:
 
-1. csit-2n-emr-perftest `tags` #generate-all
+1. gha-run csit-vpp-2n-emr perftest `tags` #generate-all
    - Generates all tests specified in all test sets for 2n-emr testbed, runs
      only those selected by tags.
 
-1. bisecttest-2n-emr `commit` `tags` #generate-all
+1. gha-run csit-vpp-2n-emr bisecttest `commit` `tags` #generate-all
    - Generates all tests specified in all test sets for 2n-emr testbed, runs
      only those selected by tags.