chore: update variable names

Signed-off-by: Arjun Raja Yogidas <[email protected]>

Author: coderbirju

.github/workflows/ci.yaml

@@ -116,6 +116,6 @@ jobs:
       - name: Set Rego file path
         run: echo "REGO_FILE_PATH=${{ github.workspace }}/sample.rego" >> $GITHUB_ENV
       - name: Start finch-daemon with opa Authz
-        run: sudo bin/finch-daemon --debug --enable-opa --rego-file ${{ github.workspace }}/sample.rego --socket-owner $UID &
+        run: sudo bin/finch-daemon --debug --enable-middleware --rego-file ${{ github.workspace }}/sample.rego --socket-owner $UID &
       - name: Run opa e2e tests
         run: sudo -E make test-e2e-opa

Makefile

@@ -118,7 +118,7 @@ test-e2e: linux
 test-e2e-opa: linux
 	DOCKER_HOST="unix:///run/finch.sock" \
 	DOCKER_API_VERSION="v1.43" \
-	OPA_E2E=1 \
+	MIDDLEWARE_E2E=1 \
 	TEST_E2E=1 \
 	$(GINKGO) $(GFLAGS) ./e2e/...
 

cmd/finch-daemon/main.go

@@ -43,15 +43,15 @@ const (
 )
 
 type DaemonOptions struct {
-	debug        bool
-	socketAddr   string
-	socketOwner  int
-	debugAddress string
-	configPath   string
-	pidFile      string
-	regoFilePath string
-	enableOpa    bool
-	regoFileLock *flock.Flock
+	debug            bool
+	socketAddr       string
+	socketOwner      int
+	debugAddress     string
+	configPath       string
+	pidFile          string
+	regoFilePath     string
+	enableMiddleware bool
+	regoFileLock     *flock.Flock
 }
 
 var options = new(DaemonOptions)
@@ -71,7 +71,7 @@ func main() {
 	rootCmd.Flags().StringVar(&options.configPath, "config-file", defaultConfigPath, "Daemon Config Path")
 	rootCmd.Flags().StringVar(&options.pidFile, "pidfile", defaultPidFile, "pid file location")
 	rootCmd.Flags().StringVar(&options.regoFilePath, "rego-file", "", "Rego Policy Path")
-	rootCmd.Flags().BoolVar(&options.enableOpa, "enable-opa", false, "turn on opa allowlisting")
+	rootCmd.Flags().BoolVar(&options.enableMiddleware, "enable-middleware", false, "turn on middleware for allowlisting")
 	if err := rootCmd.Execute(); err != nil {
 		log.Printf("got error: %v", err)
 		log.Fatal(err)
@@ -236,7 +236,7 @@ func newRouter(options *DaemonOptions, logger *flog.Logrus) (http.Handler, error
 	}
 
 	var regoFilePath string
-	if options.enableOpa {
+	if options.enableMiddleware {
 		regoFilePath, err = sanitizeRegoFile(options)
 		if err != nil {
 			return nil, err
@@ -319,16 +319,16 @@ func checkRegoFileValidity(filePath string) error {
 // and sets rego file to be read-only.
 func sanitizeRegoFile(options *DaemonOptions) (string, error) {
 	if options.regoFilePath != "" {
-		if !options.enableOpa {
-			return "", fmt.Errorf("rego file path was provided without the --enable-opa flag, please provide the --enable-opa flag") // todo, can we default to setting this flag ourselves is this better UX?
+		if !options.enableMiddleware {
+			return "", fmt.Errorf("rego file path was provided without the --enable-middleware flag, please provide the --enable-middleware flag") // todo, can we default to setting this flag ourselves is this better UX?
 		}
 
 		if err := checkRegoFileValidity(options.regoFilePath); err != nil {
 			return "", err
 		}
 	}
 
-	if options.enableOpa && options.regoFilePath == "" {
+	if options.enableMiddleware && options.regoFilePath == "" {
 		return "", fmt.Errorf("rego file path not provided, please provide the policy file path using the --rego-file flag")
 	}
 

docs/opa-middleware.md

@@ -34,9 +34,9 @@ Use the [Rego playground](https://play.openpolicyagent.org/) to fine tune your r
 
 ## Enable OPA Middleware
 
-Once you are ready with your policy document, use the `--enable-opa` flag to tell the finch-daemon to enable the OPA middleware. The daemon will then look for the policy document provided by the `--rego-file` flag.
+Once you are ready with your policy document, use the `--enable-middleware` flag to tell the finch-daemon to enable the OPA middleware. The daemon will then look for the policy document provided by the `--rego-file` flag.
 
-Note: The `--rego-file` flag is required when `--enable-opa` is set.
+Note: The `--rego-file` flag is required when `--enable-middleware` is set.
 
 Example: 
-`sudo bin/finch-daemon --debug --socket-owner $UID --socket-addr /run/finch-test.sock --pidfile /run/finch-test.pid --enable-opa --rego-file /<path-to>/finch-daemon/sample.rego &`
+`sudo bin/finch-daemon --debug --socket-owner $UID --socket-addr /run/finch-test.sock --pidfile /run/finch-test.pid --enable-middleware --rego-file /<path-to>/finch-daemon/sample.rego &`

e2e/e2e_test.go

@@ -26,12 +26,12 @@ var SubjectPrefix = flag.String("daemon-context-subject-prefix", "", `A string w
 var PrefixedSubjectEnv = flag.String("daemon-context-subject-env", "", `Environment to add when running a prefixed subject, in the form of a string like "EXAMPLE=foo EXAMPLE2=bar"`)
 
 func TestRun(t *testing.T) {
-	if os.Getenv("OPA_E2E") == "1" {
+	if os.Getenv("MIDDLEWARE_E2E") == "1" {
 		runOPATests(t)
 	} else if os.Getenv("TEST_E2E") == "1" {
 		runE2ETests(t)
 	} else {
-		t.Skip("E2E tests skipped. Set TEST_E2E=1 to run regular E2E tests or OPA_E2E=1 to run OPA middleware tests")
+		t.Skip("E2E tests skipped. Set TEST_E2E=1 to run regular E2E tests or MIDDLEWARE_E2E=1 to run OPA middleware tests")
 	}
 
 	if err := parseTestFlags(); err != nil {