Repository re-organization to match the domain (#127)

* Rename orchestration to armory The armory application is the monolith containing an orchestration module. * Fix some misc armory naming on Jest and README * Add Armory CI * Rename main module from orchestration to armory * Rename the last armory things * Rename policy engine module to orchestration * Rename authz to policy-engine * Rename authz-shared to policy-engine-shared * Rename CIs * Fix project name, upstream type test, and type test * Fix packages CIs * Fix CI triggers on configuration changes
narval-xyz · Feb 20, 2024 · 1896cb5 · 1896cb5
1 parent 91dbba6
commit 1896cb5
Show file tree

Hide file tree

Showing 337 changed files with 704 additions and 706 deletions.
diff --git a/.github/workflows/orchestration_ci.yml → .github/workflows/armory.yml b/.github/workflows/orchestration_ci.yml → .github/workflows/armory.yml
@@ -1,10 +1,10 @@
-name: '@app/orchestration CI'
+name: '@app/armory CI'
 
 on:
   push:
     paths:
-      - apps/orchestration/**
-      - .github/workflows/orchestration_ci.yml
+      - apps/armory/**
+      - .github/workflows/armory.yml
       - jest.config.ts
       - jest.preset.js
       - .eslintrc.json
@@ -59,42 +59,42 @@ jobs:
       - name: Code format
         shell: bash
         run: |
-          make orchestration/format/check
-          make orchestration/lint/check
+          make armory/format/check
+          make armory/lint/check
 
       - name: Setup database and Prisma types
         shell: bash
         run: |
-          make orchestration/copy-default-env
-          make orchestration/test/db/setup
-          make orchestration/db/generate-types
+          make armory/copy-default-env
+          make armory/test/db/setup
+          make armory/db/generate-types
 
       - name: Test types
         shell: bash
         run: |
-          make orchestration/test/type
+          make armory/test/type
 
       - name: Test unit
         shell: bash
         run: |
-          make orchestration/test/unit
+          make armory/test/unit
 
       - name: Test integration
         shell: bash
         run: |
-          make orchestration/test/integration
+          make armory/test/integration
 
       - name: Test E2E
         shell: bash
         run: |
-          make orchestration/test/e2e
+          make armory/test/e2e
 
       - name: Send Slack notification on failure
         if: failure() && github.ref == 'refs/heads/main'
         uses: 8398a7/action-slack@v3
         with:
           username: GitHub
-          author_name: '@app/orchestration CI failed'
+          author_name: '@app/armory CI failed'
           status: ${{ job.status }}
           fields: message,commit,author
         env:

diff --git a/.github/workflows/authz_shared_ci.yml → .github/workflows/policy-engine-shared.yml b/.github/workflows/authz_shared_ci.yml → .github/workflows/policy-engine-shared.yml
@@ -1,10 +1,10 @@
-name: '@narval/authz-shared CI'
+name: '@narval/policy-engine-shared CI'
 
 on:
   push:
     paths:
-      - packages/authz-shared/**
-      - .github/workflows/authz_shared_ci.yml
+      - packages/policy-engine-shared/**
+      - .github/workflows/policy-engine-shared.yml
       - jest.config.ts
       - jest.preset.js
       - .eslintrc.json
@@ -34,31 +34,31 @@ jobs:
       - name: Code format
         shell: bash
         run: |
-          make authz-shared/format/check
-          make authz-shared/lint/check
+          make policy-engine-shared/format/check
+          make policy-engine-shared/lint/check
 
       - name: Test types
         shell: bash
         run: |
-          make authz-shared/test/type
+          make policy-engine-shared/test/type
 
       - name: Test upstream application types
         shell: bash
         run: |
-          make authz/test/type
-          make orchestration/test/type
+          make policy-engine/test/type
+          make armory/test/type
 
       - name: Test unit
         shell: bash
         run: |
-          make authz-shared/test/unit
+          make policy-engine-shared/test/unit
 
       - name: Send Slack notification on failure
         if: failure() && github.ref == 'refs/heads/main'
         uses: 8398a7/action-slack@v3
         with:
           username: GitHub
-          author_name: '@narval/authz-shared CI failed'
+          author_name: '@narval/policy-engine-shared CI failed'
           status: ${{ job.status }}
           fields: message,commit,author
         env:

diff --git a/.github/workflows/authz_ci.yml → .github/workflows/policy-engine.yml b/.github/workflows/authz_ci.yml → .github/workflows/policy-engine.yml
@@ -1,10 +1,10 @@
-name: '@app/authz CI'
+name: '@app/policy-engine CI'
 
 on:
   push:
     paths:
-      - apps/authz/**
-      - .github/workflows/authz_ci.yml
+      - apps/policy-engine/**
+      - .github/workflows/policy-engine.yml
       - jest.config.ts
       - jest.preset.js
       - .eslintrc.json
@@ -33,40 +33,40 @@ jobs:
       - name: Code format
         shell: bash
         run: |
-          make authz/format/check
-          make authz/lint/check
+          make policy-engine/format/check
+          make policy-engine/lint/check
 
       - name: Setup database and Prisma types
         shell: bash
         run: |
-          make authz/copy-default-env
+          make policy-engine/copy-default-env
 
       - name: Test types
         shell: bash
         run: |
-          make authz/test/type
+          make policy-engine/test/type
 
       - name: Test unit
         shell: bash
         run: |
-          make authz/test/unit
+          make policy-engine/test/unit
 
       - name: Test integration
         shell: bash
         run: |
-          make authz/test/integration
+          make policy-engine/test/integration
 
       - name: Test E2E
         shell: bash
         run: |
-          make authz/test/e2e
+          make policy-engine/test/e2e
 
       - name: Send Slack notification on failure
         if: failure() && github.ref == 'refs/heads/main'
         uses: 8398a7/action-slack@v3
         with:
           username: GitHub
-          author_name: '@app/authz CI failed'
+          author_name: '@app/policy-engine CI failed'
           status: ${{ job.status }}
           fields: message,commit,author
         env:
@@ -87,4 +87,4 @@ jobs:
           version: latest
 
       - name: Run OPA Tests
-        run: make authz/rego/test
+        run: make policy-engine/rego/test
diff --git a/...rkflows/transaction_request_intent_ci.yml → .../workflows/transaction-request-intent.yml b/...rkflows/transaction_request_intent_ci.yml → .../workflows/transaction-request-intent.yml
@@ -4,7 +4,7 @@ on:
   push:
     paths:
       - packages/transaction-request-intent/**
-      - .github/workflows/transaction_request_intent_ci.yml
+      - .github/workflows/transaction-request-intent.yml
       - jest.config.ts
       - jest.preset.js
       - .eslintrc.json
@@ -45,7 +45,7 @@ jobs:
       - name: Test upstream application types
         shell: bash
         run: |
-          make authz/test/type
+          make policy-engine/test/type
 
       - name: Test unit
         shell: bash

diff --git a/Makefile b/Makefile
@@ -1,6 +1,6 @@
-include ./apps/authz/Makefile
-include ./apps/orchestration/Makefile
-include ./packages/authz-shared/Makefile
+include ./apps/armory/Makefile
+include ./apps/policy-engine/Makefile
+include ./packages/policy-engine-shared/Makefile
 include ./packages/transaction-request-intent/Makefile
 
 # For more terminal color codes, head over to https://opensource.com/article/19/9/linux-terminal-colors
@@ -20,12 +20,12 @@ install/ci:
 setup:
 	make install
 	make docker/up
-	make authz/setup
-	make orchestration/setup
+	make armory/setup
+	make policy-engine/setup
 	@echo ""
-	@echo "${TERM_GREEN}🐋 Orchestration & AuthZ applications are ready!${TERM_NO_COLOR}"
+	@echo "${TERM_GREEN}🐋 Armory & Policy Engine applications are ready!${TERM_NO_COLOR}"
 	@echo ""
-	@echo "${TERM_GREEN}Run 'make orchestration/start/dev' or/and 'make authz/start/dev' to get them running.${TERM_NO_COLOR}"
+	@echo "${TERM_GREEN}Run 'make armory/start/dev' or/and 'make policy-engine/start/dev' to get them running.${TERM_NO_COLOR}"
 
 # == Docker ==
 

diff --git a/README.md b/README.md
@@ -3,10 +3,10 @@
 </p>
 <p align="center">Narval is the most advanced and secure authorization stack for web3.</p>
 <p align="center">
-<a href="https://github.com/narval-xyz/narval/actions/workflows/orchestration_ci.yml" target="_blank"><img src="https://github.com/narval-xyz/narval/actions/workflows/orchestration_ci.yml/badge.svg?branch=main" alt="@app/orchestration" /></a>
-<a href="https://github.com/narval-xyz/narval/actions/workflows/authz_ci.yml" target="_blank"><img src="https://github.com/narval-xyz/narval/actions/workflows/authz_ci.yml/badge.svg?branch=main" alt="@app/authz" /></a>
-<a href="https://github.com/narval-xyz/narval/actions/workflows/transaction_request_intent_ci.yml" target="_blank"><img src="https://github.com/narval-xyz/narval/actions/workflows/transaction_request_intent_ci.yml/badge.svg?branch=main" alt="@narval/transaction-request-intent" /></a>
-<a href="https://github.com/narval-xyz/narval/actions/workflows/authz_shared_ci.yml" target="_blank"><img src="https://github.com/narval-xyz/narval/actions/workflows/authz_shared_ci.yml/badge.svg?branch=main" alt="@narval/transaction-request-intent" /></a>
+<a href="https://github.com/narval-xyz/narval/actions/workflows/armory.yml" target="_blank"><img src="https://github.com/narval-xyz/narval/actions/workflows/armory.yml/badge.svg?branch=main" alt="@app/armory" /></a>
+<a href="https://github.com/narval-xyz/narval/actions/workflows/policy-engine.yml" target="_blank"><img src="https://github.com/narval-xyz/narval/actions/workflows/policy-engine.yml/badge.svg?branch=main" alt="@app/policy-engine" /></a>
+<a href="https://github.com/narval-xyz/narval/actions/workflows/transaction-request-intent.yml" target="_blank"><img src="https://github.com/narval-xyz/narval/actions/workflows/transaction-request-intent.yml/badge.svg?branch=main" alt="@narval/transaction-request-intent" /></a>
+<a href="https://github.com/narval-xyz/narval/actions/workflows/policy-engine-shared.yml" target="_blank"><img src="https://github.com/narval-xyz/narval/actions/workflows/policy-engine-shared.yml/badge.svg?branch=main" alt="@narval/transaction-request-intent" /></a>
 </p>
 
 ## Description
@@ -27,9 +27,9 @@ At the end, you must have a working environment ready to run any application.
 
 ## Project
 
-- [@app/authz](./apps/authz/README.md)
-- [@app/orchestration](./apps/orchestration/README.md)
-- [@narval/authz-shared](./packages/authz-shared/README.md)
+- [@app/armory](./apps/armory/README.md)
+- [@app/policy-engine](./apps/policy-engine/README.md)
+- [@narval/policy-engine-shared](./packages/policy-engine-shared/README.md)
 - [@narval/transaction-request-intent](./packages/transaction-request-intent/README.md)
 
 ## Docker

diff --git a/apps/orchestration/.env.default → apps/armory/.env.default b/apps/orchestration/.env.default → apps/armory/.env.default
@@ -2,7 +2,7 @@ NODE_ENV=development
 
 PORT=3005
 
-ORCHESTRATION_DATABASE_URL="postgresql://postgres:postgres@localhost:5432/orchestration?schema=public"
+ARMORY_DATABASE_URL="postgresql://postgres:postgres@localhost:5432/armory?schema=public"
 
 REDIS_HOST=localhost
 REDIS_PORT=6379

diff --git a/apps/armory/.env.test.default b/apps/armory/.env.test.default
@@ -0,0 +1,6 @@
+# IMPORTANT: The variables defined here will override other variables.
+# See `./apps/armory/jest.setup.ts`.
+
+NODE_ENV=test
+
+ARMORY_DATABASE_URL="postgresql://postgres:postgres@localhost:5432/armory_test?schema=public"
diff --git a/apps/authz/.eslintrc.json → apps/armory/.eslintrc.json b/apps/authz/.eslintrc.json → apps/armory/.eslintrc.json