firespring_dev_commands 2.5.0.pre.alpha.2 → 3.0.0.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83bb511b8d20db07b3d3f001d82464c9c3edf81a7a719206f4840878d1301ecd
-  data.tar.gz: 07545c8d8388f32658b09b1b4137f57d766456b1bc1e66696493b1e943330ae5
+  metadata.gz: 72bba6fb9e4d227bad3c551b1ac78eb42819178141353aefbf9a6186bd986175
+  data.tar.gz: d7f127460c9daedbe0bfe7e5902cc40196cd8e383a29c971ae0241ae76978f28
 SHA512:
-  metadata.gz: 67e6bf9497c126a6c00fb008d0341a7f1d8a1a792974fa7196d1c0a2eccf2e8beeb19485c9b4441f3c4e7eccd2a073fc82131ccccb900e77b3b1c8cba0faff0d
-  data.tar.gz: 45769e10d0434c05e2c87a0fcb545bb6d225839a7fbd9e951be26b6ffa6c6769e052118b30b6cef93d170ef2a74002f8ae80ed1300a944756030846e25d705f8
+  metadata.gz: 10690a7a9e253d00f7ca60d36358893248cd111a07b28918564b1dd79e2f19dcf77ea5d980c905005d05c1f2ed8aba395c595c3af3426c76c431062405f3eb86
+  data.tar.gz: 369af054ddaaeaae52e347ec02a49b26edff5f2b9c1b88c39c4b7061c68ec64ad091d052b193828034bd2f3d6165550fc920f752524ccbe70c8dc828d71beec1

data/lib/firespring_dev_commands/audit/report.rb

@@ -3,11 +3,12 @@ module Dev
   class Audit
     # The class containing standardized information about an audit report
     class Report
-      attr_accessor :items, :min_severity, :ignorelist, :filtered_items
+      attr_accessor :items, :min_severity, :error_on_unknown, :ignorelist, :filtered_items
 
       def initialize(
         items,
         min_severity: ENV.fetch('MIN_SEVERITY', nil),
+        error_on_unknown: ENV.fetch('ERROR_ON_UNKNOWN', nil),
         ignorelist: ENV['IGNORELIST'].to_s.split(/\s*,\s*/)
       )
         # Items should be an array of Item objects
@@ -15,12 +16,18 @@ module Dev
         raise 'items must all be report items' unless @items.all?(Dev::Audit::Report::Item)
 
         @min_severity = min_severity || Level::HIGH
+        @error_on_unknown = error_on_unknown
         @ignorelist = Array(ignorelist).compact
       end
 
       # Get all severities greater than or equal to the minimum severity
       def desired_severities
-        LEVELS.slice(LEVELS.find_index(min_severity)..-1)
+        max_severity = if error_on_unknown.to_s.strip == 'true'
+                         -1
+                       else
+                         -2
+                       end
+        LEVELS.slice(LEVELS.find_index(min_severity)..max_severity)
       end
 
       # Run the filters against the report items and filter out any which should be excluded

data/lib/firespring_dev_commands/aws/account.rb

@@ -3,8 +3,7 @@ module Dev
     # Class containing useful methods for interacting with the Aws account
     class Account
       # Config object for setting top level Aws account config options
-      # TODO: registry is deprecated and should be removed on the next major release
-      Config = Struct.new(:root, :children, :default, :registry, :ecr_registry_ids, :login_to_account_ecr_registry, :default_login_role_name)
+      Config = Struct.new(:root, :children, :default, :ecr_registry_ids, :login_to_account_ecr_registry, :default_login_role_name)
 
       # Instantiates a new top level config object if one hasn't already been created
       # Yields that config object to any given block
@@ -28,8 +27,7 @@ module Dev
         IniFile.new(filename: CONFIG_FILE, default: 'default')
       end
 
-      # TODO: registry is deprecated and should be removed on the next major release
-      attr_accessor :root, :children, :default, :registry, :ecr_registry_ids
+      attr_accessor :root, :children, :default, :ecr_registry_ids
 
       # Instantiate an account object
       # Requires that root account and at least one child account have been configured
