feat: configurable external fga server

openfga · May 15, 2024 · ff842f5 · ff842f5
1 parent bbdc3f5
commit ff842f5
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 19 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,5 @@
+
+
+# IntelliJ IDEA
+.idea
+*.iml
diff --git a/README.md b/README.md
@@ -1,22 +1,22 @@
 # OpenFGA Github Action - Test
-[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fopenfga%2Faction-openfga-test.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenfga%2Faction-openfga-test?ref=badge_shield)
 
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fopenfga%2Faction-openfga-test.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenfga%2Faction-openfga-test?ref=badge_shield)
 
 This action can be used to test your authorization model using store test files.
 
 ## Parameter
 
-| Parameter            | Description                                                                      | Required | Default      |
-|----------------------|----------------------------------------------------------------------------------|----------|--------------|
-| `test_path`          | The path to your store test file or folder relative to the root of your project. | No       | `.`          |
-| `test_files_pattern` | The pattern to match test files.                                                 | No       | `*.fga.yaml` |
+| Parameter            | Description                                                                                                                                                   | Required | Default      |
+|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|--------------|
+| `test_path`          | The path to your store test file or folder relative to the root of your project.                                                                              | No       | `.`          |
+| `test_files_pattern` | The pattern to match test files.                                                                                                                              | No       | `*.fga.yaml` |
+| `fga_server_url`     | The OpenFGA server to test the Authorization Model against. If empty (which is the default value), the tests are run using the cli built-in OpenFGA instance. | No       | _empty_      |
+| `fga_api_token`      | The api token to use for testing against an OpenFGA server. Ignored if `fga_server_url` is not provided.                                                      | No       | _empty_      |
 
 > Note: the action will fail if no test is found in the specified test path with the given pattern
 
-
 ## Examples
 
-
 ### Running tests of `*.fga.yaml` files present in the repository
 
 ```yaml
@@ -69,6 +69,6 @@ jobs:
           test_path: example/model.fga.yaml
 ```
 
-
 ## License
+
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fopenfga%2Faction-openfga-test.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenfga%2Faction-openfga-test?ref=badge_large)
diff --git a/action.yml b/action.yml
@@ -13,6 +13,15 @@ inputs:
     description: 'Pattern to match the test files'
     required: false
     default: '*.fga.yaml'
+  fga_server_url:
+    description: 'The OpenFGA server to test the Authorization Model against. If not provided, the tests will be run using the cli built-in OpenFGA instance.'
+    required: false
+    default: ''
+  fga_api_token:
+    description: 'The api token to use for testing against an OpenFGA server. Ignored if fga_server_url is not provided.'
+    required: false
+    default: ''
+
 
 runs:
   using: composite
@@ -24,15 +33,23 @@ runs:
         cache: enable
     - name: Run OpenFGA CLI
       shell: bash
+      env:
+        FGA_SERVER_URL: ${{ inputs.fga_server_url }}
+        FGA_API_TOKEN: ${{ inputs.fga_api_token }}
       run: |
-          while IFS= read -r -d '' test_file
-          do
-            ((test_files_count+=1))
-            echo "Running FGA test file ${test_file}"
-            fga model test --tests "${test_file}"
-          done <   <(find ${{ inputs.test_path }} -name "${{ inputs.test_files_pattern }}" -print0)
-  
-          if [[ ${test_files_count} -eq 0 ]]; then
-            echo "No FGA test file found for path '${{ inputs.test_path }}' and pattern '${{ inputs.test_files_pattern }}'"
-            exit 1
-          fi
+        fga_opts=""
+        if [[ -n "${FGA_SERVER_URL}" ]]; then
+          fga_opts="--api-url ${FGA_SERVER_URL} ${FGA_API_TOKEN:+--api-token ${FGA_API_TOKEN}}"
+        fi
+        
+        while IFS= read -r -d '' test_file
+        do
+          ((test_files_count+=1))
+          echo "Running FGA test file ${test_file}"
+          fga model test ${fga_opts} --tests "${test_file}"
+        done <   <(find ${{ inputs.test_path }} -name "${{ inputs.test_files_pattern }}" -print0)
+        
+        if [[ ${test_files_count} -eq 0 ]]; then
+          echo "No FGA test file found for path '${{ inputs.test_path }}' and pattern '${{ inputs.test_files_pattern }}'"
+          exit 1
+        fi