firespring_dev_commands 2.1.26.pre.alpha.2 → 2.1.27.pre.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b68163bb71bf29450c83939ecdc3181f8003ac39731839c0c67dd5808c2f9331
-  data.tar.gz: c956a7f6c49ce1d0478df460e54d24a5c12598b4c24b905f959e489c289515f3
+  metadata.gz: fce5da47cf928179b220c2d30c295fb5c853aee03ca1cad7bbf9684f8b8aea3a
+  data.tar.gz: 33100d5b2127c7cb422f6695e19e85b3f8bfe41d0dd13f7f0ab4f4721351286b
 SHA512:
-  metadata.gz: 7f62bd98a204af676eb9bec3cf64c4783c20ad265115df7fbf4e13964a5f5bd9ce3ceb89f3ecb505c478f06fcab1b7635814ebeb999e62e133c63728bf6d7f7e
-  data.tar.gz: 92b52d27ab0b6a15ebdb16098296259010284326d20719d45d10b41d4f0e73801ec00b1a48ad7f7a0cd941db47b4541bbdad7024cf593aff403324791908a8bb
+  metadata.gz: fb735b569248c55a15bd51bb971054107ea1d885fb08e4a2da43bafdc3093b86daf00c42962fcb0ce4aeb543e76afff8ca06be4359bbbd4c489dc83c09d46bc6
+  data.tar.gz: 4e43a5eee15f6dbbbeab27c006a0dbdb1802be2c882008627b4d1025f99e72a52d3855c8121eba967b21fba4f766daf1e2f0e90e11bb06ab32f7c6e110f86d7e

data/lib/firespring_dev_commands/certificate.rb

@@ -0,0 +1,59 @@
+module Dev
+  # Class contains methods for requesting a certificate from route53.
+  # You must have a hosted zone defined for the desired domain
+  class Certificate
+    attr_accessor :domains, :email
+
+    def initialize(domains, email)
+      @domains = Array(domains)
+      @email = email
+      raise 'No certificate domains specified' if domains.empty?
+    end
+
+    # Request the certificate using the route53 docker image
+    # Certificate is stored in /etc/letsencrypt
+    def request
+      puts
+      puts 'Getting SSL Certs For:'
+      puts domains.join("\n")
+      puts
+      puts 'This process can take up to 10 minutes'
+      puts
+      puts Time.now
+
+      # TODO: Really should use the docker api for this
+      cmd = %w(docker run -it --rm --name certbot)
+      cmd << '-e' << 'AWS_ACCESS_KEY_ID'
+      cmd << '-e' << 'AWS_SECRET_ACCESS_KEY'
+      cmd << '-e' << 'AWS_SESSION_TOKEN'
+      cmd << '-v' << '/etc/letsencrypt:/etc/letsencrypt'
+      cmd << 'certbot/dns-route53:latest'
+      cmd << 'certonly'
+      cmd << '-n'
+      cmd << '--agree-tos'
+      cmd << '--dns-route53'
+      cmd << '-d' << domains.join(',')
+      cmd << '--email' << email
+      cmd << '--server' << 'https://acme-v02.api.letsencrypt.org/directory'
+      puts cmd.join(' ')
+      Dev::Common.new.run_command(cmd)
+    end
+
+    # Saves the latest version of the certificate into the given dest_dir
+    def save(dest_dir)
+      raise "directory #{dest_dir} must be an existing directory" unless File.directory?(dest_dir)
+
+      domain = domains.first.sub(/^\*\./, '') # Need to strip off the '*.' if this is a wildcard cert
+      directories = Dir.glob("/etc/letsencrypt/live/#{domain}*/")
+      no_suffix = directories.delete("/etc/letsencrypt/live/#{domain}/")
+      biggest_suffix = directories.max
+      source_dir = biggest_suffix || no_suffix
+      raise "unable to determine certificate directory for #{domain}" unless source_dir
+
+      FileUtils.cp("#{source_dir}privkey.pem", dest_dir, verbose: true)
+      FileUtils.cp("#{source_dir}cert.pem", dest_dir, verbose: true)
+      FileUtils.cp("#{source_dir}chain.pem", dest_dir, verbose: true)
+      FileUtils.cp("#{source_dir}fullchain.pem", dest_dir, verbose: true)
+    end
+  end
+end