@@ -44,11 +42,9 @@ module Dev
         @default = self.class.config.default
 
         # Create the ecr registry list based off several possible configuration values
-        @ecr_registry_ids = [self.class.config.registry]
+        @ecr_registry_ids = Array(self.class.config.ecr_registry_ids)
         @ecr_registry_ids << Dev::Aws::Profile.new.current if self.class.config.login_to_account_ecr_registry
-        @ecr_registry_ids.concat(Array(self.class.config.ecr_registry_ids))
         @ecr_registry_ids = @ecr_registry_ids.flatten.compact.reject(&:empty?).uniq
-        @registry = @ecr_registry_ids.first
       end
 
       # Returns all configured account information objects

data/lib/firespring_dev_commands/aws/login.rb

@@ -116,17 +116,6 @@ module Dev
         ENV['ECR_REGISTRY'] ||= registry
       end
 
-      # Authroizes the docker cli to pull/push images from the Aws container registry
-      # (e.g. if docker compose needs to pull an image)
-      # @deprecated Please use {Dev::Aws::Login#registry_login!} instead
-      def docker_login!(registry_id: nil, region: nil)
-        registry_id ||= Dev::Aws::Account.new.ecr_registry_ids.first
-        region ||= Dev::Aws::Credentials.new.logged_in_region || Dev::Aws::DEFAULT_REGION
-        warn '[DEPRECATION] `Dev::Aws::Login#docker_login!` is deprecated. Please use `Dev::Aws::Login#registry_login!` instead.'
-        docker_cli_login!(registry: "#{registry_id}.dkr.ecr.#{region}.amazonaws.com", region:)
-        puts
-      end
-
       # Authroizes the docker cli to pull/push images from the Aws container registry
       # (e.g. if docker compose needs to pull an image)
       private def docker_cli_login!(registry:, region:)
@@ -137,15 +126,6 @@ module Dev
         Dev::Common.new.run_command([login_cmd])
       end
 
-      # Authroizes the docker ruby library to pull/push images from the Aws container registry
-      # @deprecated Please use {Dev::Aws::Login#registry_login!} instead
-      def ecr_login!(registry_id: nil, region: nil)
-        registry_id ||= Dev::Aws::Account.new.ecr_registry_ids.first
-        region ||= Dev::Aws::Credentials.new.logged_in_region || Dev::Aws::DEFAULT_REGION
-        warn '[DEPRECATION] `Dev::Aws::Login#ecr_login!` is deprecated. Please use `Dev::Aws::Login#registry_login!` instead.'
-        docker_lib_login!(registry_id:, region:)
-      end
-
       # Authroizes the docker ruby library to pull/push images from the Aws container registry
       private def docker_lib_login!(registry_id:, region:)
         # Grab your authentication token from AWS ECR

data/lib/firespring_dev_commands/bloom_growth/rock.rb

@@ -0,0 +1,34 @@
+module Dev
+  class BloomGrowth
+    # Class containing rock information
+    class Rock
+      attr_accessor :data, :id, :type, :name, :owner, :complete, :completion_id, :created, :due
+      attr_reader :state
+
+      def initialize(data)
+        @data = data
+        @id = data['Id']
+        @type = data['Type']
+        @name = data['Name'].to_s.strip
+        @owner = User.new(data['Owner']) if data['Owner']
+        @complete = data['Complete']
+        @completion_id = data['Completion']
+        @created = Time.parse(data['CreateTime']) if data['CreateTime']
+        @due = Time.parse(data['DueDate']) if data['DueDate']
+        @archived = data['Archived']
+      end
+
+      # Convert the completion_id bloom growth gives us into a text version
+      def state
+        case completion_id
+        when 0
+          'Off Track'
+        when 1
+          'On Track'
+        when 2
+          'Complete'
+        end
+      end
+    end
+  end
+end

data/lib/firespring_dev_commands/bloom_growth/seat.rb

