skylight 4.2.3 → 5.3.0

data/lib/skylight/cli/doctor.rb

@@ -24,7 +24,9 @@ module Skylight
                   say "Please update your certificates with RVM by running `rvm osx-ssl-certs update all`.", :yellow
                   say "Alternatively, try setting `SKYLIGHT_FORCE_OWN_CERTS=1` in your environment.", :yellow
                 else
-                  say "Please update your local certificates or try setting `SKYLIGHT_FORCE_OWN_CERTS=1` in your environment.", :yellow
+                  say "Please update your local certificates or try setting `SKYLIGHT_FORCE_OWN_CERTS=1` in your " \
+                        "environment.",
+                      :yellow
                 end
               end
             else
@@ -63,11 +65,9 @@ module Skylight
             say "Unable to load native extension", :yellow
 
             indent do
-              install_log = File.expand_path("../../ext/install.log", __dir__)
+              install_log = File.expand_path("../../../ext/install.log", __dir__)
               if File.exist?(install_log)
-                File.readlines(install_log).each do |line|
-                  say line, :red
-                end
+                File.readlines(install_log).each { |line| say line, :red }
               else
                 say "Reason unknown", :red
               end
@@ -84,20 +84,18 @@ module Skylight
         say "Checking for valid configuration"
 
         indent do
-          begin
-            config.validate!
-            say "Configuration is valid", :green
-          rescue Core::ConfigError => e
-            encountered_error!
-
-            say "Configuration is invalid", :red
-            indent do
-              say e.message, :red
-              say "This may occur if you are configuring with ENV variables and didn't set them in this shell."
-            end
-
-            done!
+          config.validate!
+          say "Configuration is valid", :green
+        rescue ConfigError => e
+          encountered_error!
+
+          say "Configuration is invalid", :red
+          indent do
+            say e.message, :red
+            say "This may occur if you are configuring with ENV variables and didn't set them in this shell."
           end
+
+          done!
         end
 
         puts "\n"
@@ -109,16 +107,19 @@ module Skylight
         indent do
           # Set this after we validate. It will give us more detailed information on start.
           logger = Logger.new("/dev/null") # Rely on `say` in the formatter instead
+
           # Log everything
           logger.level = Logger::DEBUG
+
           # Remove excess formatting
-          logger.formatter = proc { |severity, _datetime, _progname, msg|
-            msg = msg.sub("[SKYLIGHT] [#{Skylight::VERSION}] ", "")
-            say "#{severity} - #{msg}" # Definitely non-standard
-          }
+          logger.formatter =
+            proc do |severity, _datetime, _progname, msg|
+              msg = msg.sub("[SKYLIGHT] [#{Skylight::VERSION}] ", "")
+              say "#{severity} - #{msg}" # Definitely non-standard
+            end
           config.logger = logger
 
-          config.set(:'daemon.lazy_start', false)
+          config.set(:"daemon.lazy_start", false)
 
           started = Skylight.start!(config)
 
@@ -166,57 +167,55 @@ module Skylight
 
       private
 
-        # Overwrite the default helper method to load from Rails
-        def config
-          return @config if @config
+      # Overwrite the default helper method to load from Rails
+      def config
+        return @config if @config
 
-          # MEGAHAX
-          if rails?
-            # Normally auto-loaded, but we haven't loaded Rails by the time Skylight is loaded
-            require "skylight/railtie"
-            require rails_rb
-
-            railtie = Skylight::Railtie.send(:new)
-            @config = railtie.send(:load_skylight_config, Rails.application)
-          else
-            super
-          end
-        end
+        # MEGAHAX
+        if rails?
+          # Normally auto-loaded, but we haven't loaded Rails by the time Skylight is loaded
+          require "skylight/railtie"
+          require rails_rb
 
-        def mac?
-          Util::Platform::OS == "darwin"
+          railtie = Skylight::Railtie.send(:new)
+          @config = railtie.send(:load_skylight_config, Rails.application)
+        else
+          super
         end
+      end
 
