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

data/lib/firespring_dev_commands/coverage/cobertura.rb

@@ -1,86 +0,0 @@
-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

@@ -1,21 +0,0 @@
-module Dev
-  # Module with a variety of coverage methods for different languages
-  module Coverage
-    # Class which provides methods to effectvely skip coverage
-    class None < Base
-      def initialize(*)
-        super()
-      end
-
-      # Returns the php options for generating code coverage file
-      def php_options
-        []
-      end
-
-      # Checks the code coverage against the defined threshold
-      def check(*)
-        puts 'Coverage not configured'
-      end
-    end
-  end
-end

data/lib/firespring_dev_commands/docker/desktop.rb

@@ -1,59 +0,0 @@
-module Dev
-  class Docker
-    # Class for configuring docker desktop
-    # This is mostly around configuring the docker URL correctly
-    class Desktop
-      # A snippet of a docker compose file which forwards a socket to a local port so that we can read it in the docker library
-      WIN_TCP_COMPOSE_CONTENT = "
----
-version: '3.8'
-services:
-  windows_tcp:
-    image: alpine/socat
-    network_mode: bridge
-    ports:
-      - 127.0.0.1:23750:2375
-    volumes:
-      - /var/run/docker.sock:/var/run/docker.sock
-    command: tcp-listen:2375,reuseaddr,fork unix-connect:/var/run/docker.sock
-    restart: always".freeze
-
-      # Set up the local ports/sockets correctly based off of the os type
-      def configure
-        if Dev::Os.new.windows?
-          # Start up a small proxy container if running Docker Desktop on windows
-          # This is needed because the docker api library cannot connect to the windows socket
-          unless Dev::Port.new('127.0.0.1', 23_750).open?
-            LOG.info('Starting local proxy port for docker')
-
-            # Write the compose data to a tmp file
-            tmp_compose_file = Tempfile.new('windows_tcp')
-            tmp_compose_file.write(WIN_TCP_COMPOSE_CONTENT)
-            tmp_compose_file.close
-
-            # Start up the container
-            Dev::Docker::Compose.new(
-              compose_files: tmp_compose_file.path,
-              options: ['--detach'],
-              project_name: 'proxy'
-            ).up
-
-            # Wait 1 second before we continue
-            sleep 1
-          end
-
-          # Configure the docker url to use 23750 on windows
-          ::Docker.url = 'tcp://127.0.0.1:23750'
-
-        else
-          # If a user based socket has been defined, default to that
-          ::Docker.url = if File.exist?("/#{Dir.home}/.docker/run/docker.sock")
-                           "unix://#{Dir.home}/.docker/run/docker.sock"
-                         elsif File.exist?("/#{Dir.home}/.docker/desktop/docker.sock")
-                           "unix://#{Dir.home}/.docker/desktop/docker.sock"
-                         end
-        end
-      end
-    end
-  end
-end

data/lib/firespring_dev_commands/os.rb

@@ -1,35 +0,0 @@
-module Dev
-  # Class containing methods for determining operating system information
-  class Os
-    attr_accessor :os
-
-    def initialize
-      @os = ::RbConfig::CONFIG['host_os']
-    end
-
-    # Returns true if the host_os contains windowsy text
-    def windows?
-      os.match?(/(mingw|mswin|windows)/i)
-    end
-
-    # Returns true if the host_os contains darwinsy text
-    def darwin?
-      os.match?(/(darwin|mac os)/i)
-    end
-
-    # Returns true if the host_os contains macsy text
-    def mac?
-      darwin?
-    end
-
-    # Returns true if the host_os contains nixy text
-    def nix?
-      os.match?(/(linux|bsd|aix|solaris)/i)
-    end
-
-    # Returns true if the host_os contains cygwiny text
-    def cygwin?
-      os.match?(/(cygwin)/i)
-    end
-  end
-end

data/lib/firespring_dev_commands/port.rb

@@ -1,24 +0,0 @@
-module Dev
-  # Class containing methods for actions to be taken on ports
-  class Port
-    attr_accessor :ip_address, :port
-
-    def initialize(ip_address, port)
-      @ip_address = ip_address
-      @port = port
-    end
-
-    # Returns true if the port is open
-    # Returns false otherwise
-    def open?(timeout = 1)
-      Timeout.timeout(timeout) do
-        TCPSocket.new(ip_address, port).close
-        return true
-      end
-
-      false
-    rescue Timeout::Error, Errno::ECONNREFUSED, Errno::EHOSTUNREACH
-      false
-    end
-  end
-end

data/lib/firespring_dev_commands/templates/certificate.rb

@@ -1,41 +0,0 @@
-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