Merge pull request #2 from MGTheTrain/opt/refine-architecture

Opt/refine architecture
MGTheTrain · Nov 12, 2024 · 7dad0e0 · 7dad0e0
2 parents afeeeee + a306a78
commit 7dad0e0
Show file tree

Hide file tree

Showing 41 changed files with 51 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - **Asymmetric encryption and decryption**: Supported RSA and other asymmetric encryption algorithms for data protection.
 - **Symmetric encryption**: Supported symmetric key encryption (e.g. AES) for data protection.
 - **Hashing and signature verification**: Supported hashing algorithms (e.g. SHA-256, SHA-512) and verified signatures using asymmetric keys (RSA, ECDSA, etc.).
+- Adopted Domain-Driven Design to create a **modular, flexible and maintainable** project structure with a focus on the **domain at its core**
 
 ## [0.1.0] - TBD-TBD-TBD
 

diff --git a/cmd/crypto-vault-cli/crypto-vault-cli.go b/cmd/crypto-vault-cli/crypto-vault-cli.go
@@ -13,7 +13,7 @@ import (
 
 	"github.com/spf13/cobra"
 
-	cryptography "crypto_vault_service/pkg/cryptography"
+	cryptography "crypto_vault_service/internal/infrastructure/cryptography"
 )
 
 // Encrypts a file using AES and saves the encryption key

diff --git a/cmd/crypto-vault-service/crypto-vault-service.go b/cmd/crypto-vault-service/crypto-vault-service.go
@@ -1,7 +1,7 @@
 package main
 
 import (
-	v1 "crypto_vault_service/api/v1"
+	v1 "crypto_vault_service/internal/api/v1"
 
 	"github.com/gin-gonic/gin"
 )

