From a754d2081ecadbbd1755cdb3cfd84555fd0d4190 Mon Sep 17 00:00:00 2001 From: Christian Lechner Date: Mon, 10 Jun 2024 16:45:32 +0200 Subject: [PATCH] initial version --- .devcontainer/devcontainer.json | 24 +++ .devcontainer/withenvfile/devcontainer.json | 32 +++ .github/dependabot.yml | 10 + .github/workflows/terraform_format_check.yml | 41 ++++ .github/workflows/terraform_unit_test.yml | 31 +++ .github/workflows/terraform_validate.yml | 45 ++++ .gitignore | 38 ++++ LICENSE | 201 ++++++++++++++++++ README.md | 5 + .../subaccount_creation.tftest.hcl | 20 ++ infra/main.tf | 35 +++ infra/outputs.tf | 9 + infra/provider.tf | 15 ++ .../local_subaccount_domain.tftest.hcl | 20 ++ .../variable_costcenter_validation.tftest.hcl | 30 +++ infra/variables.tf | 104 +++++++++ 16 files changed, 660 insertions(+) create mode 100644 .devcontainer/devcontainer.json create mode 100644 .devcontainer/withenvfile/devcontainer.json create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/terraform_format_check.yml create mode 100644 .github/workflows/terraform_unit_test.yml create mode 100644 .github/workflows/terraform_validate.yml create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 infra/integration-tests/subaccount_creation.tftest.hcl create mode 100644 infra/main.tf create mode 100644 infra/outputs.tf create mode 100644 infra/provider.tf create mode 100644 infra/unit-tests/local_subaccount_domain.tftest.hcl create mode 100644 infra/unit-tests/variable_costcenter_validation.tftest.hcl create mode 100644 infra/variables.tf diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 0000000..72b8f94 --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,24 @@ +{ + "name": "Terraform provider for SAP BTP - Default", + "image": "mcr.microsoft.com/devcontainers/base:debian", + // Features to add to the dev container. More info: https://containers.dev/features. + "features": { + "ghcr.io/devcontainers/features/terraform:1": {}, + "ghcr.io/devcontainers/features/github-cli:1": {} + }, + "customizations": { + "vscode": { + "settings": {}, + "extensions": [ + "HashiCorp.terraform" + ] + }, + "codespaces": {} + }, + "hostRequirements": { + "memory": "4gb" + }, + // Use 'forwardPorts' to make a list of ports inside the container available locally. + // "forwardPorts": [], + "remoteUser": "vscode" +} \ No newline at end of file diff --git a/.devcontainer/withenvfile/devcontainer.json b/.devcontainer/withenvfile/devcontainer.json new file mode 100644 index 0000000..e43b51d --- /dev/null +++ b/.devcontainer/withenvfile/devcontainer.json @@ -0,0 +1,32 @@ +{ + "name": "Terraform provider for SAP BTP - with env file", + "image": "mcr.microsoft.com/devcontainers/base:debian", + // Features to add to the dev container. More info: https://containers.dev/features. + "features": { + "ghcr.io/devcontainers/features/terraform:1": {}, + "ghcr.io/devcontainers/features/github-cli:1": {} + }, + "customizations": { + "vscode": { + "settings": {}, + "extensions": [ + "HashiCorp.terraform" + ] + }, + "codespaces": {} + }, + "hostRequirements": { + "memory": "4gb" + }, + // Use 'forwardPorts' to make a list of ports inside the container available locally. + // "forwardPorts": [], + "remoteUser": "vscode", + // This devcontainer expects a file named .devcontainer/devcontainer.env to exist. + // you should place the following environment variables in that file: + // - BTP_USERNAME + // - BTP_PASSWORD + "runArgs": [ + "--env-file", + ".devcontainer/devcontainer.env" + ] +} \ No newline at end of file diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..0ecf39e --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,10 @@ +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" + - package-ecosystem: "terraform" + directory: "/" + schedule: + interval: "weekly" diff --git a/.github/workflows/terraform_format_check.yml b/.github/workflows/terraform_format_check.yml new file mode 100644 index 0000000..e0610ac --- /dev/null +++ b/.github/workflows/terraform_format_check.yml @@ -0,0 +1,41 @@ +name: Terraform Format Check + +on: + pull_request: + types: + - opened + - reopened + - synchronize + - ready_for_review + +jobs: + terraform-fmt: + name: Validate Format of Terraform Files + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Setup Terraform + uses: hashicorp/setup-terraform@v3 + with: + terraform_wrapper: false + + - name: Get changed directories + id: changed-files + uses: tj-actions/changed-files@v44 + with: + dir_names: 'true' + + - name: Validate Terraform format + if: steps.changed-files.outputs.any_changed == 'true' + env: + ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }} + shell: bash + run: | + EXIT_CODE=0 + for file in ${ALL_CHANGED_FILES}; do + echo "Checking format of $file with terraform fmt" + terraform fmt -check -recursive "$file" || EXIT_CODE=$? + done + exit $EXIT_CODE \ No newline at end of file diff --git a/.github/workflows/terraform_unit_test.yml b/.github/workflows/terraform_unit_test.yml new file mode 100644 index 0000000..0a43c59 --- /dev/null +++ b/.github/workflows/terraform_unit_test.yml @@ -0,0 +1,31 @@ +name: Terraform Unit Tests + +on: + pull_request: + types: + - opened + - reopened + - synchronize + - ready_for_review + workflow_dispatch: + +jobs: + terraform-validate: + name: Validate Syntax of Terraform Files + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Setup Terraform + uses: hashicorp/setup-terraform@v3 + with: + terraform_wrapper: false + + - name: Execute Unit Tests + shell: bash + run: | + cd ./infra + terraform init -backend=false + terraform test -test-directory=unit-tests + \ No newline at end of file diff --git a/.github/workflows/terraform_validate.yml b/.github/workflows/terraform_validate.yml new file mode 100644 index 0000000..d06318d --- /dev/null +++ b/.github/workflows/terraform_validate.yml @@ -0,0 +1,45 @@ +name: Terraform Validation Check + +on: + pull_request: + types: + - opened + - reopened + - synchronize + - ready_for_review + +jobs: + terraform-validate: + name: Validate Syntax of Terraform Files + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Setup Terraform + uses: hashicorp/setup-terraform@v3 + with: + terraform_wrapper: false + + - name: Get changed directories + id: changed-files + uses: tj-actions/changed-files@v44 + with: + dir_names: 'true' + + - name: Validate Terraform sytnax + if: steps.changed-files.outputs.any_changed == 'true' + env: + ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }} + shell: bash + run: | + EXIT_CODE=0 + for file in ${ALL_CHANGED_FILES}; do + echo "Validating Terraform files in $file with terraform validate" + cd $file + terraform init -backend=false || EXIT_CODE=$? + terraform validate || EXIT_CODE=$? + rm -rf .terraform/ + cd ${{ github.workspace }} + done + exit $EXIT_CODE \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..13ee4bf --- /dev/null +++ b/.gitignore @@ -0,0 +1,38 @@ +# Local .terraform directories +**/.terraform/* +**/.terraform.lock.hcl + +# .tfstate files +*.tfstate +*.tfstate.* + +# Crash log files +crash.log +crash.*.log + +# Exclude all .tfvars files, which are likely to contain sensitive data, such as +# password, private keys, and other secrets. These should not be part of version +# control as they are data points which are potentially sensitive and subject +# to change depending on the environment. +*.tfvars +*.tfvars.json + +# Ignore override files as they are usually used to override resources locally and so +# are not checked in +override.tf +override.tf.json +*_override.tf +*_override.tf.json + +# Include override files you do wish to add to version control using negated pattern +# !example_override.tf + +# Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan +# example: *tfplan* + +# Ignore CLI configuration files +.terraformrc +terraform.rc + +# Ignore .env +*.env diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..6f62ec9 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# Terraform Provider for SAP BTP - Quality Aspects + +Sample repository for showcasing how to ensure quality aspects in Terraform scripts when using the Terraform provider for SAP BTP. + +You find all details in the blog post [Terraform - Let's keep the quality up](https://dev.to/lechnerc77/series/26908) on [dev.to](https://dev.to/). diff --git a/infra/integration-tests/subaccount_creation.tftest.hcl b/infra/integration-tests/subaccount_creation.tftest.hcl new file mode 100644 index 0000000..96a6582 --- /dev/null +++ b/infra/integration-tests/subaccount_creation.tftest.hcl @@ -0,0 +1,20 @@ +variables { + entitlements = [] +} + +run "test_successful_subaccount_creation" { + command = apply + + variables { + costcenter = "1234567890" + org_name = "ECOMMERCE" + project_name = "proj-0815" + stage = "TST" + region = "us10" + } + + assert { + condition = resource.btp_subaccount.project.state == "OK" + error_message = "The subaccount was not created in the expected state." + } +} diff --git a/infra/main.tf b/infra/main.tf new file mode 100644 index 0000000..6ab31ba --- /dev/null +++ b/infra/main.tf @@ -0,0 +1,35 @@ +### +# Setup of names in accordance to the company's naming conventions +### +locals { + project_subaccount_name = "${var.org_name} | ${var.project_name}: CF - ${var.stage}" + project_subaccount_domain = lower(replace("${var.org_name}-${var.project_name}-${var.stage}", " ", "-")) +} + +### +# Creation of subaccount +### +resource "btp_subaccount" "project" { + name = local.project_subaccount_name + subdomain = local.project_subaccount_domain + region = lower(var.region) + labels = { + "stage" = ["${var.stage}"], + "costcenter" = ["${var.costcenter}"] + } + usage = "NOT_USED_FOR_PRODUCTION" +} + +### +# Assignment of entitlements +### +resource "btp_subaccount_entitlement" "entitlements" { + for_each = { + for index, entitlement in var.entitlements : + index => entitlement + } + + subaccount_id = btp_subaccount.project.id + service_name = each.value.name + plan_name = each.value.plan +} diff --git a/infra/outputs.tf b/infra/outputs.tf new file mode 100644 index 0000000..9cc0c34 --- /dev/null +++ b/infra/outputs.tf @@ -0,0 +1,9 @@ +output "subaccount_id" { + value = btp_subaccount.project.id + description = "The ID of the project subaccount." +} + +output "subaccount_name" { + value = btp_subaccount.project.name + description = "The name of the project subaccount." +} diff --git a/infra/provider.tf b/infra/provider.tf new file mode 100644 index 0000000..9a835a9 --- /dev/null +++ b/infra/provider.tf @@ -0,0 +1,15 @@ + +terraform { + required_providers { + btp = { + source = "sap/btp" + version = "~>1.4.0" + } + } +} + +# Please checkout documentation on how best to authenticate against SAP BTP +# via the Terraform provider for SAP BTP +provider "btp" { + globalaccount = var.globalaccount +} diff --git a/infra/unit-tests/local_subaccount_domain.tftest.hcl b/infra/unit-tests/local_subaccount_domain.tftest.hcl new file mode 100644 index 0000000..dc7b901 --- /dev/null +++ b/infra/unit-tests/local_subaccount_domain.tftest.hcl @@ -0,0 +1,20 @@ +mock_provider "btp" {} + +variables { + globalaccount = "test" +} + +run "validate_project_subaccount_domain" { + command = plan + + variables { + org_name = "B2C" + project_name = "proj 1234" + stage = "DEV" + } + + assert { + condition = local.project_subaccount_domain == "b2c-proj-1234-dev" + error_message = "Local variable project_subaccount_domain is not transformed correctly." + } +} diff --git a/infra/unit-tests/variable_costcenter_validation.tftest.hcl b/infra/unit-tests/variable_costcenter_validation.tftest.hcl new file mode 100644 index 0000000..68c8317 --- /dev/null +++ b/infra/unit-tests/variable_costcenter_validation.tftest.hcl @@ -0,0 +1,30 @@ +mock_provider "btp" {} + +variables { + globalaccount = "test" +} + +run "provide_valid_costcenter" { + command = plan + + variables { + costcenter = "8523652147" + } + + assert { + condition = var.costcenter == "8523652147" + error_message = "Costcenter is not set correctly" + } +} + +run "provide_invalid_costcenter_with_letters" { + command = plan + + variables { + costcenter = "abc-123" + } + + expect_failures = [ + var.costcenter + ] +} \ No newline at end of file diff --git a/infra/variables.tf b/infra/variables.tf new file mode 100644 index 0000000..ba078fa --- /dev/null +++ b/infra/variables.tf @@ -0,0 +1,104 @@ +### +# Provider configuration +### +variable "globalaccount" { + type = string + description = "The subdomain of the SAP BTP global account." +} + +variable "region" { + type = string + description = "The region where the project account shall be created in." + default = "eu10" +} + +### +# Subaccount setup +### +variable "project_name" { + type = string + description = "The subaccount name." + default = "proj-1234" + + validation { + condition = can(regex("^[a-zA-Z0-9_\\-]{1,200}", var.project_name)) + error_message = "Provide a valid project name." + } +} + +variable "stage" { + type = string + description = "The stage/tier the account will be used for." + default = "DEV" + + validation { + condition = contains(["DEV", "TST", "SBX", "PRD"], var.stage) + error_message = "Select a valid stage for the project account." + } +} + +variable "costcenter" { + type = string + description = "The cost center the account will be billed to." + default = "1234567890" + + validation { + condition = can(regex("^[0-9]{10}", var.costcenter)) + error_message = "Provide a valid cost center." + } +} + +variable "org_name" { + type = string + description = "Defines to which organisation the project account shall belong to." + default = "B2C" + + validation { + condition = contains(concat( + // Cross Development + ["B2B", "B2C", "ECOMMERCE"], + // Internal IT + ["PLATFORMDEV", "INTIT"], + ), var.org_name) + error_message = "Please select a valid org name for the project account." + } +} + +### +# Entitlements for Subaccount +### +variable "entitlements" { + type = list(object({ + name = string + plan = string + amount = number + })) + description = "List of entitlements for the subaccount." + default = [ + { + name = "alert-notification" + plan = "standard" + amount = null + }, + { + name = "SAPLaunchpad" + plan = "standard" + amount = null + }, + { + name = "hana-cloud" + plan = "hana" + amount = null + }, + { + name = "hana" + plan = "hdi-shared" + amount = null + }, + { + name = "sapappstudio" + plan = "standard-edition" + amount = null + } + ] +}