-        # NOTE: This check won't work correctly on Windows
-        def rvm_present?
-          if @has_rvm.nil?
-            @has_rvm = system("which rvm > /dev/null")
-          end
-          @has_rvm
-        end
+      def mac?
+        Util::Platform::OS == "darwin"
+      end
 
-        def encountered_error!
-          @has_errors = true
-        end
+      # NOTE: This check won't work correctly on Windows
+      def rvm_present?
+        @has_rvm = system("which rvm > /dev/null") if @has_rvm.nil?
+        @has_rvm
+      end
 
-        def has_errors?
-          @has_errors
-        end
+      def encountered_error!
+        @has_errors = true
+      end
 
-        def done!
-          shell.padding = 0
-          say "\n\n"
+      def has_errors?
+        @has_errors
+      end
 
-          if has_errors?
-            say "Skylight Doctor found some errors. Please review the output above.", :red
-            say "If you have any further questions, please contact support@skylight.io.", :yellow
-            exit 1
-          else
-            say "All checks passed!", :green
-            say "If you're still having trouble, please contact support@skylight.io.", :yellow
-            exit 0
-          end
+      def done!
+        shell.padding = 0
+        say "\n\n"
+
+        if has_errors?
+          say "Skylight Doctor found some errors. Please review the output above.", :red
+          say "If you have any further questions, please contact support@skylight.io.", :yellow
+          exit 1
+        else
+          say "All checks passed!", :green
+          say "If you're still having trouble, please contact support@skylight.io.", :yellow
+          exit 0
         end
+      end
     end
   end
 end

data/lib/skylight/cli/helpers.rb

@@ -3,28 +3,28 @@ module Skylight
     module Helpers
       private
 
-        # Duplicated below
-        def rails_rb
-          File.expand_path("config/application.rb")
-        end
+      # Duplicated below
+      def rails_rb
+        File.expand_path("config/application.rb")
+      end
 
-        def rails?
-          File.exist?(rails_rb)
-        end
+      def rails?
+        File.exist?(rails_rb)
+      end
 
-        def config
-          # Calling .load checks ENV variables
-          @config ||= Config.load
-        end
+      def config
+        # Calling .load checks ENV variables
+        @config ||= Config.load
+      end
 
-        # Sets the output padding while executing a block and resets it.
-        #
-        def indent(count = 1)
-          orig_padding = shell.padding
-          shell.padding += count
-          yield
-          shell.padding = orig_padding
-        end
+      # Sets the output padding while executing a block and resets it.
+      #
+      def indent(count = 1)
+        orig_padding = shell.padding
+        shell.padding += count
+        yield
+        shell.padding = orig_padding
+      end
     end
   end
 end

data/lib/skylight/cli/merger.rb

@@ -23,8 +23,8 @@ module Skylight
         say "\nHello! Welcome to the `skylight merge` CLI!\n", :green
 
         say "This CLI is for Skylight users who already have Skylight Environments set up\n" \
-          "using the legacy method of creating a separate Skylight app per environment.\n" \
-          "Use this CLI to merge legacy environment apps into their parent apps as Environments."
+              "using the legacy method of creating a separate Skylight app per environment.\n" \
+              "Use this CLI to merge legacy environment apps into their parent apps as Environments."
       end
 
       def fetch_apps
@@ -40,23 +40,24 @@ module Skylight
       rescue Skylight::Api::Unauthorized
         done!(
           success: false,
-          message: "Provided merge token is invalid.\n" \
-            "Please #{STRINGS[:get_token]}" \
-            "and run `skylight merge <merge token>` again."
+          message:
+            "Provided merge token is invalid.\n" \
+              "Please #{STRINGS[:get_token]}" \
+              "and run `skylight merge <merge token>` again."
         )
       end
 
       def ask_for_parent_app
-        @parents ||= begin
-          a = (@apps + [{ name: STRINGS[:unlisted], components: [], unlisted: true }])
-          a.each_with_object({}).with_index do |(app, h), i|
-            h[i + 1] = OpenStruct.new(app)
+        @parents ||=
+          begin
+            a = (@apps + [{ name: STRINGS[:unlisted], components: [], unlisted: true }])
+            a.each_with_object({}).with_index { |(app, h), i| h[i + 1] = OpenStruct.new(app) }
           end