diff --git a/docs/architecture-decision-record/ddd.md b/docs/architecture-decision-record/ddd.md
@@ -0,0 +1,39 @@
+# Domain-driven Design
+
+Incorporating DDD as an architecture decision impacts the structure and development process of the entire application. By aligning the software architecture with the business domain, we promote a more **modular, flexible and maintainable** design. The goal is to deeply understand the domain, represent it through domain models and ensure that the application closely matches the business processes.
+
+```sh
+.
+├── cmd
+│   ├── crypto-vault-cli
+│       ├── Dockerfile
+│       ├── crypto-vault-cli.go
+│   └── crypto-vault-service
+│       ├── Dockerfile
+│       └── crypto-vault-service.go
+├── configs
+│   ├── dev.yml
+│   ├── prd.yml
+│   └── qas.yml
+├── go.mod
+├── go.sum
+├── internal
+│   ├── api
+│   │   └── v1
+│   │   └── v2
+│   │   └── ...
+│   ├── app
+│   ├── domain
+│   ├── infrastructure
+│   └── persistence
+└── test
+    ├── data
+    ├── integration
+    │   ├── domain
+    │   ├── infrastructure
+    │   └── persistence
+    └── unit
+        ├── domain
+        ├── infrastructure
+        └── persistence
+```
diff --git a/api/v1/errors.go → internal/api/v1/errors.go b/api/v1/errors.go → internal/api/v1/errors.go
diff --git a/api/v1/handlers.go → internal/api/v1/handlers.go b/api/v1/handlers.go → internal/api/v1/handlers.go
diff --git a/api/v1/middleware.go → internal/api/v1/middleware.go b/api/v1/middleware.go → internal/api/v1/middleware.go
diff --git a/api/v1/models.go → internal/api/v1/models.go b/api/v1/models.go → internal/api/v1/models.go
diff --git a/api/v1/responses.go → internal/api/v1/responses.go b/api/v1/responses.go → internal/api/v1/responses.go
diff --git a/api/v1/routes.go → internal/api/v1/routes.go b/api/v1/routes.go → internal/api/v1/routes.go
diff --git a/api/v1/utils.go → internal/api/v1/utils.go b/api/v1/utils.go → internal/api/v1/utils.go
diff --git a/api/v1/version.go → internal/api/v1/version.go b/api/v1/version.go → internal/api/v1/version.go
diff --git a/internal/app/.gitkeep b/internal/app/.gitkeep
@@ -0,0 +1 @@
+Service impl
diff --git a/internal/domain/.gitkeep b/internal/domain/.gitkeep
@@ -0,0 +1 @@
+Domain models, service contracts 
diff --git a/pkg/storage/az_blob.go → internal/infrastructure/connector/az_blob.go b/pkg/storage/az_blob.go → internal/infrastructure/connector/az_blob.go
diff --git a/pkg/storage/az_postgres.go → ...l/infrastructure/connector/az_postgres.go b/pkg/storage/az_postgres.go → ...l/infrastructure/connector/az_postgres.go
diff --git a/pkg/storage/az_vault.go → ...rnal/infrastructure/connector/az_vault.go b/pkg/storage/az_vault.go → ...rnal/infrastructure/connector/az_vault.go
diff --git a/pkg/cryptography/aes.go → internal/infrastructure/cryptography/aes.go b/pkg/cryptography/aes.go → internal/infrastructure/cryptography/aes.go
diff --git a/pkg/cryptography/ecdsa.go → ...rnal/infrastructure/cryptography/ecdsa.go b/pkg/cryptography/ecdsa.go → ...rnal/infrastructure/cryptography/ecdsa.go
diff --git a/pkg/cryptography/io.go → internal/infrastructure/cryptography/io.go b/pkg/cryptography/io.go → internal/infrastructure/cryptography/io.go
diff --git a/pkg/cryptography/rsa.go → internal/infrastructure/cryptography/rsa.go b/pkg/cryptography/rsa.go → internal/infrastructure/cryptography/rsa.go
diff --git a/internal/persistence/.gitkeep b/internal/persistence/.gitkeep
@@ -0,0 +1 @@
+SQL, NoSQL queries or commands
diff --git a/tests/data/.gitignore → test/data/.gitignore b/tests/data/.gitignore → test/data/.gitignore
diff --git a/test/integration/domain/.gitkeep b/test/integration/domain/.gitkeep
@@ -0,0 +1 @@
+Domain models, service contracts 
diff --git a/...integration-tests/storage/az_blob_test.go → .../infrastructure/connector/az_blob_test.go b/...integration-tests/storage/az_blob_test.go → .../infrastructure/connector/az_blob_test.go
diff --git a/...gration-tests/storage/az_postgres_test.go → ...rastructure/connector/az_postgres_test.go b/...gration-tests/storage/az_postgres_test.go → ...rastructure/connector/az_postgres_test.go
diff --git a/...ntegration-tests/storage/az_vault_test.go → ...infrastructure/connector/az_vault_test.go b/...ntegration-tests/storage/az_vault_test.go → ...infrastructure/connector/az_vault_test.go
diff --git a/test/integration/infrastructure/cryptography/aes_test.go b/test/integration/infrastructure/cryptography/aes_test.go
@@ -0,0 +1 @@
+// tbd
diff --git a/...ion-tests/cryptography/encryption_test.go → ...infrastructure/cryptography/ecdsa_test.go b/...ion-tests/cryptography/encryption_test.go → ...infrastructure/cryptography/ecdsa_test.go
diff --git a/...ration-tests/cryptography/hashing_test.go → ...on/infrastructure/cryptography/io_test.go b/...ration-tests/cryptography/hashing_test.go → ...on/infrastructure/cryptography/io_test.go
diff --git a/...nit-tests/cryptography/encryption_test.go → ...n/infrastructure/cryptography/rsa_test.go b/...nit-tests/cryptography/encryption_test.go → ...n/infrastructure/cryptography/rsa_test.go
diff --git a/test/integration/persistence/.gitkeep b/test/integration/persistence/.gitkeep
@@ -0,0 +1 @@
+Domain models, service contracts 
diff --git a/test/unit/domain/.gitkeep b/test/unit/domain/.gitkeep
@@ -0,0 +1 @@
+Domain models, service contracts 
diff --git a/tests/unit-tests/storage/az_blob_test.go → .../infrastructure/connector/az_blob_test.go b/tests/unit-tests/storage/az_blob_test.go → .../infrastructure/connector/az_blob_test.go
diff --git a/tests/unit-tests/storage/az_postgres_test.go → ...rastructure/connector/az_postgres_test.go b/tests/unit-tests/storage/az_postgres_test.go → ...rastructure/connector/az_postgres_test.go
diff --git a/tests/unit-tests/storage/az_vault_test.go → ...infrastructure/connector/az_vault_test.go b/tests/unit-tests/storage/az_vault_test.go → ...infrastructure/connector/az_vault_test.go
diff --git a/test/unit/infrastructure/cryptography/aes_test.go b/test/unit/infrastructure/cryptography/aes_test.go
@@ -0,0 +1 @@
+// tbd
diff --git a/...s/unit-tests/cryptography/hashing_test.go → ...infrastructure/cryptography/ecdsa_test.go b/...s/unit-tests/cryptography/hashing_test.go → ...infrastructure/cryptography/ecdsa_test.go
diff --git a/test/unit/infrastructure/cryptography/io_test.go b/test/unit/infrastructure/cryptography/io_test.go
diff --git a/test/unit/infrastructure/cryptography/rsa_test.go b/test/unit/infrastructure/cryptography/rsa_test.go
diff --git a/test/unit/persistence/.gitkeep b/test/unit/persistence/.gitkeep
@@ -0,0 +1 @@
+Domain models, service contracts