Fix: fix schema validation script. Fixes for renaming repo.

Author: vedharish

CONTRIBUTING.md

@@ -17,7 +17,7 @@ Scan through our existing issues to find one that interests you. You can narrow
 
 ## Did you write a patch that fixes a bug or adds functionality?
 - Commit the changes once you are happy with them. Always write a clear log message for your commits.
-  - For commit message we follow [Conventional Commit Message Guideline](https://www.conventionalcommits.org). To enforce this we use [pre-commit](https://pre-commit.com), to setup the same go through [pre-commit setup section of the README](https://github.com/browserstack/enigma-public-central#for-contributing-code)
+  - For commit message we follow [Conventional Commit Message Guideline](https://www.conventionalcommits.org). To enforce this we use [pre-commit](https://pre-commit.com), to setup the same go through [pre-commit setup section of the README](https://github.com/browserstack/enigma#for-contributing-code)
   - Make sure there are no lint issues, check lint issues by running `make lint`. If there are some in the portion which you have touched, fix those lint issues.
   - If you are making changes to config then please update [schema.json file](schema.json) also.
   - We use [semgrep](https://semgrep.dev) for static code analysis and finding vulnerabilities. To check issues locally run `make run_semgrep`.

Makefile

@@ -76,8 +76,17 @@ lint: lint_issues
 	@python3 -m pylama --version
 	@pylama -r lint_issues || echo "Linter run returned errors. Check lint_issues file for details." && false
 
-schema_validate:
-	@echo $(shell python3 scripts/clone_access_modules.py && python3 scripts/validator.py)
+.PHONY: schema_validate
+schema_validate: export APPUID = $(APP_UID)
+schema_validate: setup_mounts ensure_web_container_for_test
+	@echo "Validating Schema"
+	@docker exec dev python scripts/validator.py
+	@if [ "$$?" -ne 0 ]; then \
+		echo "Schema validation failed"; \
+		exit 1; \
+	else \
+	  echo "Schema validation passed"; \
+	fi
 
 run_semgrep:
 	$(shell semgrep --error --config "p/cwe-top-25" --config "p/r2c-security-audit")

README.md

@@ -5,7 +5,7 @@
 This tool consists of 2 different components: a central webserver and pluggable access modules.
 
 This repo is the code-base for the central webserver.
-Refer to [this](https://github.com/browserstack/enigma-public-access-modules) for published access modules with this tool.
+Refer to [this](https://github.com/browserstack/enigma-access-modules) for published access modules with this tool.
 
 Refer to [this doc](/docs/%E2%80%9CHow-to%E2%80%9D%20guides/Adding%20Modules.md) on how to create custom access modules
 
@@ -24,7 +24,7 @@ If you don't have docker setup, follow the guidelines [here](https://docs.docker
 
 1. Ensure you have a valid `config.json` present locally.
 
-The default [config.json.sample](https://github.com/browserstack/enigma-public-central/blob/main/config.json.sample) should be sufficient to start.
+The default [config.json.sample](https://github.com/browserstack/enigma/blob/main/config.json.sample) should be sufficient to start.
 
 You can then add module-specific configuration for the modules you want integrated with Enigma.
 For detailed instructions on configuration, follow [this doc](/docs/Configuration%20Guide.md)

config.json.sample

@@ -25,7 +25,7 @@
   },
   "access_modules": {
     "git_urls": [
-      "https://github.com/browserstack/enigma-public-access-modules.git"
+      "https://github.com/browserstack/enigma-access-modules.git"
     ],
     "RETRY_LIMIT": 5
   },

docs/Configuration Guide.md

@@ -17,7 +17,7 @@ database.username | "" (Empty string) | `String` The username to use when connec
 database.password | "" (Empty string) | `String` The password to use when connecting to the database. *Not used with SQLite.*
 database.host | "" (Empty string) | `String` The host to use when connecting to the database. *Not used with SQLite.*
 database.port | | `Integer` The port to use when connecting to the database. *Not used with SQLite.*
-access_modules.git_urls | ["https://github.com/browserstack/enigma-public-access-modules.git"] (Enigma's Access Module Repository)| `Array` List of Git URLs of access modules, these URLs are fed to the cloning script to pull the modules into the running container.
+access_modules.git_urls | ["https://github.com/browserstack/enigma-access-modules.git"] (Enigma's Access Module Repository)| `Array` List of Git URLs of access modules, these URLs are fed to the cloning script to pull the modules into the running container.
 access_modules.RETRY_LIMIT | 5 | `Integer` Maximum number of tries to clone the access modules repository
 enigmaGroup.MAIL_APPROVER_GROUPS | [] (Empty list) | `Array` List of approvers Email for managing groups.
 email.access-approve | "" (Empty string) | `String` Admin access approver's email address

docs/https-nginx-setup.md

@@ -5,7 +5,7 @@ Following are the steps to Setup Nginx in enigma
 1. **Pre-requisistes** 
     - Should have a host(domain) with ssl certificats that can be attached to nginx.
     - Make sure the host points the public IP of the machine in which enigma is running on. (i.e., create an dns A record with host pointing to public IP of machine)
-2. Create a folder in the root folder of enigma-public-central named `certs` which contains ssl certificate and key.
+2. Create a folder in the root folder of enigma named `certs` which contains ssl certificate and key.
 3. Copy `nginx.conf.sample` file to `nginx.conf`
 3. Configure `nginx.conf` file.
     - update the hostname in the `nginx.conf` file
@@ -39,7 +39,7 @@ Following are the steps to Setup Nginx in enigma
       ```
       The above mentioned changes are just examples to show what needs to be changed, Please add your own certificate and key file names.
 
-4. Run the following command with your terminal in enigma-public-central root folder.
+4. Run the following command with your terminal in enigma root folder.
     ```
     docker run --name enigma-nginx -v <absolute_path to nginx.conf file>:/etc/nginx/nginx.conf:ro \
     -v <absolute_path to certs folder>:/certs -p 80:80 -p 443:443 -d --add-host host.docker.internal:host-gateway nginx:latest

docs/one-click-dev.md

@@ -23,13 +23,13 @@ colima start
 ### Clone Repository
 Clone the repo in local system
 ```bash
-git clone https://github.com/browserstack/enigma-public-central.git
+git clone https://github.com/browserstack/enigma.git
 ```
 - copy config.json.sample to config.json
 
 #### For private repo in git_urls in `config.json`
 ```bash
- "https://<git-username>:<github-token>@github.com/browserstack/enigma-public-access-modules.git"
+ "https://<git-username>:<github-token>@github.com/browserstack/enigma-access-modules.git"
 ```
 where `github-token` is a pat token from https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
 

docs/“How-to” guides/Adding Modules.md

@@ -14,7 +14,7 @@ Enigma provides the following modules as part of its default settings, these can
 
 ## Creating custom access modules
 
-When a new resource is required, it's corresponding module has to be added in [Engima's modules repository](https://github.com/browserstack/enigma-public-access-modules.git) or a new dedicated repo (as per the usecase):
+When a new resource is required, it's corresponding module has to be added in [Engima's modules repository](https://github.com/browserstack/enigma-access-modules.git) or a new dedicated repo (as per the usecase):
 
 - Add `__init__.py`:
 
@@ -39,7 +39,7 @@ When a new resource is required, it's corresponding module has to be added in [E
     ```
 - Implement `approve` and `revoke` functions to implement respective functionalities.
 
-Refer to [Engima Access Modules](https://github.com/browserstack/enigma-public-access-modules.git) for further understanding of the default implementations and file structure.
+Refer to [Engima Access Modules](https://github.com/browserstack/enigma-access-modules.git) for further understanding of the default implementations and file structure.
 
 Once the implementation is in place, the module needs to be integrated with the central code.
 Refer to [Integrations doc](/docs/%E2%80%9CHow-to%E2%80%9D%20guides/Integrating%20Modules.md) for further steps.

docs/“How-to” guides/Integrating Modules.md

@@ -5,15 +5,15 @@ For every new access modules repository, the following settings have to be added
 ```bash
 "access_modules": {
     "git_urls": [
-      "https://github.com/browserstack/enigma-public-access-modules.git",
+      "https://github.com/browserstack/enigma-access-modules.git",
       "https://github-new-access-module.git"
     ],
     ....
 }
 ```
 ### For private repos:
 ```bash
- "https://<git-username>:<github-token>@github.com/browserstack/enigma-public-access-modules.git"
+ "https://<git-username>:<github-token>@github.com/browserstack/enigma-access-modules.git"
 ```
 where github-token is a [PAT Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
 
@@ -52,5 +52,5 @@ The added URLs will be integrated by the cloning script `scripts/clone_access_mo
 - Once the function is overridden admin can now create a permission with the label and then assign user that permission (learn more about adding permission is Adding Permissions Section). And the user will be asked for the secondary approver for a request.
 
 #### Disabling Access module
-- For one click setup it clone all the access modules from the `enigma-public-access-modules` repo. So in the UI you can see all the access modules.
+- For one click setup it clone all the access modules from the `enigma-access-modules` repo. So in the UI you can see all the access modules.
 - Which can be disabled by removing the non required access moduled folder from `Access/access_modules` path.

docs/“How-to” guides/Running Tests.md

@@ -1,6 +1,6 @@
 # Running Unit Tests
 
-To run all tests in the code-base, run the following on the root directory for `enigma-public-central`
+To run all tests in the code-base, run the following on the root directory for `enigma`
 
 ```bash
 make test