data/lib/firespring_dev_commands/docker/status.rb

@@ -33,6 +33,26 @@ module Dev
         EXITED,
         DEAD
       ].freeze
+
+      # TODO: Can we use 'curses' here and overwrite the correct line?
+      def response_callback(response)
+        response.split("\n").each do |line|
+          data = JSON.parse(line)
+          if data.include?('status')
+            if data['id']
+              LOG.info "#{data['id']}: #{data['status']}"
+            else
+              LOG.info (data['status']).to_s
+            end
+          elsif data.include?('errorDetail')
+            raise data['errorDetail']['message']
+          elsif data.include?('aux')
+            next
+          else
+            raise "Unrecognized message from docker: #{data}"
+          end
+        end
+      end
     end
   end
 end

data/lib/firespring_dev_commands/docker.rb

@@ -117,6 +117,44 @@ module Dev
       format('%.1f %s', size.to_f / (1024**exp), units[exp])
     end
 
+    # Push the local version of the docker image to the defined remote repository
+    def push_image(image, name, tag = nil)
+      unless tag
+        if name.include?(':')
+          name, tag = name.split(':')
+        else
+          tag = 'latest'
+        end
+      end
+
+      puts "Pushing to #{name}:#{tag}"
+      image.push(::Docker.creds, repo_tag: "#{name}:#{tag}") { |response| Dev::Docker::Status.new.response_callback(response) }
+    end
+
+    # Push the remote version of the docker image from the defined remote repository
+    def pull_image(name, tag = nil)
+      unless tag
+        if name.include?(':')
+          name, tag = name.split(':')
+        else
+          tag = 'latest'
+        end
+      end
+
+      puts "\nPulling #{name}:#{tag}"
+      opts = {
+        fromImage: "#{name}:#{tag}",
+        platform: Dev::Platform.new.architecture
+      }
+      ::Docker::Image.create(**opts) { |response| Dev::Docker::Status.new.response_callback(response) }
+    end
+
+    # Remove the local version of the given docker image
+    def untag_image(image, name, tag)
+      puts "Untagging #{name}:#{tag}"
+      image.remove(name: "#{name}:#{tag}")
+    end
+
     # Remove docker images with the "force" option set to true
     # This will remove the images even if they are currently in use and cause unintended side effects.
     def force_remove_images(name_and_tag)

data/lib/firespring_dev_commands/eol.rb

@@ -5,9 +5,8 @@ module Dev
     END_OF_LIFE_API_URL = 'https://endoflife.date/api'.freeze
 
     # Config object for setting top level git config options
-    Config = Struct.new(:check_aws_resources, :product_versions, :manual_dates) do
+    Config = Struct.new(:product_versions, :manual_dates) do
       def initialize
-        self.check_aws_resources = false
         self.product_versions = []
         self.manual_dates = {}
       end
@@ -27,10 +26,9 @@ module Dev
       alias_method :configure, :config
     end
 
-    attr_accessor :url, :products, :check_aws_resources, :product_versions
+    attr_accessor :url, :products, :product_versions
 
-    def initialize(check_aws_resources: self.class.config.check_aws_resources, product_versions: self.class.config.product_versions)
-      @check_aws_resources = check_aws_resources
+    def initialize(product_versions: self.class.config.product_versions)
       @product_versions = Array(product_versions)
       raise 'product version must be of type Dev::EndOfLife::ProductVersions' unless @product_versions.all?(Dev::EndOfLife::ProductVersion)
     end
@@ -52,14 +50,7 @@ module Dev
     # Raises an error if any products are EOL
     def check
       puts