-        end
 
         say "\nLet's begin!\n\n" \
-          "Please specify the \"parent\" app.\n" \
-          "In most cases, this will be the production app handling web requests.", :green
+              "Please specify the \"parent\" app.\n" \
+              "In most cases, this will be the production app handling web requests.",
+            :green
 
         @parent_app = ask_for_app(@parents)
       end
@@ -76,8 +77,9 @@ module Skylight
 
       def ask_for_child_env
         say "\nWhat environment is the child app?\n" \
-          "In many cases, this will be equivalent to the Rails " \
-          "environment, i.e., `development`.", :green
+              "In many cases, this will be equivalent to the Rails " \
+              "environment, i.e., `development`.",
+            :green
 
         say "1. development"
         say "2. staging"
@@ -85,15 +87,18 @@ module Skylight
 
         i = ask("\nWhich number?").chomp.to_i
 
-        @child_env = case i
-                     when 1 then "development"
-                     when 2 then "staging"
-                     when 3
-                       specify_child_env
-                     else
-                       say("\nEh? Please enter 1, 2, or 3.", :red)
-                       ask_for_child_env
-                     end
+        @child_env =
+          case i
+          when 1
+            "development"
+          when 2
+            "staging"
+          when 3
+            specify_child_env
+          else
+            say("\nEh? Please enter 1, 2, or 3.", :red)
+            ask_for_child_env
+          end
       end
 
       def confirm_child_env
@@ -102,7 +107,7 @@ module Skylight
 
       def confirm_everything
         say "\nOk! Now we're going to merge `#{set_color(format_component(@child_app), :yellow)}` " \
-          "into `#{set_color(@parent_app.name, :green)}` as `#{set_color(@child_env, :yellow)}`."
+              "into `#{set_color(@parent_app.name, :green)}` as `#{set_color(@child_env, :yellow)}`."
       end
 
       def do_confirm
@@ -112,10 +117,7 @@ module Skylight
         when "Y", ""
           do_merge
         when "N"
-          done!(
-            success: true,
-            message: "Ok, come back any time."
-          )
+          done!(success: true, message: "Ok, come back any time.")
         else
           say("Please respond 'Y' to merge or 'n' to cancel.", :red)
           do_confirm
@@ -128,37 +130,43 @@ module Skylight
         say "=======================================================\n", :yellow
 
         say "IMPORTANT!\n" \
-          "If you use a config/skylight.yml file to configure Skylight:\n", :yellow
+              "If you use a config/skylight.yml file to configure Skylight:\n",
+            :yellow
 
         say "The #{@child_env} environment for the #{@parent_app.name} app\n" \
-          "will now connect using the default authentication token for the app.\n" \
-          "Remove any environment-specific `authentication` configs from the\n" \
-          "#{@parent_app.name} #{@child_env} environment.\n", :yellow
+              "will now connect using the default authentication token for the app.\n" \
+              "Remove any environment-specific `authentication` configs from the\n" \
+              "#{@parent_app.name} #{@child_env} environment.\n",
+            :yellow
 
         say "If you're running in Rails and your Rails environment exactly matches `#{@child_env}`,\n" \
-          "we will automatically detect and report that environment when your agent connects.\n" \
-          "Otherwise, you should set `env: '#{@child_env}'` as environment-specific configuration for\n" \
-          "#{@child_env}'s Rails environment. For example:\n" \
-          "```yml\n" \
-          "staging:\n" \
-          "  env: staging-42\n" \
-          "```\n", :yellow
+              "we will automatically detect and report that environment when your agent connects.\n" \
+              "Otherwise, you should set `env: '#{@child_env}'` as environment-specific configuration for\n" \
+              "#{@child_env}'s Rails environment. For example:\n" \
+              "```yml\n" \
+              "staging:\n" \
+              "  env: staging-42\n" \
+              "```\n",
+            :yellow
 
         say "=======================================================\n", :yellow
 
         say "IMPORTANT!\n" \
-            "If you configure Skylight using environment variables:\n", :yellow
+              "If you configure Skylight using environment variables:\n",
+            :yellow
 
         say "Deploy the latest agent before updating your environment variables.\n", :yellow
 
         say "The #{@child_env} environment for the #{@parent_app.name} app\n" \
-          "will now connect using the default authentication token for the app.\n" \
-          "Set `SKYLIGHT_AUTHENTICATION` in the #{@child_env} environment to the\n" \
-          "#{@parent_app.name} app's authentication token.\n", :yellow
+              "will now connect using the default authentication token for the app.\n" \
+              "Set `SKYLIGHT_AUTHENTICATION` in the #{@child_env} environment to the\n" \
+              "#{@parent_app.name} app's authentication token.\n",
+            :yellow
 
         say "If you're running in Rails and your Rails environment exactly matches `#{@child_env}`,\n" \
-          "we will automatically detect and report that environment when your agent connects.\n" \
-          "Otherwise, you should set `SKYLIGHT_ENV=#{@child_env}` when running in this environment.\n", :yellow
+              "we will automatically detect and report that environment when your agent connects.\n" \
+              "Otherwise, you should set `SKYLIGHT_ENV=#{@child_env}` when running in this environment.\n",
+            :yellow
 
         say "=======================================================", :yellow
 
@@ -167,134 +175,130 @@ module Skylight
 
       private
 
-        def do_merge
-          say "Merging..."
+      def do_merge
+        say "Merging..."
 
-          api.merge_apps!(@merge_token,
-                          app_guid: @parent_app.guid,
-                          component_guid: @child_app.guid,
-                          environment: @child_env)
-        rescue => e
-          say("Something went wrong. Please contact support@skylight.io for more information.", :red)
-          done!(message: e.message, success: false)
-        end
+        api.merge_apps!(
+          @merge_token,
+          app_guid: @parent_app.guid,
+          component_guid: @child_app.guid,
+          environment: @child_env
+        )
+      rescue StandardError => e
+        say("Something went wrong. Please contact support@skylight.io for more information.", :red)
+        done!(message: e.message, success: false)
+      end
 
-        def done!(message: nil, success: true)
-          shell.padding = 0
-          say "\n"
+      def done!(message: nil, success: true)
+        shell.padding = 0
+        say "\n"
 
-          if success
-            say(message, :green) if message
-            say "If you have any questions, please contact support@skylight.io.", :green
-            exit 0
-          else
-            say message || "Skylight wasn't able to merge your apps.", :red
-            say "If you have any questions, please contact support@skylight.io.", :yellow
-            exit 1
-          end
+        if success
+          say(message, :green) if message
+          say "If you have any questions, please contact support@skylight.io.", :green
+          exit 0
+        else
+          say message || "Skylight wasn't able to merge your apps.", :red
+          say "If you have any questions, please contact support@skylight.io.", :yellow
+          exit 1
         end
+      end
 
-        def ask_for_app(app_list, &formatter)
-          formatter ||= :name.to_proc
-          app_list.each do |index, app|
-            say("\t#{index}. #{formatter.call(app)}")
-          end
+      def ask_for_app(app_list, &formatter)
+        formatter ||= :name.to_proc
+        app_list.each { |index, app| say("\t#{index}. #{formatter.call(app)}") }
 
-          n = ask("\nWhich number?").chomp.to_i
+        n = ask("\nWhich number?").chomp.to_i
 
-          if !app_list.key?(n)
-            say "\nHmm?"
-            ask_for_app(app_list, &formatter)
-          elsif app_list[n].unlisted
-            done!(
-              success: false,
-              message: "Sorry, `skylight merge` is only able to merge apps that you own."
-            )
-          else
-            app_list[n]
-          end
+        if !app_list.key?(n)
+          say "\nHmm?"
+          ask_for_app(app_list, &formatter)
+        elsif app_list[n].unlisted
+          done!(success: false, message: "Sorry, `skylight merge` is only able to merge apps that you own.")
+        else
+          app_list[n]
         end
+      end
 
