E2E tests (#58)

* Add E2E tests

Author: asafgabai

.github/PULL_REQUEST_TEMPLATE.md

@@ -3,7 +3,7 @@
 - [ ] The code has been formatted properly using `go fmt ./...`.
 - [ ] All [static analysis checks](https://github.com/jfrog/jfrog-cli-application/actions/workflows/analysis.yml) passed.
 - [ ] All [tests](https://github.com/jfrog/jfrog-cli-application/actions/workflows/tests.yml) have passed. If this feature is not already covered by the tests, new tests have been added.
-- [ ] All integration tests have passed locally as they cannot be automated yet.
-- [ ] All changes are detailed at the description. if not already covered at [JFrog Documentation](https://github.com/jfrog/documentation), new documentation have been added.
+- [ ] All [E2E tests](https://github.com/jfrog/jfrog-cli-application/actions/workflows/e2e-tests.yml) have passed.
+- [ ] All changes are detailed at the description.
 
------
+-----

.github/workflows/e2e-tests.yml

@@ -0,0 +1,50 @@
+name: E2E Tests
+on:
+  push:
+    branches:
+      - '**'
+    tags-ignore:
+      - '**'
+  workflow_dispatch:
+  pull_request_target:
+    types: [ labeled ]
+# Ensures that only the latest commit is running for each PR at a time.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  e2e-tests:
+    # To avoid running code from untrusted contributors without review, we only run E2E tests on PRs labeled 'safe to test'
+    if: contains(github.event.pull_request.labels.*.name, 'safe to test') || github.event_name == 'push' || github.event_name == 'workflow_dispatch'
+    name: E2E tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Unlabel 'safe to test'
+        uses: actions-ecosystem/action-remove-labels@v1
+        if: ${{ github.event_name != 'push' && github.event_name != 'workflow_dispatch' }}
+        with:
+          labels: "safe to test"
+
+      - name: Checkout code
+        uses: actions/checkout@v6
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Setup Go
+        uses: actions/setup-go@v6
+        with:
+          go-version-file: go.mod
+
+      - name: Run E2E Tests
+        run: |
+          make e2e-test-ci
+        env:
+          JFROG_APPTRUST_CLI_TESTS_JFROG_URL: ${{ secrets.JFROG_APPTRUST_CLI_TESTS_JFROG_URL }}
+          JFROG_APPTRUST_CLI_TESTS_JFROG_ACCESS_TOKEN: ${{ secrets.JFROG_APPTRUST_CLI_TESTS_JFROG_ACCESS_TOKEN }}
+
+      - name: Publish Results
+        uses: EnricoMi/publish-unit-test-result-action@v2
+        if: always()
+        with:
+          files: |
+            e2e-tests-report.xml

.github/workflows/tests.yml

@@ -1,12 +1,8 @@
-name: Go Tests
+name: Tests
 on:
   push:
-    branches:
-      - '**'
-    tags-ignore:
-      - '**'
   workflow_dispatch:
-  pull_request_target:
+  pull_request:
 # Ensures that only the latest commit is running for each PR at a time.
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}-${{ github.ref }}
@@ -16,22 +12,13 @@ jobs:
     name: Unit tests
     runs-on: ubuntu-latest
     steps:
-
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Setup Go
-        uses: actions/setup-go@v5
+        uses: actions/setup-go@v6
         with:
           go-version-file: go.mod
-          cache: false
-
-      - name: Go Cache
-        uses: actions/cache@v4
-        with:
-          path: ~/go/pkg/mod
-          key: go-${{ hashFiles('**/go.sum') }}
-          restore-keys: go-
 
       - name: Run Tests
         run: |
@@ -41,6 +28,5 @@ jobs:
         uses: EnricoMi/publish-unit-test-result-action@v2
         if: always()
         with:
-          check_name: Unit Tests Results
           files: |
             utests-report.xml

CONTRIBUTING.md

@@ -19,108 +19,27 @@ go run github.com/jfrog/jfrog-cli-application command [options] [arguments...]
 
 ---
 
-This project heavily depends on the following modules:
-
-- [github.com/jfrog/jfrog-client-go](https://github.com/jfrog/jfrog-client-go)
-- [github.com/jfrog/jfrog-cli-core](github.com/jfrog/jfrog-cli-core)
-
-During local development, if you come across code that needs to be modified in one of the mentioned modules, it is advisable to replace the dependency with a local clone of the module.
-
-<details>
-<summary>Replacing a dependency with a local clone</summary>
-
----
-
-To include this local dependency, For instance, let's assume you wish to modify files from `jfrog-cli-core`, modify the `go.mod` file as follows:
-
-```
-replace github.com/jfrog/jfrog-cli-core/v2 => /local/path/in/your/machine/jfrog-cli-core
-```
-
-Afterward, execute `go mod tidy` to ensure the Go module files are updated. Note that Go will automatically adjust the version in the `go.mod` file.
-
----
-
-</details>
-
-
 ## 🚦 Running Tests
 
-When running tests, builds and repositories with timestamps like `cli-rt1-1592990748` and `cli-rt2-1592990748` will be created. The content of these repositories will be deleted once the tests are completed.
-
-To run tests, use the following command:
+To run unit tests, use the following command:
 
 ```
-go test -v github.com/jfrog/jfrog-cli-application [test-types] [flags]
+make test
 ```
 
-### The available flags are:
-
-| Flag                | Description                                                                                     |
-| ------------------- | ----------------------------------------------------------------------------------------------- |
-| `-jfrog.url`        | [Default: http://localhost:8081] JFrog platform URL                                             |
-| `-jfrog.user`       | [Default: admin] JFrog platform username                                                        |
-| `-jfrog.password`   | [Default: password] JFrog platform password                                                     |
-| `-jfrog.adminToken` | [Optional] JFrog platform admin token                                                           |
-| `-ci.runId`         | [Optional] A unique identifier used as a suffix to create repositories and builds in the tests. |
-| `-jfrog.sshKeyPath`    | [Optional] Path to the SSH key file. Use this flag only if the Artifactory URL format is `ssh://[domain]:port`. |
-| `-jfrog.sshPassphrase` | [Optional] Passphrase for the SSH key.                                                                          |
+To run end-to-end (E2E) tests, refer to the README file located in the `e2e` directory.
 
 ---
 
-
-### The available test types are:
-
-| Type                 | Description        |
-| -------------------- | ------------------ |
-| `-test.security`     | [Default: true] Security commands integration tests  |
-| `-test.dockerScan`   | [Optional] Docker scan integration tests  |
-
-### Docker Scan tests
-
-<details>
-
-#### Requirements
-
-- Make sure the `RTLIC` environment variable is configured with a valid license.
-- Before running the tests, wait for Artifactory to finish booting up in the container.
-
-| Flag                      | Description                         |
-| ------------------------- | ----------------------------------- |
-| `-test.containerRegistry` | Artifactory Docker registry domain. |
-
-
-</details>
-
 ## 📖 Submitting PR Guidelines
 
-Once you have completed your coding changes, it is recommended to push the modifications made to the other modules first. Once these changes are pushed, you can update this project to resolve dependencies from your GitHub fork or branch.
-
-<details>
-
-<summary>Resolve dependencies from GitHub fork or branch</summary>
-
----
-
-To achieve this, modify the `go.mod` file to point the dependency to your repository and branch, as shown in the example below:
-
-```
-replace github.com/jfrog/jfrog-cli-core/v2 => github.com/jfrog/jfrog-cli-core/v2 dev
-```
-
-Finally, execute `go mod tidy` to update the Go module files. Please note that Go will automatically update the version in the `go.mod` file.
-
----
-
-</details>
-
 ### Before submitting the pull request, ensure:
 
-- Your changes are covered by `unit` and `integration` tests. If not, please add new tests.
-- The documentation covers the changes, if not please add and make changes at [The documentation repository](https://github.com/jfrog/documentation)
-- Run the go linter with --fix flag `golangci-lint run --fix` 
+- Your changes are covered by `unit` and `e2e` tests. If not, please add new tests.
+- The code has been validated to compile successfully by running `go vet ./...`
+- The code has been formatted properly using `go fmt ./...`
 
 ### When creating the pull request, ensure:
 
-- The pull request is on the `dev` branch.
+- The pull request is targeting the `main` branch.
 - The pull request description describes the changes made.

Makefile

@@ -45,8 +45,8 @@ GOLANGCI_LINT:
 
 ########## BUILD ##########
 prereq::
-	$(GOCMD) install github.com/jstemmer/go-junit-report/v2@latest
-	GOBIN=${TOOLS_DIR} $(GOCMD) install go.uber.org/mock/mockgen@v0.5.0
+	$(GOCMD) install gotest.tools/gotestsum@latest
+	GOBIN=${TOOLS_DIR} $(GOCMD) install go.uber.org/mock/mockgen@v0.6.0
 	${TOOLS_DIR}/mockgen --version
 
 build:: clean generate-mock
@@ -82,5 +82,8 @@ test: PACKAGES=./...
 test: test-prereq
 	go test ./...
 test-ci: test-prereq
-	go test -v 2>&1 ./... | go-junit-report -set-exit-code -iocopy -out utests-report.xml
-
+	gotestsum --format testname --junitfile=utests-report.xml -- ./...
+e2e-test: test-prereq
+	go test ./e2e/... -tags=e2e
+e2e-test-ci: test-prereq
+	gotestsum --format testname --junitfile=e2e-tests-report.xml -- ./e2e/... -tags=e2e

apptrust/http/http_client.go

@@ -24,7 +24,7 @@ const apptrustApiPath = "apptrust/api"
 type ApptrustHttpClient interface {
 	GetHttpClient() *jfroghttpclient.JfrogHttpClient
 	Post(path string, requestBody interface{}, params map[string]string) (resp *http.Response, body []byte, err error)
-	Get(path string) (resp *http.Response, body []byte, err error)
+	Get(path string, params map[string]string) (resp *http.Response, body []byte, err error)
 	Patch(path string, requestBody interface{}) (resp *http.Response, body []byte, err error)
 	Delete(path string, params map[string]string) (resp *http.Response, body []byte, err error)
 }
@@ -101,8 +101,8 @@ func (c *apptrustHttpClient) Post(path string, requestBody interface{}, params m
 	return c.client.SendPost(url, requestContent, c.getJsonHttpClientDetails())
 }
 
-func (c *apptrustHttpClient) Get(path string) (resp *http.Response, body []byte, err error) {
-	url, err := utils.BuildUrl(c.serverDetails.Url, apptrustApiPath+path, nil)
+func (c *apptrustHttpClient) Get(path string, params map[string]string) (resp *http.Response, body []byte, err error) {
+	url, err := utils.BuildUrl(c.serverDetails.Url, apptrustApiPath+path, params)
 	if err != nil {
 		return nil, nil, err
 	}

apptrust/http/mocks/http_client_mock.go

@@ -20,7 +20,7 @@ func NewSystemService() SystemService {
 }
 
 func (ss *systemService) Ping(ctx service.Context) error {
-	response, body, err := ctx.GetHttpClient().Get("/v1/system/ping")
+	response, body, err := ctx.GetHttpClient().Get("/v1/system/ping", nil)
 	if err != nil {
 		return err
 	}

apptrust/service/systems/system_service.go

@@ -53,7 +53,7 @@ func TestSystemService_Ping(t *testing.T) {
 			defer ctrl.Finish()
 
 			mockHttpClient := mockhttp.NewMockApptrustHttpClient(ctrl)
-			mockHttpClient.EXPECT().Get("/v1/system/ping").
+			mockHttpClient.EXPECT().Get("/v1/system/ping", nil).
 				Return(tt.mockResponse, tt.mockBody, tt.mockError)
 
 			mockCtx := mockservice.NewMockContext(ctrl)

apptrust/service/systems/system_service_test.go

@@ -0,0 +1,37 @@
+# E2E Tests
+
+## Running E2E Tests
+
+### Prerequisites
+
+1. Setup a JPD (JFrog Platform Deployment)
+2. Create an identity token with admin permissions
+
+### Configuration
+
+You can configure the tests using either environment variables or command-line flags.
+
+#### Option 1: Environment Variables
+
+Set the following environment variables:
+
+* **JFROG_APPTRUST_CLI_TESTS_JFROG_URL**: The JFrog Platform URL (defaults to `http://localhost:8082/` if not set)
+* **JFROG_APPTRUST_CLI_TESTS_JFROG_ACCESS_TOKEN**: The JFrog Platform access token
+
+Example:
+
+```bash
+export JFROG_APPTRUST_CLI_TESTS_JFROG_URL=http://localhost:8082
+export JFROG_APPTRUST_CLI_TESTS_JFROG_ACCESS_TOKEN=your-access-token
+go test -tags=e2e ./e2e/...
+```
+
+#### Option 2: Command-Line Flags
+
+Use the `-jfrog.url` and `-jfrog.adminToken` flags:
+
+Example:
+
+```bash
+go test -tags=e2e -jfrog.url=http://localhost:8082 -jfrog.adminToken=your-access-token ./e2e/...
+```