chore: refactor integration test structure and update contributing guidelines (#15)

Signed-off-by: Tomer Figenblat <[email protected]>

Author: TomerFi

CONTRIBUTING.md

@@ -62,13 +62,35 @@ and the [tsconfig.json](tsconfig.json) configuration file. Also note the _TypeSc
   Use [java_maven.js](src/providers/java_maven.js) as an example to get you started.
 * Import the new _Provider_ and list in the in _availableProviders_ array in [provider.js](src/provider.js).
 * Update the _choices_ configuration for the _manifest-name_ positional argument in  [cli.js](src/cli.js).
-* Add Integration Test scenarios for the added provider in [integration/langs](integration/langs).
-  Use the [java scenarios](integration/langs/java) as an example.
+* Add Integration Test scenarios for the added provider in [integration/scenarios](integration/scenarios).
+  Use the [java scenarios](integration/scenarios/java) as an example.
 * Update the documentation. This document and [README.md](README.md).
 
 ### Integration Tests
 
-WIP
+Integration tests are performed with a _bash_ script executing _node_ scripts.<br/>
+In [integration/run_its.sh](integration/run_its.sh) we start with a function called _match_ taking 2 arguments:
+* `$1` is a file name for the holding the expected result (scenarios)
+* `$2` is a command execution for evaluation (testers)
+
+The _match_ function will match the content of the file to the output of the command.
+Typically, test cases in [integration/run_its.sh](integration/run_its.sh) will invoke the _match_ function with
+a scenario from the [integration/scenarios](integration/scenarios) and a _node_ command invoking one of the _node_
+scripts in [integration/testers](integration/testers).<br/>
+
+We have 3 _testers_:
+* [integration/testers/cli](integration/testers/cli) is a _package.json_ used for installing the _ESM module_.
+  Invoking the CLI Script is done against the _@RHEcosystemAppEng/crda-javascript-api/dist/src/cli.js_ in the tester's _node_modules_.
+* [integration/testers/javascript](integration/testers/javascript) is a _javascript_ script invoking the _ESM module_.
+* [integration/testers/typescript](integration/testers/typescript) is a _typescript_ script invoking the _ESM module_.
+
+Run integration tests from the project's root:
+
+> Don't forget to run `npm run compile` before running the integration tests.
+
+```shell
+(cd integration/ && bash ./run_its.sh)
+```
 
 > We currently run integration tests against the actual production _Backend_, this will be replaced by opting for a _Mock Server_.
 

integration/run_its.sh

@@ -47,8 +47,9 @@ echo "- SUCCESSFUL"
 ###### JavaScript Integration Tests ######
 ##########################################
 echo "PREPARING JavaScript integration tests environment"
-rm -rf javascript/node_modules
-if ! npm --prefix javascript install --silent
+rm -rf testers/javascript/node_modules
+rm -f testers/javascript/package-lock.json
+if ! npm --prefix ./testers/javascript install --silent
 then
 	echo "- FAILED Installing modules for JS environment"
 	exit $?
@@ -57,49 +58,51 @@ echo "- SUCCESSFUL"
 
 #### JAVA MAVEN
 echo "RUNNING JavaScript integration test for Stack Analysis report in Html for Java Maven"
-match "langs/java/expected_stack_html" "node javascript/index.js stack langs/java/pom.xml true"
+match "scenarios/java/expected_stack_html" "node testers/javascript/index.js stack scenarios/java/pom.xml true"
 
 echo "RUNNING JavaScript integration test for Stack Analysis report in Json for Java Maven"
-match "langs/java/expected_stack_json" "node javascript/index.js stack langs/java/pom.xml false"
+match "scenarios/java/expected_stack_json" "node testers/javascript/index.js stack scenarios/java/pom.xml false"
 
 echo "RUNNING JavaScript integration test for Component Analysis report for Java Maven"
-match "langs/java/expected_component" "node javascript/index.js component pom.xml '$(<langs/java/pom.xml)'"
+match "scenarios/java/expected_component" "node testers/javascript/index.js component pom.xml '$(<scenarios/java/pom.xml)'"
 
 ##########################################
 ###### TypeScript Integration Tests ######
 ##########################################
 echo "PREPARING TypeScript integration tests environment"
-rm -rf typescript/node_modules
-if ! npm --prefix typescript install --silent
+rm -rf testers/typescript/node_modules
+rm -f testers/typescript/package-lock.json
+if ! npm --prefix ./testers/typescript install --silent
 then
 	echo "- FAILED Installing modules for TS environment"
 	exit $?
 fi
 echo "- SUCCESSFUL"
 
-rm -rf typescript/dist
-if ! npm --prefix typescript run compile > /dev/null 2>&1
+rm -rf testers/typescript/dist
+if ! npm --prefix ./testers/typescript run compile > /dev/null 2>&1
 then
 	echo "- FAILED Compiling TS module"
 	exit $?
 fi
 
 #### JAVA MAVEN
 echo "RUNNING TypeScript integration test for Stack Analysis report in Html for Java Maven"
-match "langs/java/expected_stack_html" "node typescript/dist/index.js stack langs/java/pom.xml true"
+match "scenarios/java/expected_stack_html" "node testers/typescript/dist/index.js stack scenarios/java/pom.xml true"
 
 echo "RUNNING TypeScript integration test for Stack Analysis report in Json for Java Maven"
-match "langs/java/expected_stack_json" "node typescript/dist/index.js stack langs/java/pom.xml false"
+match "scenarios/java/expected_stack_json" "node testers/typescript/dist/index.js stack scenarios/java/pom.xml false"
 
 echo "RUNNING TypeScript integration test for Component Analysis report for Java Maven"
-match "langs/java/expected_component" "node typescript/dist/index.js component pom.xml '$(<langs/java/pom.xml)'"
+match "scenarios/java/expected_component" "node testers/typescript/dist/index.js component pom.xml '$(<scenarios/java/pom.xml)'"
 
 ##########################################
 ###### CMD Script Integration Tests ######
 ##########################################
 echo "PREPARING CLI Script integration tests environment"
-rm -rf cli/node_modules
-if ! npm --prefix cli install --silent
+rm -rf testers/cli/node_modules
+rm -f testers/cli/package-lock.json
+if ! npm --prefix ./testers/cli install --silent
 then
 	echo "- FAILED Installing modules for JS environment"
 	exit $?
@@ -108,13 +111,13 @@ echo "- SUCCESSFUL"
 
 #### JAVA MAVEN
 echo "RUNNING CLI Script integration test for Stack Analysis report in Html for Java Maven"
-match "langs/java/expected_stack_html" "node cli/node_modules/@RHEcosystemAppEng/crda-javascript-api/dist/src/cli.js stack langs/java/pom.xml --html"
+match "scenarios/java/expected_stack_html" "node testers/cli/node_modules/@RHEcosystemAppEng/crda-javascript-api/dist/src/cli.js stack scenarios/java/pom.xml --html"
 
 echo "RUNNING CLI Script integration test for Stack Analysis full report in Json for Java Maven"
-match "langs/java/expected_stack_json" "node cli/node_modules/@RHEcosystemAppEng/crda-javascript-api/dist/src/cli.js stack langs/java/pom.xml"
+match "scenarios/java/expected_stack_json" "node testers/cli/node_modules/@RHEcosystemAppEng/crda-javascript-api/dist/src/cli.js stack scenarios/java/pom.xml"
 
 echo "RUNNING CLI Script integration test for Stack Analysis summary only report in Json for Java Maven"
-match "langs/java/expected_stack_json_summary" "node cli/node_modules/@RHEcosystemAppEng/crda-javascript-api/dist/src/cli.js stack langs/java/pom.xml --summary"
+match "scenarios/java/expected_stack_json_summary" "node testers/cli/node_modules/@RHEcosystemAppEng/crda-javascript-api/dist/src/cli.js stack scenarios/java/pom.xml --summary"
 
 echo "RUNNING CLI Script integration test for Component Analysis report for Java Maven"
-match "langs/java/expected_component" "node cli/node_modules/@RHEcosystemAppEng/crda-javascript-api/dist/src/cli.js component pom.xml '$(<langs/java/pom.xml)'"
+match "scenarios/java/expected_component" "node testers/cli/node_modules/@RHEcosystemAppEng/crda-javascript-api/dist/src/cli.js component pom.xml '$(<scenarios/java/pom.xml)'"

integration/langs/java/expected_component renamed to integration/scenarios/java/expected_component

@@ -6,6 +6,6 @@
 	"type": "module",
 	"license": "Apache-2.0",
 	"dependencies": {
-		"@RHEcosystemAppEng/crda-javascript-api": "file:../../"
+		"@RHEcosystemAppEng/crda-javascript-api": "file:../../../"
 	}
 }

integration/langs/java/expected_stack_html renamed to integration/scenarios/java/expected_stack_html

@@ -6,6 +6,6 @@
 	"type": "module",
 	"license": "Apache-2.0",
 	"dependencies": {
-		"@RHEcosystemAppEng/crda-javascript-api": "file:../../"
+		"@RHEcosystemAppEng/crda-javascript-api": "file:../../../"
 	}
 }