@@ -0,0 +1,16 @@
+module Dev
+  class BloomGrowth
+    # Class containing seat information
+    class Seat
+      attr_accessor :data, :id, :type, :name
+
+      def initialize(data)
+        @data = data
+        position = data.dig('Group', 'Position')
+        @id = position&.fetch('Id')
+        @type = position&.fetch('Type')
+        @name = position&.fetch('Name').to_s.strip
+      end
+    end
+  end
+end

data/lib/firespring_dev_commands/bloom_growth/user.rb

@@ -0,0 +1,43 @@
+module Dev
+  class BloomGrowth
+    # Class containing user information
+    class User
+      attr_accessor :data, :id, :type, :name, :rocks, :direct_reports, :seats
+
+      def initialize(data)
+        @data = data
+        @id = data['Id']
+        @type = data['Type']
+        @name = data['Name'].to_s.strip
+        @rocks = nil
+        @direct_reports = nil
+        @seats = nil
+      end
+
+      def rocks
+        @rocks ||= [].tap do |ary|
+          Dev::BloomGrowth.new.get("/api/v1/rocks/user/#{id}") do |data|
+            ary << Rock.new(data)
+          end
+        end
+      end
+
+      def direct_reports
+        @direct_reports ||= [].tap do |ary|
+          Dev::BloomGrowth.new.get("/api/v1/users/#{id}/directreports") do |data|
+            ary << User.new(data)
+          end
+        end
+      end
+
+      def seats
+        @seats ||= [].tap do |ary|
+          Dev::BloomGrowth.new.get("/api/v1/users/#{id}/seats") do |data|
+            ary << Seat.new(data)
+            puts ary.last.inspect
+          end
+        end
+      end
+    end
+  end
+end

data/lib/firespring_dev_commands/bloom_growth.rb

@@ -0,0 +1,132 @@
+require 'net/http'
+
+module Dev
+  # Class for interacting with the Bloom Growth api
+  class BloomGrowth
+    # The config file to try to load credentials from
+    CONFIG_FILE = "#{Dir.home}/.env.bloom".freeze
+
+    # The text of the username variable key
+    BLOOM_USERNAME = 'BLOOM_USERNAME'.freeze
+
+    # The text of the password variable key
+    BLOOM_PASSWORD = 'BLOOM_PASSWORD'.freeze
+
+    # The text of the token variable key
+    BLOOM_TOKEN = 'BLOOM_TOKEN'.freeze
+
+    # The text of the url variable key
+    BLOOM_URL = 'BLOOM_URL'.freeze
+
+    # Config object for setting top level bloom growth config options
+    Config = Struct.new(:username, :password, :url, :http_debug) do
+      def initialize
+        Dotenv.load(CONFIG_FILE) if File.exist?(CONFIG_FILE)
+
+        self.username = ENV.fetch(BLOOM_USERNAME, nil)
+        self.password = ENV.fetch(BLOOM_PASSWORD, nil)
+        self.url = ENV.fetch(BLOOM_URL, 'https://app.bloomgrowth.com')
+        self.http_debug = false
+      end
+    end
+
+    class << self
+      # Instantiates a new top level config object if one hasn't already been created
+      # Yields that config object to any given block
+      # Returns the resulting config object
+      def config
+        @config ||= Config.new
+        yield(@config) if block_given?
+        @config
+      end
+
+      # Alias the config method to configure for a slightly clearer access syntax
+      alias_method :configure, :config
+    end
+
+    attr_accessor :username, :password, :url, :token, :client, :default_headers
+
+    # Initialize a new target process client using the given inputs
+    def initialize(username: self.class.config.username, password: self.class.config.password, url: self.class.config.url)
+      raise 'username is required' if username.to_s.strip.empty?
+      raise 'password is required' if password.to_s.strip.empty?
+      raise 'url is required' if url.to_s.strip.empty?
+
+      @username = username
+      @password = password
+      @url = url
+      uri = URI.parse(@url)
+      @client = Net::HTTP.new(uri.host, uri.port)
+      @client.use_ssl = true
+      @client.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      @client.set_debug_output(LOG) if self.class.config.http_debug
+      @default_headers = {
+        'authorization' => "Bearer #{token}",
+        'content-type' => 'application/json',
+        'accept' => 'application/json'
+      }
+    end
+
+    # Method for getting a bearer token for the bloom growth api. There are a couple of possible logic paths
+    #   - If a token has already been defined, use it
+    #   - If a token is found in the ENV, use it
+    #   - Otherwise, use the username and passowrd that has been configured to request a new token from bloom
+    def token
+      @token ||= ENV.fetch(BLOOM_TOKEN, nil)
+
+      unless @token
+        response = post(
+          '/Token',
+          {
+            grant_type: 'password',
+            userName: username,
+            password:
+          },
+          headers: {
+            'content-type' => 'application/json',
+            'accept' => 'application/json'
+          }
+        )
+        # TODO: Should we look at https://github.com/DannyBen/lightly for caching the token?
+        @token = ENV[BLOOM_TOKEN] = response['access_token']
+        LOG.info("Retrieved BloomGrowth token. Expires on #{Time.now + response['expires_in']}")
+      end
+
+      @token
+    end
+
+    # Return all user objects visible to the logged in user
+    def visible_users(&)
+      [].tap do |ary|
+        get('/api/v1/users/mineviewable') do |user_data|
+          ary << User.new(user_data)
+        end
+        ary.each(&)
+      end
+    end
+
+    # Perform a get request to the given path using the given query
+    # Call the given block (if present) with each piece of data
+    # Return all pieces of data
+    def get(path, query_string: nil, headers: default_headers, &)
+      url = path
+      url << "?#{URI.encode_www_form(query_string)}" unless query_string.to_s.strip.empty?
+
+      response = client.request_get(url, headers)
+      raise "Error querying #{url} [#{query_string}]: #{response.inspect}" unless response.response.is_a?(Net::HTTPSuccess)
+
+      JSON.parse(response.body).each(&)
+      nil
+    end
+
+    # Perform a post request to the given path using the gien data
+    # Return the parsed json body
+    def post(path, data, headers: default_headers)
+      data = data.to_json unless data.is_a?(String)
+      response = client.request_post(path, data, headers)
+      raise "Error querying #{url}/#{path}: #{response.inspect}" unless response.response.is_a?(Net::HTTPSuccess)
+
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/firespring_dev_commands/common.rb