-      checks_to_perform = product_versions.clone
-      if check_aws_resources
-        account_id = Dev::Aws::Profile.new.current
-        account_name = Dev::Aws::Account.new.name_by_account(account_id)
-        LOG.info "  Current AWS Account is #{account_name} (#{account_id})\n".light_yellow
-        checks_to_perform.concat(Dev::EndOfLife::Aws.new.default_products)
-      end
-      checks_to_perform.sort_by(&:name).each(&:print_status)
+      product_versions.sort_by(&:name).each(&:print_status)
       puts
       raise 'found EOL versions' if product_versions.any?(&:eol)
     end

data/lib/firespring_dev_commands/platform.rb

@@ -1,40 +1,33 @@
 module Dev
-  class Common
-    # Class which returns information about the current platform
-    class Platform
-      # Constant containing all supported architectures
-      ALLOWED_ARCHITECTURES = %w(arm64 amd64).freeze
+  # Class which returns information about the current platform
+  class Platform
+    # Constant containing all supported architectures
+    ALLOWED_ARCHITECTURES = %w(linux/arm64 linux/amd64).freeze
 
-      # Normalize the ruby platform to return a docker platform architecture format
-      def determine_compute_architecture
-        case RUBY_PLATFORM
-        when /x86_64|amd64|x64-mingw/
-          'linux/amd64' # 64-bit Intel/AMD architecture
-        when /arm|aarch64/
-          'linux/arm64' # ARM architecture
-        else
-          raise 'Unknown or unsupported architecture'
-        end
-      end
+    # If an architecture was specified in the ENV, use that. Otherwise auto-deted based of the OS reported architecture
+    def architecture
+      arch = env_architecture || os_architecture
+      raise "Invalid DOCKER_ARCHITECTURE: #{arch} (allowed are #{ALLOWED_ARCHITECTURES.join(', ')})" unless ALLOWED_ARCHITECTURES.include?(arch)
 
-      # Determine the platform architecture
-      # If one was specified in the DOCKER_ARCHITECTURE variable, use it
-      # Otherwise, use the RUBY_PLATFORM built-in to auto-detect and architecture
-      def architecture
-        docker_architecture = ENV['DOCKER_ARCHITECTURE'].to_s.strip.downcase
-        if docker_architecture.empty?
-          determine_compute_architecture
-        else
-          raise "Missing 'linux/' prefix in DOCKER_ARCHITECTURE: #{docker_architecture}" unless docker_architecture.start_with?('linux/')
+      arch
+    end
+
+    # Check to see if a docker architecture has been specified in the ENV
+    # If it has, verify the format and the value
+    private def env_architecture
+      arch = ENV['DOCKER_ARCHITECTURE'].to_s.strip.downcase
+      return nil if arch.empty?
+
+      "linux/#{arch}" unless arch.start_with?('linux/')
+      arch
+    end
 
-          architecture_name = docker_architecture.split('/')[1]
-          unless ALLOWED_ARCHITECTURES.include?(architecture_name)
-            raise "Invalid DOCKER_ARCHITECTURE: #{architecture_name}. Allowed architectures are #{ALLOWED_ARCHITECTURES.join(', ')}"
-          end
+    # Returns a valid docker architecture based off the RUBY_PLATFORM
+    private def os_architecture
+      return 'linux/amd64' if RUBY_PLATFORM.match?(/x86_64|amd64|x64-mingw/)
+      return 'linux/arm64' if RUBY_PLATFORM.match?(/arm|aarch64/)
 
-          docker_architecture
-        end
-      end
+      raise 'Unknown or unsupported architecture'
     end
   end
 end

data/lib/firespring_dev_commands/templates/aws.rb

@@ -94,11 +94,23 @@ module Dev
       end
       # rubocop:enable Metrics/MethodLength
 
-      # Set the EOL library to also check AWS resources
+      # Create the rake task for the eol method
       def create_eol_task!
-        return if exclude.include?(:eol)
+        # Have to set a local variable to be accessible inside of the instance_eval block
+        exclude = @exclude
+
+        DEV_COMMANDS_TOP_LEVEL.instance_eval do
+          return if exclude.include?(:eol)
 
