Chore/fix magefile running test (#1492)

* chore: validate magefile goals

Signed-off-by: chenk <[email protected]>

* chore: validate magefile goals

Signed-off-by: chenk <[email protected]>

* chore: validate magefile goals

Signed-off-by: chenk <[email protected]>

* chore: validate magefile goals

Signed-off-by: chenk <[email protected]>

* chore: validate magefile goals

Signed-off-by: chenk <[email protected]>

* chore: validate magefile goals

Signed-off-by: chenk <[email protected]>

* chore: validate magefile goals

Signed-off-by: chenk <[email protected]>

* chore: validate magefile goals

Signed-off-by: chenk <[email protected]>

* chore: validate magefile goals

Signed-off-by: chenk <[email protected]>

* chore: validate magefile goals

Signed-off-by: chenk <[email protected]>

* chore: validate magefile goals

Signed-off-by: chenk <[email protected]>

* chore: validate magefile goals

Signed-off-by: chenk <[email protected]>

---------

Signed-off-by: chenk <[email protected]>

Author: chen-keinan

.github/workflows/build.yaml

@@ -47,6 +47,10 @@ jobs:
           key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
           restore-keys: |
             ${{ runner.os }}-go-
+      - name: Install tools
+        uses: aquaproj/[email protected]
+        with:
+          aqua_version: v1.25.0
       - name: Verify Go code
         uses: golangci/[email protected]
         with:
@@ -57,11 +61,11 @@ jobs:
       - name: Verify YAML code
         uses: ibiqlik/action-yamllint@v3
       - name: Vendor Go modules
-        run: go mod vendor
+        run: go mod tidy
       - name: Verify all generated
-        run: make verify-generated
+        run: mage generate:verify
       - name: Verify Generated Helm docs
-        run: make verify-generated-helm-docs
+        run: mage generate:verifydocs
   tests:
     name: Run tests
     runs-on: ubuntu-latest
@@ -78,8 +82,12 @@ jobs:
           key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
           restore-keys: |
             ${{ runner.os }}-go-
+      - name: Install tools
+        uses: aquaproj/[email protected]
+        with:
+          aqua_version: v1.25.0
       - name: Run unit tests
-        run: make test
+        run: mage test:unit
       - name: Upload code coverage
         uses: codecov/codecov-action@v3
         with:
@@ -103,8 +111,12 @@ jobs:
           key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
           restore-keys: |
             ${{ runner.os }}-go-
+      - name: Install tools
+        uses: aquaproj/[email protected]
+        with:
+          aqua_version: v1.25.0
       - name: Run envtest
-        run: make envtest
+        run: mage test:envtest
       - name: Upload code coverage
         uses: codecov/codecov-action@v3
         with:
@@ -128,6 +140,10 @@ jobs:
           key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
           restore-keys: |
             ${{ runner.os }}-go-
+      - name: Install tools
+        uses: aquaproj/[email protected]
+        with:
+          aqua_version: v1.25.0
       - name: Setup Kubernetes cluster (KIND)
         uses: engineerd/[email protected]
         with:
@@ -141,7 +157,7 @@ jobs:
       - name: Run integration tests
         run: |
           kubectl create -k deploy/static
-          make itests-trivy-operator
+          mage test:integration
         env:
           KUBECONFIG: /home/runner/.kube/config
           OPERATOR_NAMESPACE: trivy-system

.github/workflows/release.yaml

@@ -32,8 +32,12 @@ jobs:
           key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
           restore-keys: |
             ${{ runner.os }}-go-
+      - name: Install tools
+        uses: aquaproj/[email protected]
+        with:
+          aqua_version: v1.25.0
       - name: Run unit tests
-        run: make test
+        run: mage test:unit
   itest-trivy-operator:
     name: Run integration tests / Trivy Operator
     needs:
@@ -53,6 +57,10 @@ jobs:
           key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
           restore-keys: |
             ${{ runner.os }}-go-
+      - name: Install tools
+        uses: aquaproj/[email protected]
+        with:
+          aqua_version: v1.25.0
       - name: Setup Kubernetes cluster (KIND)
         uses: engineerd/[email protected]
         with:
@@ -66,7 +74,7 @@ jobs:
       - name: Run integration tests
         run: |
           kubectl create -k deploy/static
-          make itests-trivy-operator
+          mage test:integration
         env:
           KUBECONFIG: /home/runner/.kube/config
           OPERATOR_NAMESPACE: trivy-system

CONTRIBUTING.md

@@ -73,11 +73,12 @@ Each commit message doesn't have to follow conventions as long as it is clear an
 Note: Some of our tests performs integration testing by starting a local
 control plane using
 [envtest](https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/envtest).
-If you only run test using the Makefile
-(`m̀ake test`), no additional installation is required. But if you want to
+If you only run test using the Magefile
+(`mage test:unit`), no additional installation is required. But if you want to
 run some of these integration tests using `go test` or from your IDE, you'll
 have to
 [install kubebuiler-tools](https://book.kubebuilder.io/reference/envtest.html#installation).
+[install magefile](https://magefile.org)  or use `go run mage.go <goal>` 
 
 ## Build Binaries
 
@@ -88,21 +89,21 @@ have to
 To build all Trivy-operator binary, run:
 
 ```
-make
+mage build:all
 ```
 
 This uses the `go build` command and builds binaries in the `./bin` directory.
 
 To build all Trivy-operator binary into Docker images, run:
 
 ```
-make docker-build
+mage build:docker
 ```
 
 To load Docker images into your KIND cluster, run:
 
 ```
-kind load docker-image aquasecurity/trivy-operator:dev
+mage build:kindloadimages
 ```
 
 ## Testing
@@ -116,7 +117,7 @@ collaborators, more coarse grained integration tests might be required.
 To run all tests with code coverage enabled, run:
 
 ```
-make test
+mage test:unit
 ```
 
 To open the test coverage report in your web browser, run:
@@ -130,7 +131,7 @@ go tool cover -html=coverage.txt
 The operator envtest spin us partial k8s components (api-server, etcd) and test controllers for reousce, workload, ttl, rbac and more
 
 ```
-make envtest
+mage test:envtest
 ```
 
 ### Run Integration Tests
@@ -155,7 +156,7 @@ To run the integration tests for Trivy-operator Operator and view the coverage r
 OPERATOR_NAMESPACE=trivy-system \
   OPERATOR_TARGET_NAMESPACES=default \
   OPERATOR_LOG_DEV_MODE=true \
-  make itests-trivy-operator
+  mage test:integration
 go tool cover -html=itest/trivy-operator/coverage.txt
 ```
 
@@ -217,11 +218,11 @@ We currently generate:
 - Mandatory DeepCopy functions for a Go struct representing a CRD
 
 This means that you should not try to modify any of these files directly, but instead change
-the code and code markers. Our Makefile contains a target to ensure that all generated files
+the code and code markers. Our MageFile contains a target to ensure that all generated files
 are up-to-date: So after doing modifications in code, affecting CRDs/ClusterRole, you should
-run `make generate-all` to regenerate everything.
+run `mage generate:all` to regenerate everything.
 
-Our CI will verify that all generated is up-to-date by running `make verify-generated`.
+Our CI will verify that all generated is up-to-date by running `mage generate:verify`.
 
 Any change to the CRD structs, including nested structs, will probably modify the CRD.
 This is also true for Go docs, as field/type doc becomes descriptions in CRDs.
@@ -248,7 +249,7 @@ basic development workflow. For other install modes see [Operator Multitenancy w
 1. Build the operator binary into the Docker image and load it from your host into KIND cluster nodes:
 
    ```
-   make docker-build-trivy-operator && kind load docker-image aquasecurity/trivy-operator:dev
+   mage build:docker && kind load docker-image aquasecurity/trivy-operator:dev
    ```
 
 2. Create the `trivy-operator` Deployment in the `trivy-system` namespace to run the operator's container:
@@ -318,7 +319,7 @@ To avoid maintaining resources in multiple places, we have a created a script
 to (re)generate the static resources from the Helm chart.
 
 So if modifying the operator resources, please do so by modifying the Helm
-chart, then run `make manifests` to ensure the static
+chart, then run `mage generate:manifests` to ensure the static
 resources are up-to-date.
 
 ## Update helm docs
@@ -328,7 +329,7 @@ Since some prefer to not use Helm, we also provide helm config documentation to
 install the operator.
 
 So if modifying the operator helm params, please do so by modifying the Helm
-chart, then run `make generate-helm-docs` to ensure the helm docs are up-to-date.
+chart, then run `mage generate:docs` to ensure the helm docs are up-to-date.
 
 ## Operator Lifecycle Manager (OLM)
 

aqua.yaml

@@ -0,0 +1,8 @@
+---
+# aqua - Declarative CLI Version Manager
+# https://aquaproj.github.io/
+registries:
+  - type: standard
+    ref: v3.157.0 # renovate: depName=aquaproj/aqua-registry
+packages:
+  - name: magefile/[email protected]