@@ -37,28 +37,6 @@ module Dev
       output
     end
 
-    # Wraps a block of code in a y/n question.
-    # If the user answers 'y' then the block is executed.
-    # If the user answers 'n' then the block is skipped.
-    # @deprecated Please use {Common#when_confirmed} instead
-    def with_confirmation(message, default = 'y', color_message: true)
-      message = "\n  #{message}" << '? '.light_green
-      message = message.light_green if color_message
-      print message
-      print '('.light_green << 'y'.light_yellow << '/'.light_green << 'n'.light_yellow << ') '.light_green
-
-      answer = default
-      answer = $stdin.gets unless ENV['NON_INTERACTIVE'] == 'true'
-
-      unless answer.strip.casecmp('y').zero?
-        puts "\n  Cancelled.\n".light_yellow
-        exit 1
-      end
-      puts
-
-      yield
-    end
-
     # Exits unless the user confirms they want to continue
     # If the user answers 'y' then the code will continue
     # All other inputs cause the code to exit
@@ -187,5 +165,16 @@ module Dev
         return false
       end
     end
+
+    # Print the given filesize using the most appropriate units
+    def filesize(size)
+      return '0.0 B' if size.to_i.zero?
+
+      units = %w(B KB MB GB TB Pb EB)
+      exp = (Math.log(size) / Math.log(1024)).to_i
+      exp = 6 if exp > 6
+
+      format('%.1f %s', size.to_f / (1024**exp), units[exp])
+    end
   end
 end

data/lib/firespring_dev_commands/coverage/base.rb

@@ -0,0 +1,21 @@
+module Dev
+  module Coverage
+    class Base
+      def php_options
+        raise 'not implemented'
+      end
+
+      def node_options
+        raise 'not implemented'
+      end
+
+      def ruby_options
+        raise 'not implemented'
+      end
+
+      def check(*)
+        raise 'not implemented'
+      end
+    end
+  end
+end

data/lib/firespring_dev_commands/coverage/cobertura.rb

@@ -0,0 +1,86 @@
+module Dev
+  # Module containing different classes for interfacing with coverage files
+  module Coverage
+    # Class for checking code coverage using cobertura
+    class Cobertura < Base
+      attr_reader :local_filename, :container_filename, :filename, :threshold, :exclude
+
+      def initialize(filename: File.join('coverage', 'cobertura.xml'), threshold: nil, container_path: nil, local_path: nil, exclude: nil)
+        super()
+
+        @filename = filename
+        @local_filename = File.join(local_path || '.', @filename)
+        @container_filename = File.join(container_path || '.', @filename)
+        @threshold = threshold
+        @exclude = (exclude || []).map do |it|
+          next it if it.is_a?(Regex)
+
+          Regex.new(it)
+        end
+      end
+
+      # Remove any previous versions of the local file that will be output
+      # return the phpunit options needed to regenerate the cobertura xml file
+      def php_options
+        # Remove any previous coverage info
+        FileUtils.rm_f(local_filename, verbose: true)
+
+        # Return the needed php commands to generate the cobertura report
+        %W(--coverage-cobertura #{container_filename})
+      end
+
+      # Parse the cobertura file and check the lines missed against the desired threshold
+      def check(application: nil)
+        # If an application has been specified and the file does not exist locally, attempt to copy it back from the docker container
+        if application && !File.exist?(local_filename)
+          container = Dev::Docker::Compose.new.container_by_name(application)
+          Dev::Docker.new.copy_from_container(container, container_filename, local_filename, required: true)
+        end
+
+        report = Ox.load(File.read(local_filename))
+        total_missed = report.coverage.locate('packages/package').sum { |package| parse_package_missed(package) }
+        puts "Lines missing coverage was #{total_missed}"
+        puts "Configured threshold was #{threshold}" if threshold
+        raise 'Code coverage not met' if threshold && total_missed > threshold
+      end
+
+      # Go through the package and add up all of the lines that were missed
+      # Ignore if the file was in the exlude list
+      private def parse_package_missed(package)
+        filename =  package.attributes[:name]
+        return if exclude.any? { |it| it.match(filename) }
+
+        missed = 0
+        lines_processed = Set.new
+        package.locate('classes/class/lines/line').each do |line|
+          # Don't count lines multiple times
+          line_number = line.attributes[:number]
+          next if lines_processed.include?(line_number)
+
+          lines_processed << line_number
+          missed += 1 unless line.attributes[:hits].to_i.positive?
+        end
+        total = lines_processed.length
+
+        sanity_check_coverage_against_cobertura_values(package, missed, total)
+        missed
+      end
+
+      # Calculate the coverage percent based off the numbers we got and compare to the
+      # value cobertura reported. This is meant as a sanity check that we are reading the data correctly
+      # TODO: This should be removed after the above logic has been vetted
+      private def sanity_check_coverage_against_cobertura_values(package, missed, total)
+        line_rate = package.attributes[:'line-rate']
+        cobertura_reported_coverage = line_rate.to_f
+        cobertura_reported_precision = line_rate.split('.').last.length
+
+        file_coverage = 0.0
+        file_coverage = ((total - missed).to_f / total).round(cobertura_reported_precision) if total.positive?
+        return if file_coverage == cobertura_reported_coverage
+
+        filename = package.attributes[:name]
+        puts "WARNINNG: #{filename} coverage (#{file_coverage}) differed from what cobertura reported (#{cobertura_reported_coverage})"
+      end
+    end
+  end
+end

data/lib/firespring_dev_commands/coverage/none.rb

@@ -0,0 +1,25 @@
+module Dev
+  module Coverage
+    class None < Base
+      def initialize(*)
+        super()
+      end
+
+      def php_options
+        []
+      end
+
+      def node_options
+        []
+      end
+
+      def ruby_options
+        []
+      end
+
+      def check(*)
+        # Nothing to do here
+      end
+    end
+  end
+end

data/lib/firespring_dev_commands/docker.rb

@@ -77,6 +77,22 @@ module Dev
       _prune('volumes', opts:)
     end
 
+    def prune_project_volumes(project_name:)
+      project_name = project_name.to_s.strip
+      raise 'No project name defined' if project_name.empty?
+
+      ::Docker::Volume.all.each do |volume|
+        next unless volume.info['Name'].start_with?(project_name)
+
+        begin
+          volume.remove
+          LOG.info "Removed volume #{volume.id[0, 12]}"
+        rescue => e
+          LOG.error "Error removing volume #{volume.id[0, 12]}: #{e}"
+        end
+      end
+    end
+
     # Prunes/removes all unused images
     def prune_images
       _prune('images')
@@ -103,18 +119,7 @@ module Dev
       LOG.info "\nDeleted #{type.capitalize}"
       deleted_items = info["#{type}Deleted"] || []
       deleted_items.each { |it| LOG.info "  #{it}" }
-      LOG.info "Total reclaimed space: #{filesize(info['SpaceReclaimed'])}"
-    end
-
-    # Print the given filesize using the most appropriate units
-    private def filesize(size)
-      return '0.0 B' if size.to_i.zero?
-
-      units = %w(B KB MB GB TB Pb EB)
-      exp = (Math.log(size) / Math.log(1024)).to_i
-      exp = 6 if exp > 6
-
-      format('%.1f %s', size.to_f / (1024**exp), units[exp])
+      LOG.info "Total reclaimed space: #{Dev::Common.new.filesize(info['SpaceReclaimed'])}"
     end
 
     # Remove docker images with the "force" option set to true
@@ -124,22 +129,14 @@ module Dev
       ::Docker::Image.remove(images[0].id, force: true) unless images.empty?
     end
 
-    # Calls the docker compose method with the given inputs
-    # @deprecated Please use {Docker::Compose#container_by_name} instead
-    def container_by_name(service_name, prefix = nil, status: [Docker::Status::RUNNING])
-      warn '[DEPRECATION] `Docker#container_by_name` is deprecated.  Please use `Docker::Compose#container_by_name` instead.'
-      Docker::Compose.new.container_by_name(service_name, prefix, status)
-    end
-
-    # Calls the docker compose method with the given inputs
-    # @deprecated Please use {Docker::Compose#mapped_public_port} instead
-    def mapped_public_port(name, private_port)
-      warn '[DEPRECATION] `Docker#mapped_public_port` is deprecated.  Please use `Docker::Compose#mapped_public_port` instead.'
-      Docker::Compose.new.mapped_public_port(name, private_port)
+    # Gets the default working dir of the container
+    def working_dir(container)
+      container.json['Config']['WorkingDir']
     end
 
     # Copies the source path on your local machine to the destination path on the container
     def copy_to_container(container, source_path, dest_path)
+      dest_path = File.join(working_dir(container), dest_path) unless dest_path.start_with?(File::SEPARATOR)
       LOG.info "Copying #{source_path} to #{dest_path}... "
 
       container.archive_in(source_path, dest_path, overwrite: true)
@@ -154,6 +151,7 @@ module Dev
     # Copies the source path on the container to the destination path on your local machine
     # If required is set to true, the command will fail if the source path does not exist on the container
     def copy_from_container(container, source_path, dest_path, required: true)
+      source_path = File.join(working_dir(container), source_path) unless source_path.start_with?(File::SEPARATOR)
       LOG.info "Copying #{source_path} to #{dest_path}... "
 
       tar = StringIO.new
@@ -205,7 +203,7 @@ module Dev
         arch = "#{arch}/#{variant}" if variant
         id = image.info&.dig('id')&.split(':')&.last&.slice(0..11)
         created = timesince(Time.at(image.info&.dig('Created')))
-        size = filesize(image.info&.dig('Size'))
+        size = Dev::Common.new.filesize(image.info&.dig('Size'))
 
         repo_urls = image.info&.dig('RepoTags')
         repo_urls ||= ["#{image.info&.dig('RepoDigests')&.first&.split(':')&.first&.split('@')&.first}:<none>"]