rails_template_18f 1.3.0 → 2.1.0

data/lib/generators/rails_template18f/terraform/templates/terraform/terraform.sh.tt

@@ -0,0 +1,95 @@
+#!/usr/bin/env bash
+
+rmk_file="../config/master.key"
+cmd="plan"
+
+usage="
+$0: Run terraform commands against a given environment
+
+Usage:
+  $0 -h
+  $0 -e <ENV NAME> [-k <RAILS_MASTER_KEY>] [-f] [-c <TERRAFORM-CMD>] [-- <EXTRA CMD ARGUMENTS>]
+
+Options:
+-h: show help and exit
+-e ENV_NAME: The name of the environment to run terraform against
+-k RAILS_MASTER_KEY: RAILS_MASTER_KEY value. Defaults to contents of $rmk_file
+-f: Force, pass -auto-approve to all invocations of terraform
+-c TERRAFORM-CMD: command to run. Defaults to $cmd
+[<EXTRA CMD ARGUMENTS>]: arguments to pass as-is to terraform
+"
+
+
+rmk=`cat $rmk_file || echo -n ""`
+env=""
+force=""
+args_to_shift=0
+
+set -e
+while getopts ":he:k:fc:" opt; do
+  case "$opt" in
+    e)
+      env=${OPTARG}
+      args_to_shift=$((args_to_shift + 2))
+      ;;
+    k)
+      rmk=${OPTARG}
+      args_to_shift=$((args_to_shift + 2))
+      ;;
+    f)
+      force="-auto-approve"
+      args_to_shift=$((args_to_shift + 1))
+      ;;
+    c)
+      cmd=${OPTARG}
+      args_to_shift=$((args_to_shift + 2))
+      ;;
+    h)
+      echo "$usage"
+      exit 0
+      ;;
+  esac
+done
+
+shift $args_to_shift
+if [[ "$1" = "--" ]]; then
+  shift 1
+fi
+
+if [[ -z "$env" ]]; then
+  echo "-e <ENV_NAME> is required"
+  echo "$usage"
+  exit 1
+fi
+
+if [[ ! -f "$env.tfvars" ]]; then
+  echo "$env.tfvars file is missing. Create it first"
+  exit 1
+fi
+
+# ensure we're logged in via cli
+cf spaces &> /dev/null || cf login -a api.fr.cloud.gov --sso
+
+tfm_needs_init=true
+if [[ -f .terraform/terraform.tfstate ]]; then
+  backend_state_env=`cat .terraform/terraform.tfstate | jq -r ".backend.config.key" | cut -d '.' -f3`
+  if [[ "$backend_state_env" = "$env" ]]; then
+    tfm_needs_init=false
+  fi
+fi
+
+if [[ $tfm_needs_init = true ]]; then
+  if [[ ! -f secrets.backend.tfvars ]]; then
+    echo "=============================================================================================================="
+    echo "= Recreating backend config file. It is fine if this step wants to delete any local_sensitive_file resources"
+    echo "=============================================================================================================="
+    (cd bootstrap && ./apply.sh -auto-approve)
+  fi
+  terraform init -backend-config=secrets.backend.tfvars -backend-config="key=terraform.tfstate.$env" -reconfigure
+  rm secrets.backend.tfvars
+fi
+
+echo "=============================================================================================================="
+echo "= Calling $cmd $force on the application infrastructure"
+echo "=============================================================================================================="
+terraform "$cmd" -var-file="$env.tfvars" -var rails_master_key="$rmk" $force "$@"

data/lib/generators/rails_template18f/terraform/templates/terraform/variables.tf.tt

