ci: refactor

- support tests directory
- enable doc generation sorting

Signed-off-by: thxCode <thxcode0824@gmail.com>

Author: thxCode

.terraform-docs.yml

@@ -24,4 +24,4 @@ settings:
   type: true
 
 sort:
-  enabled: false
+  enabled: true

Makefile

@@ -18,16 +18,16 @@ help:
 	# Usage:
 	#
 	#   * [dev] `make generate`, generate README file.
-	#           - `make generate examples/standalone` only generate docs and schema under examples/standalone directory.
-        #           - `make generate docs examples/standalone` only generate README file under examples/standalone directory.
-        #           - `make generate schema examples/standalone` only generate schema.yaml under examples/standalone directory.
+	#           - `make generate examples/hello-world` only generate docs and schema under examples/hello-world directory.
+	#           - `make generate docs examples/hello-world` only generate README file under examples/hello-world directory.
+	#           - `make generate schema examples/hello-world` only generate schema.yaml under examples/hello-world directory.
 	#
 	#   * [dev] `make lint`, check style and security.
 	#           - `LINT_DIRTY=true make lint` verify whether the code tree is dirty.
-	#           - `make lint examples/standalone` only verify the code under examples/standalone directory.
+	#           - `make lint examples/hello-world` only verify the code under examples/hello-world directory.
 	#
 	#   * [dev] `make test`, execute unit testing.
-	#           - `make test example/standalone` only test the code under examples/standalone directory.
+	#           - `make test examples/hello-world` only test the code under examples/hello-world directory.
 	#
 	#   * [ci]  `make ci`, execute `make generate`, `make lint` and `make test`.
 	#

README.md

