chore: update README for integration test, minor fix for Makefile and tags of some test cases

Signed-off-by: Trong Nhan Mai <[email protected]>

Author: Trong Nhan Mai

Makefile

@@ -319,6 +319,7 @@ integration-test-docker:
 	python ./tests/integration/run.py \
 		run \
     	--macaron scripts/release_scripts/run_macaron.sh \
+		--include-tag docker-only \
     	--include-tag shared-docker-python \
     	./tests/integration/cases/...
 

tests/integration/README.md

@@ -133,17 +133,21 @@ $ python ./tests/integration/run.py run ./all/cases/...
 
 In certain cases, we can utilize the feature of tags to select a subset of test cases to run with the `run` command.
 
-Each test case can be attached with one or more tags in the yaml configuration. For example, you may find some of our test cases having the `docker` tag as follows.
+Each test case can be attached with one or more tags in the yaml configuration. For example, you may find some of our test cases having the `shared-docker-python` tag as follows.
 
 ```yaml
 description: ...
 tags:
-- docker
+- shared-docker-python
 steps:
 - ...
 ```
 
-We typically have the test cases for the container image being a subset of the test cases for the Macaron Python package. We can mark the test cases shared for both purposes with the `docker` tag. When we do integration testing for the container image, we can add the argument `--include-tag docker` to filter only test cases tagged with `docker`.
+We typically have the test cases for the container image being a subset of the test cases for the Macaron Python package. We can mark the test cases shared for both purposes with the `shared-docker-python` tag. When we do integration testing for the container image, we can add the argument `--include-tag shared-docker-python` to filter only test cases tagged with `shared-docker-python`.
+
+Some other use cases of this tagging feature in our current setup:
+- We can have test cases that **only** run for the container image. In the integration tests for the Macaron Python package, test cases marked with `docker-only` are not run. Note that `docker-only` shouldn't be used with `shared-docker-python`.
+- Test cases marked with `skip` are not run.
 
 ```bash
 # Test the container image with test cases having the `docker` tag.

tests/integration/cases/django_with_dep_resolution_virtual_env_as_input/test.yaml

@@ -5,7 +5,7 @@ description: |
   Tutorial test: Analyzing the dependencies with virtual env provided as input.
 
 tags:
-- docker
+- shared-docker-python
 
 steps:
 - name: Create virtual environment.

tests/integration/cases/run_macaron_sh_early_exit/test.yaml

@@ -5,7 +5,6 @@ description: |
   Running run_macaron.sh on scenarios where the docker image is not available
 
 tags:
-- shared-docker-python
 - docker-only
 
 steps:

tests/integration/cases/run_macaron_sh_script_unit_test/test.yaml

@@ -5,8 +5,7 @@ description: |
   Run unit tests for the run_macaron.sh script
 
 tags:
-- docker
-- token_file_clean_up
+- docker-only
 
 steps:
 - name: Run test_run_macaron_sh.py

tests/integration/cases/run_macaron_sh_with_invalid_docker_pull_env/test.yaml

@@ -5,7 +5,6 @@ description: |
   Making sure run_macaron.sh clean up the token file when it exits because DOCKER_PULL is set to an invalid value.
 
 tags:
-- shared-docker-python
 - docker-only
 
 steps: