refactor: improve e2e documentation and small clean up (#683)

* refactor(test): remove documentation to test scan abort manually since this is now covered by e2e tests

* refactor(test): remove init services from test environment

* refactor(test): rename docker compose file in documentation

* docs(test): add short e2e test readme file

* ci(test): rename test job to e2e

* docs(test): mention new e2e readme file in contributing

.github/workflows/ci.yml

@@ -77,9 +77,9 @@ jobs:
       push: false
       upload: true
 
-  test:
+  e2e:
     needs: build
-    name: Test
+    name: E2E Test
     runs-on: ubuntu-latest
     steps:
       - name: Checkout

CONTRIBUTING.md

@@ -97,10 +97,9 @@ api` to regenerate the model, client and server code.
 
 ### Testing End to End
 
-`make e2e` can be used run all the integration tests in the repo.
+`make e2e` can be used run the end-to-end tests in the repository.
 
-For details on how to test VMClarity end to end please see the End to End
-testing guide [here](docs/test_e2e.md).
+For details on how to test VMClarity, please check the testing guide [here](docs/test_e2e.md) on how to perform a test on AWS and the instructions [here](e2e/README.md) on how to run and add new tests.
 
 ## Sending Pull Requests
 

api/openapi.yaml

@@ -1965,7 +1965,6 @@ components:
           type: string
         location:
           type: string
-        # TODO(paralta) Check if image needs to be a required property
         image:
           $ref: '#/components/schemas/ContainerImageInfo' 
         id:

e2e/README.md

@@ -0,0 +1,41 @@
+# E2E tests
+
+VMClarity's end-to-end tests use the [Ginkgo](https://onsi.github.io/ginkgo/) test framework and the [Gomega](https://onsi.github.io/gomega/) matcher/assertion library to leverage behavior driven testing (BDD).
+
+This test module is composed by:
+
+* a `testenv.go` file where the test environment is configured,
+* a `docker-compose.override.yml` file which will merge and override the installation compose file to run end-to-end tests,
+* a `suite_test.go` file where the steps to perform the setup and cleanup of the Ginkgo test suite are defined,
+* a `helper.go` file where common methods are defined,
+* and test case files.
+
+## Run test
+
+To run all end-to-end tests, use the following command:
+
+```
+go test -v -failfast -test.v -test.paniconexit0 -timeout 2h -ginkgo.v .
+```
+
+To run a particular end-to-end test file, use:
+
+```
+go test -v -failfast -test.v -test.paniconexit0 -timeout 2h -ginkgo.v --ginkgo.focus-file <go test file> .
+```
+
+## Write a new test
+
+To add a new test, create a new `<test_name>_test.go` file in the current directory and use the following template:
+
+```go
+var _ = ginkgo.Describe("<add a brief test case description>", func() {
+    ginkgo.Context("<describe conditions or inputs>", func() {
+        ginkgo.It("<describe the behaviour or feature being tested>", func(ctx ginkgo.SpecContext) {
+			<implement test code>
+		})
+	})
+})
+```
+
+Additionally, check the available test cases (e.g. `basic_scan_test.go`) to get started.

e2e/testenv/testenv.go

@@ -136,9 +136,7 @@ func (e *Environment) ServicesReady(ctx context.Context) (bool, error) {
 		return false, err
 	}
 
-	// TODO(paralta) remove when grype-server-init service is removed.
-	initServices := e.InitServices()
-	if len(services)-len(initServices) != len(ps) {
+	if len(services) != len(ps) {
 		return false, nil
 	}
 
@@ -159,18 +157,6 @@ func (e *Environment) Services() []string {
 	return services
 }
 
-// TODO(paralta) remove when grype-server-init service is removed.
-func (e *Environment) InitServices() []string {
-	services := make([]string, 0, len(e.project.Services))
-	for _, srv := range e.project.Services {
-		val, ok := srv.Labels["type"]
-		if ok && val == "init" {
-			services = append(services, srv.Name)
-		}
-	}
-	return services
-}
-
 func (e *Environment) VMClarityURL() (*url.URL, error) {
 	var vmClarityBackend types.ServiceConfig
 	var ok bool

installation/docker/README.md

@@ -15,10 +15,10 @@ copied for this.
 
 ## Starting VMClarity
 ```
-docker compose --project-name vmclarity --file dockercompose.yml up -d --wait --remove-orphans
+docker compose --project-name vmclarity --file docker-compose.yml up -d --wait --remove-orphans
 ```
 
 ## Stopping VMClarity
 ```
-docker compose --project-name vmclarity --file dockercompose.yml down --remove-orphans
+docker compose --project-name vmclarity --file docker-compose.yml down --remove-orphans
 ```