-        def api
-          @api ||= Skylight::Api.new(config)
-        end
+      def api
+        @api ||= Skylight::Api.new(config)
+      end
 
-        def format_component(component)
-          parts = [].tap do |ary|
+      def format_component(component)
+        parts =
+          [].tap do |ary|
             ary << component.name unless component.name == "web"
             ary << component.environment unless component.environment == "production"
           end
 
-          str = ""
-          str << component.app_name
-          str << Thor::Shell::Color.new.set_color(" (#{parts.join(':')})", :yellow) if parts.any?
-          str
-        end
+        str = ""
+        str << component.app_name
+        str << Thor::Shell::Color.new.set_color(" (#{parts.join(":")})", :yellow) if parts.any?
+        str
+      end
 
-        def validate_mergeability(child_app, child_env)
-          errors = []
+      def validate_mergeability(child_app, child_env)
+        errors = []
 
-          unless valid_component?(child_app.name, child_env)
-            errors << "Environment can only contain letters, numbers, and hyphens."
-          end
+        unless valid_component?(child_app.name, child_env)
+          errors << "Environment can only contain letters, numbers, and hyphens."
+        end
 
-          if @parent_app && parent_component_fingerprints.include?([child_app.name, child_env])
-            errors << "Sorry, `#{@parent_app.name}` already has a `#{child_env}` " \
+        if @parent_app && parent_component_fingerprints.include?([child_app.name, child_env])
+          errors <<
+            "Sorry, `#{@parent_app.name}` already has a `#{child_env}` " \
               "component that conflicts with this merge request. Please choose a new environment."
-          end
+        end
 
-          return child_env unless errors.any?
+        return child_env unless errors.any?
 
-          say errors.join("\n"), :red
+        say errors.join("\n"), :red
 
-          yield
-        end
+        yield
+      end
 
-        def valid_component?(component_name, env)
-          return false unless env
-          Skylight::Util::Component.new(env, component_name) && true
-        rescue ArgumentError
-          false
-        end
+      def valid_component?(component_name, env)
+        return false unless env
 
-        def parent_component_fingerprints
-          @parent_app.components.map { |x| x.values_at("name", "environment") }
-        end
+        Util::Component.new(env, component_name) && true
+      rescue ArgumentError
+        false
+      end
+
+      def parent_component_fingerprints
+        @parent_app.components.map { |x| x.values_at("name", "environment") }
+      end
 
-        def children
-          ret = Enumerator.new do |yielder|
+      def children
+        ret =
+          Enumerator.new do |yielder|
             @parents.each do |_, app|
               next if app == @parent_app
-              app.components.each do |component|
-                yielder << OpenStruct.new({ app_name: app.name }.merge(component))
-              end
+
+              app.components.each { |component| yielder << OpenStruct.new({ app_name: app.name }.merge(component)) }
             end
 
             yielder << OpenStruct.new(app_name: STRINGS[:unlisted], unlisted: true)
           end
 
-          ret = ret.each_with_object({}).with_index do |(c, r), i|
-            r[i + 1] = c
-          end
+        ret = ret.each_with_object({}).with_index { |(c, r), i| r[i + 1] = c }
 
-          ret.tap do |result|
-            if result.values.all?(&:unlisted)
-              done!(
-                success: false,
-                message: "Sorry, you do not have any apps that can be merged into `#{@parent_app.name}`"
-              )
-            end
+        ret.tap do |result|
+          if result.values.all?(&:unlisted)
+            done!(
+              success: false,
+              message: "Sorry, you do not have any apps that can be merged into `#{@parent_app.name}`"
+            )
           end
         end
+      end
 
-        def specify_child_env
-          validate_mergeability(
-            @child_app,
-            ask("Please enter your environment name (only lowercase letters, numbers, or hyphens): ", :green).chomp
-          ) do
-            specify_child_env
-          end
-        end
+      def specify_child_env
+        validate_mergeability(
+          @child_app,
+          ask("Please enter your environment name (only lowercase letters, numbers, or hyphens): ", :green).chomp
+        ) { specify_child_env }
+      end
     end
   end
 end