From 61bb2fe5521ef3fa9d0485f8deed7c145c96f850 Mon Sep 17 00:00:00 2001 From: Felix Haus Date: Sat, 23 Jan 2021 21:56:49 +0100 Subject: [PATCH] Initial commit --- .github/workflows/tf-docs.yml | 21 ++++ .gitignore | 9 ++ LICENSE | 201 ++++++++++++++++++++++++++++++++++ README.md | 13 +++ download.sh | 15 +++ examples/download/README.md | 3 + examples/download/main.tf | 11 ++ main.tf | 36 ++++++ outputs.tf | 4 + variables.tf | 27 +++++ versions.tf | 10 ++ 11 files changed, 350 insertions(+) create mode 100644 .github/workflows/tf-docs.yml create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100755 download.sh create mode 100644 examples/download/README.md create mode 100644 examples/download/main.tf create mode 100644 main.tf create mode 100644 outputs.tf create mode 100644 variables.tf create mode 100644 versions.tf diff --git a/.github/workflows/tf-docs.yml b/.github/workflows/tf-docs.yml new file mode 100644 index 0000000..448ff0a --- /dev/null +++ b/.github/workflows/tf-docs.yml @@ -0,0 +1,21 @@ +# GitHub action to make sure that the terraform docs in the README are +# up-to-date on every push to the main branch + +name: Terraform docs + +on: + push: + branches: + - main + +jobs: + update-docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Update Terraform docs in README + uses: Dirrk/terraform-docs@v1.0.8 + with: + tf_docs_output_file: README.md + tf_docs_git_push: 'true' + tf_docs_git_commit_message: 'terraform-docs: Update' diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1462240 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +# Download dir +/download + +.DS_STORE + +# Terraform +**/.terraform/* +*.tfstate +*.tfstate.* diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ec51210 --- /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 2021 Felix Haus (DealMore) + + 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. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..378f1db --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# NPM Download Terraform module + +A simple module to download files distributed via npm. + + + + + + + +## License + +Apache-2.0 - see [LICENSE](https://github.com/dealmore/terraform-npm-download/blob/main/LICENSE) for details. diff --git a/download.sh b/download.sh new file mode 100755 index 0000000..528b007 --- /dev/null +++ b/download.sh @@ -0,0 +1,15 @@ +#!/bin/bash + +SOURCE=$1 +OUTPUT_PATH=$2 + +mkdir -p "$(dirname "${OUTPUT_PATH}")"; +wget -q ${SOURCE} -O ${OUTPUT_PATH}; + +# https://stackoverflow.com/a/39122532/831465 +if [[ $? -ne 0 ]]; then + >&2 echo "Failed to download ${SOURCE}" + exit 1; +fi + +echo "{\"output\":\"${OUTPUT_PATH}\"}"; diff --git a/examples/download/README.md b/examples/download/README.md new file mode 100644 index 0000000..cd3f047 --- /dev/null +++ b/examples/download/README.md @@ -0,0 +1,3 @@ +# Download a file from npm + +Download a file from inside a npm package. diff --git a/examples/download/main.tf b/examples/download/main.tf new file mode 100644 index 0000000..f9f76ed --- /dev/null +++ b/examples/download/main.tf @@ -0,0 +1,11 @@ +module "npm_download" { + source = "../.." + + module_name = "@dealmore/terraform-next-deploy-trigger" + module_version = "0.1.0" + path_to_file = "package.json" +} + +output "file_path" { + value = module.npm_download.abs_path +} diff --git a/main.tf b/main.tf new file mode 100644 index 0000000..9a15f7e --- /dev/null +++ b/main.tf @@ -0,0 +1,36 @@ +locals { + node_resolve_script = <<-EOF + console.log( + JSON.stringify({ + path: require.resolve("${var.module_name}/${var.path_to_file}") + }) + ); + EOF + + cdn_module_version = length(var.module_version) > 0 ? "@${var.module_version}" : "" + cdn_module_url = "${var.cdn_provider_url}${var.module_name}${local.cdn_module_version}/${var.path_to_file}" + cdn_download_dest = "${path.module}/download/${var.module_name}/${var.path_to_file}" + + file_path = var.use_local ? data.external.this[0].result.path : local.cdn_download_dest +} + +####################################### +# Find file locally via Node.js resolve +####################################### + +data "external" "this" { + count = var.use_local ? 1 : 0 + + program = ["node", "-e", local.node_resolve_script] + working_dir = path.cwd +} + +############################ +# Download the file from CDN +############################ + +data "external" "download" { + count = var.use_local ? 0 : 1 + + program = ["bash", "${path.module}/download.sh", local.cdn_module_url, local.cdn_download_dest] +} diff --git a/outputs.tf b/outputs.tf new file mode 100644 index 0000000..fbaadd7 --- /dev/null +++ b/outputs.tf @@ -0,0 +1,4 @@ +output "abs_path" { + description = "The absolute path to the downloaded file on the local file system." + value = abspath(local.file_path) +} diff --git a/variables.tf b/variables.tf new file mode 100644 index 0000000..a9e294a --- /dev/null +++ b/variables.tf @@ -0,0 +1,27 @@ +variable "cdn_provider_url" { + type = string + description = "The service that should be used for unpacking. jsdelivr or unpkg should work." + default = "https://cdn.jsdelivr.net/npm/" +} + +variable "module_name" { + type = string + description = "The name of the npm module." +} + +variable "module_version" { + type = string + description = "If you want a specific version (or semver range) of the module define it here." + default = "" +} + +variable "path_to_file" { + type = string + description = "The path inside of the npm module to the file you want to download." +} + +variable "use_local" { + type = bool + description = "Fallback for using node.resolve for getting the module locally. Usually used for debug." + default = false +} diff --git a/versions.tf b/versions.tf new file mode 100644 index 0000000..b9cdf73 --- /dev/null +++ b/versions.tf @@ -0,0 +1,10 @@ +terraform { + required_version = ">= 0.13" + + required_providers { + external = { + source = "hashicorp/external" + version = ">= 1.2.0" + } + } +}