Update testing instructions in README.md, Change testing execution in appveyor.yml (#366)

barbelity · web-flow · commit 5757bdebaa2c · 2020-08-10T13:46:43.000+03:00
diff --git a/README.md b/README.md
@@ -5,19 +5,22 @@
 Build Info is Artifactory's open integration layer for the CI servers and build tools.
 The build information is sent to Artifactory in json format.
 
-## Building and Testing the Sources
+## Building and testing the sources
 
-The code is built using Gradle and includes integration tests.<br/>
-It must run using JDK 8 and Gradle 5.6.2. If you are using different gradle version you can use the provided gradle wrapper.<br/>
-In order to run tests the following environment variable must be provide:
+* The code is built using Gradle and includes integration tests.<br/>
+* It must run using JDK 8 and Gradle 5.6.2. If you are using different gradle version you can use the provided gradle wrapper.<br/>
+* In order to run tests the following environment variables must be set:
 ```
 export BITESTS_ARTIFACTORY_URL='http://localhost:8081/artifactory'
 export BITESTS_ARTIFACTORY_USERNAME=admin
 export BITESTS_ARTIFACTORY_PASSWORD=password
 export BITESTS_ARTIFACTORY_REPO=tests
 export BITESTS_ARTIFACTORY_PIP_ENV=/Users/user/venv-test/bin
 ```
-Before running the tests, please make sure you have a generic repository named *tests* in Artifactory.
+* Before running the tests, please make sure you have a generic repository named *tests* in Artifactory.
+
+### Building
+When running the following commands to build the code, the entire testing suite is also executed. See the *Testing* section for configuration instructions prior to running the tests.
 
 To build the code using the gradle wrapper in Unix run:  
 ```
@@ -36,23 +39,72 @@ To build the code without running the tests, add to the "clean build" command th
 > ./gradlew clean build -x test
 ```
 
-### Running pip tests
-Pip tests must run inside a clean pip-environment. Create a virtual environment and provide the path to its '/bin' directory using the 'BITESTS_ARTIFACTORY_PIP_ENV' variable.
+### Testing
+To run *all* tests:   
+```
+> ./gradlew clean test
+```
+
+#### Extractor tests
+```
+> ./gradlew clean build-info-api:test build-info-client:test build-info-extractor:test build-info-vcs:test
+```
+
+#### Maven tests
+```
+> ./gradlew clean build-info-extractor-maven3:test
+```
+
+#### Gradle tests
+```
+> ./gradlew clean build-info-extractor-gradle:test
+```
+
+#### Npm tests
+* Add npm executable to the system search path (PATH environment variable).
+```
+> ./gradlew clean build-info-extractor-npm:test
+```
+
+#### Go tests
+* Add Go executable to the system search path (PATH environment variable).
+```
+> ./gradlew clean build-info-extractor-go:test
+```
+
+#### Pip tests
+* Add Python and pip executables to the system search path (PATH environment variable).
+* Pip tests must run inside a clean pip-environment. Create a virtual environment and provide its path using the 'BITESTS_ARTIFACTORY_PIP_ENV' variable.  
+When running on a Windows machine, provide the path to the 'Scripts' directory.  
+When running on a unix machine, provide the path to the 'bin' directory.
+```
+> python -m venv buildinfo-tests-env
+> export BITESTS_ARTIFACTORY_PIP_ENV=/Users/user/buildinfo-tests-env/bin
+> ./gradlew clean build-info-extractor-pip:test
+```
+
+#### NuGet tests
+* Add Nuget executable to the system search path (PATH environment variable).
+```
+> ./gradlew clean build-info-extractor-nuget:test
+```
+
+###  Testing on Artifactory OSS
+When testing with an instance of Artifactory OSS, only supported tests are for the build-info-gradle-extractor.
 
-### Running Gradle tests on Artifactory OSS
 On Artifactory pro, the tests infrastructure will create the test repositories by REST API.
 To run the tests on Artifactory OSS, you should create the Gradle repositories by yourself.
 To run Gradle tests on Artifactory OSS:
-1. Start Artifactory on docker container:
+* Start Artifactory on docker container:
 ```
-> docker run --name artifactory -d -p 8081:8081 docker.bintray.io/jfrog/artifactory-oss:latest
+> docker run --name artifactory -d -p 8081:8081 -p 8082:8082 docker.bintray.io/jfrog/artifactory-oss:latest
 ```
-2. With your web browser, go to Artifactory UI: http://127.0.0.1:8081/artifactory
-3. Create 3 Gradle repositories:
+* With your web browser, go to Artifactory UI: http://127.0.0.1:8081/artifactory
+* Create 3 Gradle repositories:
   * Local repository: `build-info-tests-gradle-local`
   * Remote repository to jcenter: `build-info-tests-gradle-remote`
   * Virtual repository containing both the remote and local: `build-info-tests-gradle-virtual` 
-4. Run tests `./gradlew build-info-extractor-gradle:test`
+* Run tests `./gradlew build-info-extractor-gradle:test`
 
 ## Build Info json format
 
diff --git a/appveyor.yml b/appveyor.yml
@@ -1,13 +1,6 @@
-stack: jdk 8, node 8, go 1.13
+stack: jdk 8, node 8, go 1.13, python 3.7.7
 skip_tags: true
 environment:
-  matrix:
-    - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2019
-      JAVA_HOME: C:\Program Files\Java\jdk1.8.0
-      GOPATH: c:\gopath
-      # .NET CLI version
-      CLI_VERSION: Latest
-    - APPVEYOR_BUILD_WORKER_IMAGE: Ubuntu
 
   BITESTS_ARTIFACTORY_URL:
     secure: RIh0gGFDn2JAnLUEEqLsQm0ihToJ6/4LiR411QpvqDgYYE7Y4Eif2e+wYndvHXnW
@@ -18,8 +11,122 @@ environment:
   BITESTS_ARTIFACTORY_REPO:
     secure: Xf371RQAxCTMn/S7NdmV8g==
 
-test_script:
-  - sh: ./gradlew clean test
-  - cmd: gradlew.bat clean test
+  matrix:
+    # Extractor Tests
+    - job_name: extractor_win
+      job_group: general
+      appveyor_build_worker_image: Visual Studio 2019
+      JAVA_HOME: C:\Program Files\Java\jdk1.8.0
+      TEST_SUIT:
+        "gradlew.bat clean build-info-api:test build-info-client:test build-info-extractor:test build-info-vcs:test"
+    - job_name: extractor_linux
+      job_group: general
+      appveyor_build_worker_image: Ubuntu
+      TEST_SUIT:
+        "./gradlew clean build-info-api:test build-info-client:test build-info-extractor:test build-info-vcs:test"
+
+    # Maven Tests
+    - job_name: maven_extractor_win
+      job_group: general
+      appveyor_build_worker_image: Visual Studio 2019
+      JAVA_HOME: C:\Program Files\Java\jdk1.8.0
+      TEST_SUIT:
+        "gradlew.bat clean build-info-extractor-maven3:test"
+    - job_name: maven_extractor_linux
+      job_group: general
+      appveyor_build_worker_image: Ubuntu
+      TEST_SUIT:
+        "./gradlew clean build-info-extractor-maven3:test"
+
+    # Gradle Tests
+    - job_name: gradle_extractor_win
+      job_group: general
+      appveyor_build_worker_image: Visual Studio 2019
+      JAVA_HOME: C:\Program Files\Java\jdk1.8.0
+      TEST_SUIT:
+        "gradlew.bat clean build-info-extractor-gradle:test"
+    - job_name: gradle_extractor_linux
+      job_group: general
+      appveyor_build_worker_image: Ubuntu
+      TEST_SUIT:
+        "./gradlew clean build-info-extractor-gradle:test"
+
+    # npm Tests
+    - job_name: npm_extractor_win
+      job_group: general
+      appveyor_build_worker_image: Visual Studio 2019
+      JAVA_HOME: C:\Program Files\Java\jdk1.8.0
+      TEST_SUIT:
+        "gradlew.bat clean build-info-extractor-npm:test"
+    - job_name: npm_extractor_linux
+      job_group: general
+      appveyor_build_worker_image: Ubuntu
+      TEST_SUIT:
+        "./gradlew clean build-info-extractor-npm:test"
+
+    # Go Tests
+    - job_name: go_extractor_win
+      job_group: general
+      appveyor_build_worker_image: Visual Studio 2019
+      JAVA_HOME: C:\Program Files\Java\jdk1.8.0
+      TEST_SUIT:
+        "gradlew.bat clean build-info-extractor-go:test"
+    - job_name: go_extractor_linux
+      job_group: general
+      appveyor_build_worker_image: Ubuntu
+      TEST_SUIT:
+        "./gradlew clean build-info-extractor-go:test"
+
+    # Pip Tests
+    - job_name: pip_extractor_win
+      job_group: pip
+      appveyor_build_worker_image: Visual Studio 2019
+      JAVA_HOME: C:\Program Files\Java\jdk1.8.0
+      BITESTS_ARTIFACTORY_PIP_ENV: C:\\projects\\build-info\\pip-venv\\Scripts
+      TEST_SUIT:
+        "gradlew.bat clean build-info-extractor-pip:test"
+    - job_name: pip_extractor_linux
+      job_group: pip
+      appveyor_build_worker_image: Ubuntu
+      PYTHON: $HOME/venv3.7.7
+      BITESTS_ARTIFACTORY_PIP_ENV: /home/appveyor/projects/build-info/pip-venv/bin
+      TEST_SUIT:
+        "./gradlew clean build-info-extractor-pip:test"
+
+    # NuGet Tests
+    - job_name: nuget_extractor_win
+      job_group: general
+      appveyor_build_worker_image: Visual Studio 2019
+      JAVA_HOME: C:\Program Files\Java\jdk1.8.0
+      # .NET CLI version
+      CLI_VERSION: Latest
+      TEST_SUIT:
+        "gradlew.bat clean build-info-extractor-nuget:test"
+    - job_name: nuget_extractor_linux
+      job_group: general
+      appveyor_build_worker_image: Ubuntu
+      # .NET CLI version
+      CLI_VERSION: Latest
+      TEST_SUIT:
+        "./gradlew clean build-info-extractor-nuget:test"
+
+for:
+  -
+    matrix:
+      only:
+        - job_group: general
+    test_script:
+      - sh: "$TEST_SUIT"
+      - cmd: "%TEST_SUIT%"
+  -
+    matrix:
+      only:
+        - job_group: pip
+    test_script:
+      - sh: "python --version"
+      - sh: "python -m venv pip-venv"
+      - sh: "$TEST_SUIT"
+      - cmd: "C:\\Python37-x64\\python -m venv pip-venv"
+      - cmd: "%TEST_SUIT%"
 
 build: off