@@ -0,0 +1,98 @@
+# Deploy user settings
+variable "cf_user" {
+  type        = string
+  description = "The user email or service account running the terraform"
+}
+
+# app_space settings
+variable "cf_space_name" {
+  type        = string
+  description = "The space name to deploy the app into"
+}<% if terraform_manage_spaces? %>
+variable "space_deployers" {
+  type        = set(string)
+  default     = []
+  description = "A list of users to be granted SpaceDeveloper & SpaceManager on cf_space_name"
+}
+variable "space_developers" {
+  type        = set(string)
+  default     = []
+  description = "A list of users to be granted SpaceDeveloper on cf_space_name"
+}
+variable "space_auditors" {
+  type        = set(string)
+  default     = []
+  description = "A list of users to be granted SpaceAuditor on cf_space_name"
+}
+variable "allow_space_ssh" {
+  type        = bool
+  default     = false
+  description = "Whether to allow ssh to cf_space_name"
+}<% end %>
+
+# supporting services settings
+variable "rds_plan_name" {
+  type        = string
+  default     = "micro-psql"
+  description = "The name of the rds plan to create"
+}
+<% if has_active_job? %>
+variable "redis_plan_name" {
+  type        = string
+  default     = "redis-dev"
+  description = "The name of the redis plan to create"
+}
+<% end %>
+<% if has_active_storage? %>
+variable "s3_plan_name" {
+  type        = string
+  default     = "basic-sandbox"
+  description = "The name of the s3 plan to use"
+}
+<% end %>
+# routing settings
+variable "custom_domain_name" {
+  type        = string
+  default     = null
+  description = "The custom domain name to associate with the app. Leave as null to disable the domain service and use an *.app.cloud.gov route"
+}
+variable "host_name" {
+  type        = string
+  default     = null
+  description = "An optional hostname to prepend to either the custom domain name or app.cloud.gov"
+}
+
+# App environment settings
+variable "env" {
+  type        = string
+  description = "The RAILS_ENV to set for the app (staging or production)"
+}
+
+variable "rails_master_key" {
+  type        = string
+  sensitive   = true
+  description = "config/master.key"
+}
+
+variable "web_instances" {
+  type        = number
+  default     = 1
+  description = "The number of instances of the web process"
+}
+variable "web_memory" {
+  type        = string
+  default     = "256M"
+  description = "The amount of memory to assign to the web processes"
+}
+<% if has_active_job? %>
+variable "worker_instances" {
+  type        = number
+  default     = 1
+  description = "The number of instances of the worker process"
+}
+variable "worker_memory" {
+  type        = string
+  default     = "256M"
+  description = "The amount of memory to assign to the worker processes"
+}
+<% end %>

data/lib/generators/rails_template18f/terraform/terraform_generator.rb

@@ -15,8 +15,16 @@ module RailsTemplate18f
 
       def install
         directory "terraform", mode: :preserve
-        chmod "terraform/bootstrap/run.sh", 0o755
-        chmod "terraform/bootstrap/teardown_creds.sh", 0o755
+        chmod "terraform/terraform.sh", 0o755
+        if terraform_manage_spaces?
+          template "full_bootstrap/main.tf", "terraform/bootstrap/main.tf"
+          copy_file "full_bootstrap/imports.tf.tftpl", "terraform/bootstrap/templates/imports.tf.tftpl"
+        else
+          template "sandbox_bootstrap/main.tf", "terraform/bootstrap/main.tf"
+          copy_file "sandbox_bootstrap/imports.tf.tftpl", "terraform/bootstrap/templates/imports.tf.tftpl"
+          remove_file "terraform/bootstrap/users.auto.tfvars"
+          remove_file "terraform/production.tfvars"
+        end
       end
 
       def ignore_files
