feat(build): fluidattacks#1099 licensing builtin with reuse

- Create `testLicense` builtin with reuse. - Add job to dev pipeline Signed-off-by: Robin Quintero <rohaquinlop301@gmail.com>
rohaquinlop · Jun 13, 2023 · de36dbf · de36dbf
1 parent c18b4ab
commit de36dbf
Show file tree

Hide file tree

Showing 10 changed files with 80 additions and 42 deletions.
diff --git a/.github/workflows/dev.yml b/.github/workflows/dev.yml
@@ -194,23 +194,6 @@ jobs:
       - name: /helloWorld
         run: nix-env -if . && m . /helloWorld
 
-  linux_license:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@f095bcc56b7c2baf48f3ac70d6d6782f4f553222
-      - uses: docker://docker.io/nixos/nix@sha256:c3db4c484f6b1ee6c9bb8ca90307cfbeca8ef88156840911356a677eeaff4845
-        name: /license
-        with:
-          set-safe-directory: /github/workspace
-          args: sh -c "nix-env -if . && m . /license"
-  macos_license:
-    runs-on: macos-latest
-    steps:
-      - uses: actions/checkout@f095bcc56b7c2baf48f3ac70d6d6782f4f553222
-      - uses: cachix/install-nix-action@67e9fd765dbe63fabe0ce2bd72f56f9a417696a0
-      - name: /license
-        run: nix-env -if . && m . /license
-
   linux_lintBash:
     runs-on: ubuntu-latest
     steps:
@@ -490,6 +473,23 @@ jobs:
       - name: /taintTerraform/module
         run: nix-env -if . && m . /taintTerraform/module
 
+  linux_testLicense:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@f095bcc56b7c2baf48f3ac70d6d6782f4f553222
+      - uses: docker://docker.io/nixos/nix@sha256:c3db4c484f6b1ee6c9bb8ca90307cfbeca8ef88156840911356a677eeaff4845
+        name: /testLicense
+        with:
+          set-safe-directory: /github/workspace
+          args: sh -c "nix-env -if . && m . /testLicense"
+  macos_testLicense:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@f095bcc56b7c2baf48f3ac70d6d6782f4f553222
+      - uses: cachix/install-nix-action@67e9fd765dbe63fabe0ce2bd72f56f9a417696a0
+      - name: /testLicense
+        run: nix-env -if . && m . /testLicense
+
   linux_testPython_cliMain:
     runs-on: ubuntu-latest
     steps:

diff --git a/.github/workflows/prod.yml b/.github/workflows/prod.yml
@@ -357,27 +357,6 @@ jobs:
         env:
           CACHIX_AUTH_TOKEN: ${{ secrets.CACHIX_AUTH_TOKEN }}
 
-  linux_license:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@f095bcc56b7c2baf48f3ac70d6d6782f4f553222
-      - uses: docker://docker.io/nixos/nix@sha256:c3db4c484f6b1ee6c9bb8ca90307cfbeca8ef88156840911356a677eeaff4845
-        name: /license
-        with:
-          set-safe-directory: /github/workspace
-          args: sh -c "nix-env -if . && m . /license"
-        env:
-          CACHIX_AUTH_TOKEN: ${{ secrets.CACHIX_AUTH_TOKEN }}
-  macos_license:
-    runs-on: macos-latest
-    steps:
-      - uses: actions/checkout@f095bcc56b7c2baf48f3ac70d6d6782f4f553222
-      - uses: cachix/install-nix-action@67e9fd765dbe63fabe0ce2bd72f56f9a417696a0
-      - name: /license
-        run: nix-env -if . && m . /license
-        env:
-          CACHIX_AUTH_TOKEN: ${{ secrets.CACHIX_AUTH_TOKEN }}
-
   linux_lintBash:
     runs-on: ubuntu-latest
     steps:
@@ -721,6 +700,23 @@ jobs:
         env:
           CACHIX_AUTH_TOKEN: ${{ secrets.CACHIX_AUTH_TOKEN }}
 