@@ -74,29 +74,29 @@ No modules.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_context"></a> [context](#input\_context) | Receive contextual information. When Walrus deploys, Walrus will inject specific contextual information into this field.<br><br>Examples:<pre>context:<br>  project:<br>    name: string<br>    id: string<br>  environment:<br>    name: string<br>    id: string<br>  resource:<br>    name: string<br>    id: string</pre> | `map(any)` | `{}` | no |
-| <a name="input_infrastructure"></a> [infrastructure](#input\_infrastructure) | Specify the infrastructure information for deploying.<br><br>Examples:<pre>infrastructure:<br>  vpc_id: string                       # the ID of the VPC where the Redis service applies<br>  kms_key_id: string, optional         # the ID of the KMS key which to encrypt the Redis data<br>  domain_suffix: string, optional      # a private DNS namespace of the CloudMap where to register the applied Redis service</pre> | <pre>object({<br>    vpc_id        = string<br>    kms_key_id    = optional(string)<br>    domain_suffix = optional(string)<br>  })</pre> | n/a | yes |
 | <a name="input_architecture"></a> [architecture](#input\_architecture) | Specify the deployment architecture, select from standalone or replication. | `string` | `"standalone"` | no |
-| <a name="input_replication_readonly_replicas"></a> [replication\_readonly\_replicas](#input\_replication\_readonly\_replicas) | Specify the number of read-only replicas under the replication deployment. | `number` | `1` | no |
-| <a name="input_engine_version"></a> [engine\_version](#input\_engine\_version) | Specify the deployment engine version. | `string` | `"7.0"` | no |
+| <a name="input_context"></a> [context](#input\_context) | Receive contextual information. When Walrus deploys, Walrus will inject specific contextual information into this field.<br><br>Examples:<pre>context:<br>  project:<br>    name: string<br>    id: string<br>  environment:<br>    name: string<br>    id: string<br>  resource:<br>    name: string<br>    id: string</pre> | `map(any)` | `{}` | no |
 | <a name="input_engine_parameters"></a> [engine\_parameters](#input\_engine\_parameters) | Specify the deployment parameters, see https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.Redis.html. | <pre>list(object({<br>    name  = string<br>    value = string<br>  }))</pre> | `[]` | no |
+| <a name="input_engine_version"></a> [engine\_version](#input\_engine\_version) | Specify the deployment engine version. | `string` | `"7.0"` | no |
+| <a name="input_infrastructure"></a> [infrastructure](#input\_infrastructure) | Specify the infrastructure information for deploying.<br><br>Examples:<pre>infrastructure:<br>  vpc_id: string                       # the ID of the VPC where the Redis service applies<br>  kms_key_id: string, optional         # the ID of the KMS key which to encrypt the Redis data<br>  domain_suffix: string, optional      # a private DNS namespace of the CloudMap where to register the applied Redis service</pre> | <pre>object({<br>    vpc_id        = string<br>    kms_key_id    = optional(string)<br>    domain_suffix = optional(string)<br>  })</pre> | n/a | yes |
 | <a name="input_password"></a> [password](#input\_password) | Specify the account password. The password must be 16-32 characters long and start with any letter, number, or the following symbols: ! # $ % ^ & * ( ) \_ + - =.<br>If not specified, it will generate a random password. | `string` | `null` | no |
+| <a name="input_replication_readonly_replicas"></a> [replication\_readonly\_replicas](#input\_replication\_readonly\_replicas) | Specify the number of read-only replicas under the replication deployment. | `number` | `1` | no |
 | <a name="input_resources"></a> [resources](#input\_resources) | Specify the computing resources.<br>Examples:<pre>resources:<br>  class: string, optional      # https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html</pre> | <pre>object({<br>    class = optional(string, "cache.t3.micro")<br>  })</pre> | <pre>{<br>  "class": "cache.t3.micro"<br>}</pre> | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| <a name="output_context"></a> [context](#output\_context) | The input context, a map, which is used for orchestration. |
-| <a name="output_refer"></a> [refer](#output\_refer) | The refer, a map, including hosts, ports and account, which is used for dependencies or collaborations. |
-| <a name="output_connection"></a> [connection](#output\_connection) | The connection, a string combined host and port, might be a comma separated string or a single string. |
-| <a name="output_connection_readonly"></a> [connection\_readonly](#output\_connection\_readonly) | The readonly connection, a string combined host and port, might be a comma separated string or a single string. |
 | <a name="output_address"></a> [address](#output\_address) | The address, a string only has host, might be a comma separated string or a single string. |
 | <a name="output_address_readonly"></a> [address\_readonly](#output\_address\_readonly) | The readonly address, a string only has host, might be a comma separated string or a single string. |
-| <a name="output_port"></a> [port](#output\_port) | The port of the service. |
-| <a name="output_password"></a> [password](#output\_password) | The password of the account to access the service. |
+| <a name="output_connection"></a> [connection](#output\_connection) | The connection, a string combined host and port, might be a comma separated string or a single string. |
+| <a name="output_connection_readonly"></a> [connection\_readonly](#output\_connection\_readonly) | The readonly connection, a string combined host and port, might be a comma separated string or a single string. |
+| <a name="output_context"></a> [context](#output\_context) | The input context, a map, which is used for orchestration. |
 | <a name="output_endpoints"></a> [endpoints](#output\_endpoints) | The endpoints, a list of string combined host and port. |
 | <a name="output_endpoints_readonly"></a> [endpoints\_readonly](#output\_endpoints\_readonly) | The readonly endpoints, a list of string combined host and port. |
+| <a name="output_password"></a> [password](#output\_password) | The password of the account to access the service. |
+| <a name="output_port"></a> [port](#output\_port) | The port of the service. |
+| <a name="output_refer"></a> [refer](#output\_refer) | The refer, a map, including hosts, ports and account, which is used for dependencies or collaborations. |
 <!-- END_TF_DOCS -->
 
 ## License

examples/replication/README.md

@@ -49,14 +49,14 @@ No inputs.
 
 | Name | Description |
 |------|-------------|
-| <a name="output_context"></a> [context](#output\_context) | n/a |
-| <a name="output_refer"></a> [refer](#output\_refer) | n/a |
-| <a name="output_connection"></a> [connection](#output\_connection) | n/a |
-| <a name="output_connection_readonly"></a> [connection\_readonly](#output\_connection\_readonly) | n/a |
 | <a name="output_address"></a> [address](#output\_address) | n/a |
 | <a name="output_address_readonly"></a> [address\_readonly](#output\_address\_readonly) | n/a |
-| <a name="output_port"></a> [port](#output\_port) | n/a |
-| <a name="output_password"></a> [password](#output\_password) | n/a |
+| <a name="output_connection"></a> [connection](#output\_connection) | n/a |
+| <a name="output_connection_readonly"></a> [connection\_readonly](#output\_connection\_readonly) | n/a |
+| <a name="output_context"></a> [context](#output\_context) | n/a |
 | <a name="output_endpoints"></a> [endpoints](#output\_endpoints) | n/a |
 | <a name="output_endpoints_readonly"></a> [endpoints\_readonly](#output\_endpoints\_readonly) | n/a |
+| <a name="output_password"></a> [password](#output\_password) | n/a |
+| <a name="output_port"></a> [port](#output\_port) | n/a |
+| <a name="output_refer"></a> [refer](#output\_refer) | n/a |
 <!-- END_TF_DOCS -->

examples/standalone/README.md

@@ -53,14 +53,14 @@ No inputs.
 
 | Name | Description |
 |------|-------------|
-| <a name="output_context"></a> [context](#output\_context) | n/a |
-| <a name="output_refer"></a> [refer](#output\_refer) | n/a |
-| <a name="output_connection"></a> [connection](#output\_connection) | n/a |
-| <a name="output_connection_readonly"></a> [connection\_readonly](#output\_connection\_readonly) | n/a |
 | <a name="output_address"></a> [address](#output\_address) | n/a |
 | <a name="output_address_readonly"></a> [address\_readonly](#output\_address\_readonly) | n/a |
-| <a name="output_port"></a> [port](#output\_port) | n/a |
-| <a name="output_password"></a> [password](#output\_password) | n/a |
+| <a name="output_connection"></a> [connection](#output\_connection) | n/a |
+| <a name="output_connection_readonly"></a> [connection\_readonly](#output\_connection\_readonly) | n/a |
+| <a name="output_context"></a> [context](#output\_context) | n/a |
 | <a name="output_endpoints"></a> [endpoints](#output\_endpoints) | n/a |
 | <a name="output_endpoints_readonly"></a> [endpoints\_readonly](#output\_endpoints\_readonly) | n/a |
+| <a name="output_password"></a> [password](#output\_password) | n/a |
+| <a name="output_port"></a> [port](#output\_port) | n/a |
+| <a name="output_refer"></a> [refer](#output\_refer) | n/a |
 <!-- END_TF_DOCS -->

hack/generate.sh

@@ -47,12 +47,15 @@ function generate_doc() {
   fi
 
   seal::terraform::docs "${target}" --config="${target}/.terraform-docs.yml" --recursive
-  local examples=()
-  # shellcheck disable=SC2086
-  IFS=" " read -r -a examples <<<"$(seal::util::find_subdirs ${target}/examples)"
-  for example in "${examples[@]}"; do
-    seal::terraform::docs "${target}/examples/${example}" --config="${target}/.terraform-docs.yml"
-  done
+
+  if [[ -d "${target}/examples" ]]; then
+    local examples=()
+    # shellcheck disable=SC2086
+    IFS=" " read -r -a examples <<<"$(seal::util::find_subdirs ${target}/examples)"
+    for example in "${examples[@]}"; do
+      seal::terraform::docs "${target}/examples/${example}" --config="${target}/.terraform-docs.yml"
+    done
+  fi
 }
 
 function generate_schema() {
@@ -76,12 +79,15 @@ function generate_schema() {
   fi
 
   seal::walrus_cli::schema "${target}"
-  local sub_modules=()
-  # shellcheck disable=SC2086
-  IFS=" " read -r -a sub_modules <<<"$(seal::util::find_subdirs ${target}/modules)"
-  for module in "${sub_modules[@]}"; do
-    seal::walrus_cli::schema "${target}/modules/${module}"
-  done
+
+  if [[ -d "${target}/modules" ]]; then
+    local modules=()
+    # shellcheck disable=SC2086
+    IFS=" " read -r -a modules <<<"$(seal::util::find_subdirs ${target}/modules)"
+    for module in "${modules[@]}"; do
+      seal::walrus_cli::schema "${target}/modules/${module}"
+    done
+  fi
 }
 
 #

hack/lint.sh

@@ -43,12 +43,33 @@ function lint() {
   seal::terraform::format "${target}" -recursive
 
   seal::terraform::validate "${target}"
-  local examples=()
-  # shellcheck disable=SC2086
-  IFS=" " read -r -a examples <<<"$(seal::util::find_subdirs ${target}/examples)"
-  for example in "${examples[@]}"; do
-    seal::terraform::validate "${target}/examples/${example}"
-  done
+
+  if [[ -d "${target}/examples" ]]; then
+    local examples=()
+    # shellcheck disable=SC2086
+    IFS=" " read -r -a examples <<<"$(seal::util::find_subdirs ${target}/examples)"
+    for example in "${examples[@]}"; do
+      seal::terraform::validate "${target}/examples/${example}"
+    done
+  fi
+
+  if [[ -d "${target}/modules" ]]; then
+    local modules=()
+    # shellcheck disable=SC2086
+    IFS=" " read -r -a modules <<<"$(seal::util::find_subdirs ${target}/modules)"
+    for module in "${modules[@]}"; do
+      seal::terraform::validate "${target}/modules/${module}"
+    done
+  fi
+
+  if [[ -d "${target}/tests" ]]; then
+    local tests=()
+    # shellcheck disable=SC2086
+    IFS=" " read -r -a tests <<<"$(seal::util::find_subdirs ${target}/tests)"
+    for test in "${tests[@]}"; do
+      seal::terraform::validate "${target}/tests/${test}"
+    done
+  fi
 
   seal::terraform::lint "${target}" --recursive
 

hack/test.sh

@@ -31,12 +31,33 @@ function test() {
   fi
 
   seal::terraform::test "${target}"
-  local examples=()
-  # shellcheck disable=SC2086
-  IFS=" " read -r -a examples <<<"$(seal::util::find_subdirs ${target}/examples)"
-  for example in "${examples[@]}"; do
-    seal::terraform::test "${target}/examples/${example}"
-  done
+
+  if [[ -d "${target}/examples" ]]; then
+    local examples=()
+    # shellcheck disable=SC2086
+    IFS=" " read -r -a examples <<<"$(seal::util::find_subdirs ${target}/examples)"
+    for example in "${examples[@]}"; do
+      seal::terraform::test "${target}/examples/${example}"
+    done
+  fi
+  
+  if [[ -d "${target}/modules" ]]; then
+    local modules=()
+    # shellcheck disable=SC2086
+    IFS=" " read -r -a examples <<<"$(seal::util::find_subdirs ${target}/modules)"
+    for module in "${modules[@]}"; do
+      seal::terraform::test "${target}/modules/${module}"
+    done
+  fi
+
+  if [[ -d "${target}/tests" ]]; then
+    local tests=()
+    # shellcheck disable=SC2086
+    IFS=" " read -r -a tests <<<"$(seal::util::find_subdirs ${target}/tests)"
+    for test in "${tests[@]}"; do
+      seal::terraform::test "${target}/tests/${test}"
+    done
+  fi
 }
 
 #