@@ -26,9 +34,10 @@ module RailsTemplate18f
             # Terraform
             .terraform.lock.hcl
             **/.terraform/*
-            secrets.auto.tfvars
+            secrets.*.tfvars
             terraform.tfstate
             terraform.tfstate.backup
+            terraform/dist
           EOM
         end
       end
@@ -36,7 +45,6 @@ module RailsTemplate18f
       def update_readme
         gsub_file "README.md", /^(### Automatic linting)\s*$/, '\1 and terraform formatting'
         gsub_file "README.md", /(ruby linting) (on every)/, '\1 and terraform formatting \2'
-        gsub_file "README.md", /^Before the first deploy only.*$/, "Follow the instructions in `terraform/README.md` to create the supporting services."
       end
 
       def install_githook

data/lib/rails_template18f/generators/cloud_gov_options.rb

@@ -14,19 +14,22 @@ module RailsTemplate18f
 
       private
 
+      def terraform_manage_spaces?
+        # when operating in sandbox-gsa we can't use many features that rely
+        # on being an OrgManager
+        cloud_gov_organization != "sandbox-gsa"
+      end
+
       def cloud_gov_organization
-        return options[:cg_org] if options[:cg_org].present?
-        super
+        @cloud_gov_organization ||= (options[:cg_org].present? ? options[:cg_org] : super)
       end
 
       def cloud_gov_staging_space
-        return options[:cg_staging] if options[:cg_staging].present?
-        super
+        @cloud_gov_staging_space ||= (options[:cg_staging].present? ? options[:cg_staging] : super)
       end
 
       def cloud_gov_production_space
-        return options[:cg_prod] if options[:cg_prod].present?
-        super
+        @cloud_gov_production_space ||= (options[:cg_prod].present? ? options[:cg_prod] : super)
       end
     end
   end

data/lib/rails_template18f/generators/cloud_gov_parsing.rb

@@ -9,8 +9,8 @@ module RailsTemplate18f
 
       def cloud_gov_organization
         if terraform_dir_exists?
-          staging_main = file_content("terraform/staging/main.tf")
-          if (matches = staging_main.match(/cf_org_name\s+= "(?<org_name>.*)"/))
+          main_tf = file_content("terraform/main.tf")
+          if (matches = main_tf.match(/cf_org_name\s+= "(?<org_name>.*)"/))
             return matches[:org_name]
           end
         end
@@ -19,8 +19,8 @@ module RailsTemplate18f
 
       def cloud_gov_staging_space
         if terraform_dir_exists?
-          staging_main = file_content("terraform/staging/main.tf")
-          if (matches = staging_main.match(/cf_space_name\s+= "(?<space_name>.*)"/))
+          staging_vars = file_content("terraform/staging.tfvars")
+          if (matches = staging_vars.match(/cf_space_name\s+= "(?<space_name>.*)"/))
             return matches[:space_name]
           end
         end
@@ -29,12 +29,12 @@ module RailsTemplate18f
 
       def cloud_gov_production_space
         if terraform_dir_exists?
-          prod_main = file_content("terraform/production/main.tf")
-          if (matches = prod_main.match(/cf_space_name\s+= "(?<space_name>.*)"/))
+          production_vars = file_content("terraform/production.tfvars")
+          if (matches = production_vars.match(/cf_space_name\s+= "(?<space_name>.*)"/))
             return matches[:space_name]
           end
         end
-        "prod"
+        "production"
       end
     end
   end

data/lib/rails_template18f/generators.rb

@@ -7,6 +7,5 @@ module RailsTemplate18f
     autoload :Base
     autoload :CloudGovOptions
     autoload :CloudGovParsing
-    autoload :PipelineOptions
   end
 end

data/lib/rails_template18f/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsTemplate18f
-  VERSION = "1.3.0"
+  VERSION = "2.1.0"
 end

data/rails-template-18f.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
 
   spec.summary = "Generators for creating an 18F-flavored Rails app"
   spec.homepage = "https://github.com/18f/rails-template"
-  spec.required_ruby_version = ">= 2.7.5"
+  spec.required_ruby_version = ">= 3.2.0"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org/"
 
@@ -31,12 +31,12 @@ Gem::Specification.new do |spec|
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
-  spec.add_dependency "railties", "~> 7.2.0"
-  spec.add_dependency "activesupport", "~> 7.2.0"
+  spec.add_dependency "railties", "~> 8.0.1"
+  spec.add_dependency "activesupport", "~> 8.0.1"
   spec.add_dependency "thor", "~> 1.3"
   spec.add_dependency "colorize", "~> 1.1"
 
   spec.add_development_dependency "rspec", "~> 3.13"
   spec.add_development_dependency "ammeter", "~> 1.1"
-  spec.add_development_dependency "standard", "~> 1.40"
+  spec.add_development_dependency "standard", "~> 1.43"
 end

data/railsrc

@@ -5,9 +5,11 @@
 --skip-hotwire
 --skip-docker
 --skip-test
---javascript=webpack
---css=postcss
+--javascript=esbuild
+--css=sass
 --template=template.rb
 --database=postgresql
 --skip-rubocop
 --skip-ci
+--skip-kamal
+--skip-solid

data/railsrc-hotwire

@@ -3,9 +3,11 @@
 --skip-action-mailbox
 --skip-docker
 --skip-test
---javascript=webpack
---css=postcss
+--javascript=esbuild
+--css=sass
 --template=template.rb
 --database=postgresql
 --skip-rubocop
 --skip-ci
+--skip-kamal
+--skip-solid