+  linux_testLicense:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@f095bcc56b7c2baf48f3ac70d6d6782f4f553222
+      - uses: docker://docker.io/nixos/nix@sha256:c3db4c484f6b1ee6c9bb8ca90307cfbeca8ef88156840911356a677eeaff4845
+        name: /testLicense
+        with:
+          set-safe-directory: /github/workspace
+          args: sh -c "nix-env -if . && m . /testLicense"
+  macos_testLicense:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@f095bcc56b7c2baf48f3ac70d6d6782f4f553222
+      - uses: cachix/install-nix-action@67e9fd765dbe63fabe0ce2bd72f56f9a417696a0
+      - name: /testLicense
+        run: nix-env -if . && m . /testLicense
+
   linux_testPython_example:
     runs-on: ubuntu-latest
     steps:

diff --git a/.mailmap b/.mailmap
@@ -19,5 +19,6 @@ John Perez <mrjohnjairo10@gmail.com> John Perez <mrjohnjairo10@gmail.com>
 Kevin Amado <kamadorueda@gmail.com> Kevin Amado <kamadorueda@gmail.com>
 Luis Saavedra <lsaavedra@fluidattacks.com> Luis David Saavedra <40694133+ludsrill@users.noreply.github.com>
 Luis Saavedra <lsaavedra@fluidattacks.com> Luis Saavedra <lsaavedra@fluidattacks.com>
+Robin Hafid <rohaquinlop301@gmail.com> Robin Hafid <rohaquinlop301@gmail.com>
 Robin Quintero <rohaquinlop301@gmail.com> Robin Quintero <rohaquinlop301@gmail.com>
 Timothy DeHerrera <tim.deherrera@iohk.io> Timothy DeHerrera <tim.deherrera@iohk.io>
diff --git a/docs/src/api/builtins/test.md b/docs/src/api/builtins/test.md
@@ -1,3 +1,27 @@
+## testLicense
+
+Test the license of a project using [reuse](https://reuse.software/).
+
+Types:
+
+- testLicense: Empty attribute set.
+
+Example:
+
+=== "makes.nix"
+
+    ```nix
+    {
+      testLicense = {};
+    }
+    ```
+
+=== "Invocation"
+
+    ```bash
+    m . /testLicense
+    ```
+
 ## testPullRequest
 
 Test a pull request

diff --git a/makes.nix b/makes.nix
@@ -252,6 +252,7 @@
       };
     };
   };
+  testLicense = {};
   testPython = {
     example = {
       python = "3.11";

diff --git a/src/args/agnostic.nix b/src/args/agnostic.nix
@@ -107,6 +107,7 @@
     stringCapitalize = import ./string-capitalize/default.nix self;
     sublist = import ./sublist/default.nix self;
     taintTerraform = import ./taint-terraform/default.nix self;
+    testLicense = import ./test-license/default.nix self;
     testTerraform = import ./test-terraform/default.nix self;
     testPullRequest = import ./test-pull-request/default.nix self;
     testPython = import ./test-python/default.nix self;

diff --git a/makes/license/main.nix → src/args/test-license/default.nix b/makes/license/main.nix → src/args/test-license/default.nix
@@ -1,13 +1,13 @@
 {
-  inputs,
+  __nixpkgs__,
   makeScript,
   ...
 }:
 makeScript {
+  name = "test-license";
   entrypoint = ./entrypoint.sh;
-  name = "license";
   searchPaths.bin = [
-    inputs.nixpkgs.git
-    inputs.nixpkgs.reuse
+    __nixpkgs__.git
+    __nixpkgs__.reuse
   ];
 }
diff --git a/makes/license/entrypoint.sh → src/args/test-license/entrypoint.sh b/makes/license/entrypoint.sh → src/args/test-license/entrypoint.sh
diff --git a/src/evaluator/modules/default.nix b/src/evaluator/modules/default.nix
@@ -50,6 +50,7 @@
     (import ./secure-kubernetes-with-rbac-police/default.nix args)
     (import ./secure-python-with-bandit/default.nix args)
     (import ./taint-terraform/default.nix args)
+    (import ./test-license/default.nix args)
     (import ./test-pull-request/default.nix args)
     (import ./test-python/default.nix args)
     (import ./test-terraform/default.nix args)

diff --git a/src/evaluator/modules/test-license/default.nix b/src/evaluator/modules/test-license/default.nix
@@ -0,0 +1,14 @@
+{testLicense, ...}: {
+  config,
+  lib,
+  ...
+}: {
+  options = {
+    testLicense = {};
+  };
+  config = {
+    outputs = {
+      "/testLicense" = testLicense;
+    };
+  };
+}