-        Dev::EndOfLife.config { |c| c.check_aws_resources = true }
+          desc 'Compares the current date to the EOL date for supported resources'
+          task eol: %w(init ensure_aws_credentials) do
+            account_id = Dev::Aws::Profile.new.current
+            account_name = Dev::Aws::Account.new.name_by_account(account_id)
+            LOG.info "  Current AWS Account is #{account_name} (#{account_id})".light_yellow
+
+            Dev::EndOfLife.new(product_versions: Dev::EndOfLife::Aws.new.default_products).check
+          end
+        end
       end
     end
   end

data/lib/firespring_dev_commands/templates/certificate.rb

@@ -0,0 +1,41 @@
+require_relative 'base_interface'
+
+module Dev
+  module Template
+    # Class contains rake templates for managing configured certificates
+    class Certificate < Dev::Template::BaseInterface
+      attr_reader :domains, :email, :paths
+
+      def initialize(domains, email:, paths:, exclude: [])
+        @domains = domains
+        @email = email
+        @paths = Array(paths)
+
+        super(exclude:)
+      end
+
+      # Create the rake task for the generate method
+      def create_generate_task!
+        # Have to set a local variable to be accessible inside of the instance_eval block
+        domains = @domains
+        email = @email
+        paths = @paths
+        exclude = @exclude
+
+        DEV_COMMANDS_TOP_LEVEL.instance_eval do
+          return if exclude.include?(:generate)
+
+          namespace :certificate do
+            desc 'Requests a new certificate for the configured domain using the route53 validation and deposits it in the configured paths'
+            task generate: %w(init_docker ensure_aws_credentials) do
+              Dev::Docker.new.pull_image('certbot/dns-route53', 'latest')
+              c = Dev::Certificate.new(domains, email)
+              c.request
+              paths.each { |path| c.save(path) }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/firespring_dev_commands/templates/git.rb

@@ -4,23 +4,6 @@ module Dev
   module Template
     # Class contains rake templates for managing your git project
     class Git < Dev::Template::BaseInterface
-      # Create the rake task for cloning all defined repos
-      def create_clone_task!
-        # Have to set a local variable to be accessible inside of the instance_eval block
-        exclude = @exclude
-
-        DEV_COMMANDS_TOP_LEVEL.instance_eval do
-          namespace :git do
-            return if exclude.include?(:clone)
-
-            desc 'Make sure all repos are cloned'
-            task :clone do
-              Dev::Git.new.clone_repos
-            end
-          end
-        end
-      end
-
       # Create the rake task for the git checkout method
       def create_checkout_task!
         # Have to set a local variable to be accessible inside of the instance_eval block

data/lib/firespring_dev_commands/version.rb

@@ -6,6 +6,6 @@ module Dev
     # Use 'v.v.v.pre.alpha.v' for pre-release vesions
     # Use 'v.v.v.beta.v for beta versions
     # Use semantic versioning for any releases (https://semver.org/)
-    VERSION = '2.1.26.pre.alpha.2'.freeze
+    VERSION = '2.1.27.pre.alpha.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firespring_dev_commands
 version: !ruby/object:Gem::Version
-  version: 2.1.26.pre.alpha.2
+  version: 2.1.27.pre.alpha.2
 platform: ruby
 authors:
 - Firespring
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-16 00:00:00.000000000 Z
+date: 2024-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -332,6 +332,7 @@ files:
 - lib/firespring_dev_commands/bloom_growth/seat.rb
 - lib/firespring_dev_commands/bloom_growth/user.rb
 - lib/firespring_dev_commands/boolean.rb
+- lib/firespring_dev_commands/certificate.rb
 - lib/firespring_dev_commands/common.rb
 - lib/firespring_dev_commands/coverage/base.rb
 - lib/firespring_dev_commands/coverage/cobertura.rb
@@ -383,6 +384,7 @@ files:
 - lib/firespring_dev_commands/target_process/user_story_history.rb
 - lib/firespring_dev_commands/templates/aws.rb
 - lib/firespring_dev_commands/templates/base_interface.rb
+- lib/firespring_dev_commands/templates/certificate.rb
 - lib/firespring_dev_commands/templates/ci.rb
 - lib/firespring_dev_commands/templates/config.rb
 - lib/firespring_dev_commands/templates/docker/application.rb