scan 0.0.1 → 0.1.0

data/lib/scan/manager.rb

@@ -0,0 +1,13 @@
+module Scan
+  class Manager
+    def work(options)
+      Scan.config = options
+
+      FastlaneCore::PrintTable.print_values(config: options,
+                                         hide_keys: [:destination, :slack_url],
+                                             title: "Summary for scan #{Scan::VERSION}")
+
+      return Runner.new.run
+    end
+  end
+end

data/lib/scan/options.rb

@@ -0,0 +1,115 @@
+require "fastlane_core"
+require "credentials_manager"
+
+module Scan
+  class Options
+    def self.available_options
+      [
+        FastlaneCore::ConfigItem.new(key: :workspace,
+                                     short_option: "-w",
+                                     env_name: "SCAN_WORKSPACE",
+                                     optional: true,
+                                     description: "Path the workspace file",
+                                     verify_block: proc do |value|
+                                       v = File.expand_path(value.to_s)
+                                       raise "Workspace file not found at path '#{v}'".red unless File.exist?(v)
+                                       raise "Workspace file invalid".red unless File.directory?(v)
+                                       raise "Workspace file is not a workspace, must end with .xcworkspace".red unless v.include?(".xcworkspace")
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :project,
+                                     short_option: "-p",
+                                     optional: true,
+                                     env_name: "SCAN_PROJECT",
+                                     description: "Path the project file",
+                                     verify_block: proc do |value|
+                                       v = File.expand_path(value.to_s)
+                                       raise "Project file not found at path '#{v}'".red unless File.exist?(v)
+                                       raise "Project file invalid".red unless File.directory?(v)
+                                       raise "Project file is not a project file, must end with .xcodeproj".red unless v.include?(".xcodeproj")
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :device,
+                                     short_option: "-a",
+                                     optional: true,
+                                     is_string: false,
+                                     env_name: "SCAN_DEVICE",
+                                     description: "The name of the simulator type you want to run tests on",
+                                     verify_block: proc do |value|
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :scheme,
+                                     short_option: "-s",
+                                     optional: true,
+                                     env_name: "SCAN_SCHEME",
+                                     description: "The project's scheme. Make sure it's marked as `Shared`"),
+        FastlaneCore::ConfigItem.new(key: :clean,
+                                     short_option: "-c",
+                                     env_name: "SCAN_CLEAN",
+                                     description: "Should the project be cleaned before building it?",
+                                     is_string: false,
+                                     default_value: false),
+        FastlaneCore::ConfigItem.new(key: :output_directory,
+                                     short_option: "-o",
+                                     env_name: "SCAN_OUTPUT_DIRECTORY",
+                                     description: "The directory in which all reports will be stored",
+                                     default_value: "./test_output"),
+        FastlaneCore::ConfigItem.new(key: :output_types,
+                                     short_option: "-f",
+                                     env_name: "SCAN_OUTPUT_TYPES",
+                                     description: "Comma seperated list of the output types (e.g. html, junit)",
+                                     default_value: "html,junit"),
+        FastlaneCore::ConfigItem.new(key: :buildlog_path,
+                                     short_option: "-l",
+                                     env_name: "SCAN_BUILDLOG_PATH",
+                                     description: "The directory were to store the raw log",
+                                     default_value: "~/Library/Logs/scan"),
+        FastlaneCore::ConfigItem.new(key: :sdk,
+                                     short_option: "-k",
+                                     env_name: "SCAN_SDK",
+                                     description: "The SDK that should be used for building the application",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :skip_html_open,
+                                     short_option: "-g",
+                                     env_name: "SCAN_SKIP_HTML_OPEN",
+                                     description: "Don't open the HTML report when tests are completed",
+                                     is_string: false,
+                                     default_value: false),
+        FastlaneCore::ConfigItem.new(key: :configuration,
+                                     short_option: "-q",
+                                     env_name: "SCAN_CONFIGURATION",
+                                     description: "The configuration to use when building the app. Defaults to 'Release'",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :destination,
+                                     short_option: "-d",
+                                     env_name: "SCAN_DESTINATION",
+                                     description: "Use only if you're a pro, use the other options instead",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :xcargs,
+                                     short_option: "-x",
+                                     env_name: "SCAN_XCARGS",
+                                     description: "Pass additional arguments to xcodebuild. Be sure to quote the setting names and values e.g. OTHER_LDFLAGS=\"-ObjC -lstdc++\"",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :xcconfig,
+                                     short_option: "-y",
+                                     env_name: "SCAN_XCCONFIG",
+                                     description: "Use an extra XCCONFIG file to build your app",
+                                     optional: true,
+                                     verify_block: proc do |value|
+                                       raise "File not found at path '#{File.expand_path(value)}'".red unless File.exist?(value)
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :slack_url,
+                                     env_name: "SLACK_URL",
+                                     description: "Create an Incoming WebHook for your Slack group to post results there",
+                                     verify_block: proc do |value|
+                                       raise "Invalid URL, must start with https://" unless value.start_with? "https://"
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :skip_slack,
+                                     description: "Don't publish to slack, even when an URL is given",
+                                     is_string: false,
+                                     default_value: false),
+        FastlaneCore::ConfigItem.new(key: :slack_only_on_failure,
+                                    description: "Only post on Slack if the tests fail",
+                                    is_string: false,
+                                    default_value: false)
+      ]
+    end
+  end
+end

data/lib/scan/report_collector.rb

@@ -0,0 +1,48 @@
+module Scan
+  class ReportCollector
+    SUPPORTED = %w(html junit json-compilation-database)
+
+    def parse_raw_file(path)
+      raise "Couldn't find file at path '#{path}'".red unless File.exist?(path)
+
+      commands = generate_commands(path)
+      commands.each do |output_path, command|
+        system(command)
+        Helper.log.info("Successfully generated report at '#{output_path}'".green)
+
+        if !Scan.config[:skip_html_open] and output_path.end_with?(".html")
+          # Open the HTML file
+          `open --hide '#{output_path}'`
+        end
+      end
+    end
+
+    # Returns a hash containg the resulting path as key and the command as value
+    def generate_commands(path, types: nil, output_file_name: nil)
+      types ||= Scan.config[:output_types]
+      types = types.split(",") if types.kind_of?(String) # might already be an array when passed via fastlane
+      commands = {}
+
+      types.each do |raw|
+        type = raw.strip
+
+        unless SUPPORTED.include?(type)
+          Helper.log.error "Couldn't find reporter '#{type}', available #{SUPPORTED.join(', ')}"
+          next
+        end
+
+        file_name = "report.#{type}"
+        output_path = output_file_name || File.join(Scan.config[:output_directory], file_name)
+        parts = ["cat '#{path}' | "]
+        parts << "xcpretty"
+        parts << "--report #{type}"
+        parts << "--output '#{output_path}'"
+        parts << "&> /dev/null "
+
+        commands[output_path] = parts.join(" ")
+      end
+
+      return commands
+    end
+  end
+end

data/lib/scan/runner.rb

@@ -0,0 +1,72 @@
+require 'pty'
+require 'open3'
+require 'fileutils'
+require 'terminal-table'
+
+module Scan
+  class Runner
+    def run
+      test_app
+      handle_results
+    end
+
+    def test_app
+      command = TestCommandGenerator.generate
+      prefix_hash = [
+        {
+          prefix: "Running Tests: ",
+          block: proc do |value|
+            value.include?("Touching")
+          end
+        }
+      ]
+      FastlaneCore::CommandExecutor.execute(command: command,
+                                          print_all: true,
+                                      print_command: true,
+                                             prefix: prefix_hash,
+                                            loading: "Loading...",
+                                              error: proc do |error_output|
+                                                begin
+                                                  ErrorHandler.handle_build_error(error_output)
+                                                rescue => ex
+                                                  SlackPoster.new.run({
+                                                    build_errors: 1
+                                                  })
+                                                  raise ex
+                                                end
+                                              end)
+    end
+
+    def handle_results
+      # First, generate a JUnit report to get the number of tests
+      require 'tempfile'
+      output_file = Tempfile.new("junit_report")
+      cmd = ReportCollector.new.generate_commands(TestCommandGenerator.xcodebuild_log_path,
+                                                  types: 'junit',
+                                                  output_file_name: output_file.path).values.last
+      system(cmd)
+
+      result = TestResultParser.new.parse_result(output_file.read)
+      SlackPoster.new.run(result)
+
+      if result[:failures] > 0
+        failures_str = result[:failures].to_s.red
+      else
+        failures_str = result[:failures].to_s.green
+      end
+
+      puts Terminal::Table.new({
+        title: "Test Results",
+        rows: [
+          ["Number of tests", result[:tests]],
+          ["Number of failures", failures_str]
+        ]
+      })
+      puts ""
+
+      ReportCollector.new.parse_raw_file(TestCommandGenerator.xcodebuild_log_path)
+
+      raise "Tests failed" unless result[:failures] == 0
+    end
+  end
+end

data/lib/scan/slack_poster.rb

@@ -0,0 +1,46 @@
+module Scan
+  class SlackPoster
+    def run(results)
+      return if Scan.config[:skip_slack]
+      return if Scan.config[:slack_only_on_failure] && results[:failures] == 0
+
+      require 'slack-notifier'
+      notifier = Slack::Notifier.new(Scan.config[:slack_url])
+      notifier.username = 'fastlane'
+
+      attachments = []
+
+      attachments << {
+        text: "Build Errors: #{results[:build_errors] || 0}",
+        color: results[:build_errors].to_i > 0 ? "danger" : "good",
+        short: true
+      }
+
+      if results[:failures]
+        attachments << {
+          text: "Test Failures: #{results[:failures]}",
+          color: results[:failures].to_i > 0 ? "danger" : "good",
+          short: true
+        }
+      end
+
+      if results[:tests] and results[:failures]
+        attachments << {
+          text: "Successful Tests: #{results[:tests] - results[:failures]}",
+          color: "good",
+          short: true
+        }
+      end
+
+      result = notifier.ping "#{Scan.project.app_name} Tests:",
+                             icon_url: 'https://s3-eu-west-1.amazonaws.com/fastlane.tools/fastlane.png',
+                             attachments: attachments
+
+      if result.code.to_i == 200
+        Helper.log.info 'Successfully sent Slack notification'.green
+      else
+        Helper.log.error result.to_s.red
+      end
+    end
+  end
+end

data/lib/scan/test_command_generator.rb

@@ -0,0 +1,91 @@
+module Scan
+  # Responsible for building the fully working xcodebuild command
+  class TestCommandGenerator
+    class << self
+      def generate
+        parts = prefix
+        parts << "xcodebuild"
+        parts += options
+        parts += actions
+        parts += suffix
+        parts += pipe
+
+        parts
+      end
+
+      def prefix
+        ["set -o pipefail &&"]
+      end
+
+      # Path to the project or workspace as parameter
+      # This will also include the scheme (if given)
+      # @return [Array] The array with all the components to join
+      def project_path_array
+        proj = Scan.project.xcodebuild_parameters
+        return proj if proj.count > 0
+        raise "No project/workspace found"
+      end
+
+      def options
+        config = Scan.config
+
+        options = []
+        options += project_path_array
+        options << "-configuration '#{config[:configuration]}'" if config[:configuration]
+        options << "-sdk '#{config[:sdk]}'" if config[:sdk]
+        options << "-destination '#{config[:destination]}'" # generated in `detect_values`
+        options << "-xcconfig '#{config[:xcconfig]}'" if config[:xcconfig]
+        options << config[:xcargs] if config[:xcargs]
+
+        options
+      end
+
+      def actions
+        config = Scan.config
+
+        actions = []
+        actions << :clean if config[:clean]
+        actions << :test
+
+        actions
+      end
+
+      def suffix
+        suffix = []
+        suffix
+      end
+
+      def pipe
+        # During building we just show the output in the terminal
+        # Check out the ReportCollector class for more xcpretty things
+        formatter = ""
+        if Helper.ci?
+          formatter = "-f `xcpretty-travis-formatter`"
+          Helper.log.info "Automatically switched to Travis formatter".green
+        end
+
+        ["| tee '#{xcodebuild_log_path}' | xcpretty #{formatter}"]
+      end
+
+      # Store the raw file
+      def xcodebuild_log_path
+        file_name = "#{Scan.project.app_name}-#{Scan.config[:scheme]}.log"
+        containing = File.expand_path(Scan.config[:buildlog_path])
+        FileUtils.mkdir_p(containing)
+
+        return File.join(containing, file_name)
+      end
+
+      # The path to set the Derived Data to
+      def build_path
+        unless Scan.cache[:build_path]
+          day = Time.now.strftime("%F") # e.g. 2015-08-07
+
+          Scan.cache[:build_path] = File.expand_path("~/Library/Developer/Xcode/Archives/#{day}/")
+          FileUtils.mkdir_p Scan.cache[:build_path]
+        end
+        Scan.cache[:build_path]
+      end
+    end
+  end
+end

data/lib/scan/test_result_parser.rb

@@ -0,0 +1,21 @@
+module Scan
+  class TestResultParser
+    def parse_result(output)
+      # e.g. ...<testsuites tests='2' failures='1'>...
+      matched = output.match(/\<testsuites tests='(\d+)' failures='(\d+)'\>/)
+
+      if matched and matched.length == 3
+        tests = matched[1].to_i
+        failures = matched[2].to_i
+
+        return {
+          tests: tests,
+          failures: failures
+        }
+      else
+        Helper.log.error "Couldn't parse the number of tests from the output".red
+        return {}
+      end
+    end
+  end
+end

data/lib/scan/version.rb

@@ -1,3 +1,4 @@
 module Scan
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
+  DESCRIPTION = "Making sure no bad code gets on board"
 end

metadata

@@ -1,62 +1,241 @@
 --- !ruby/object:Gem::Specification
 name: scan
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2015-10-13 00:00:00.000000000 Z
+date: 2015-10-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: fastlane_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: xcpretty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.12
+- !ruby/object:Gem::Dependency
+  name: xcpretty-travis-formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.25.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.25.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.8.7.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-description: To be announced
+        version: 0.8.7.4
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Making sure no bad code gets on board
 email:
-- krausefx@gmail.com
-executables: []
+- scan@krausefx.com
+executables:
+- scan
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- CODE_OF_CONDUCT.md
-- Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
+- bin/scan
+- lib/assets/ScanfileTemplate
 - lib/scan.rb
+- lib/scan/commands_generator.rb
+- lib/scan/detect_values.rb
+- lib/scan/error_handler.rb
+- lib/scan/manager.rb
+- lib/scan/options.rb
+- lib/scan/report_collector.rb
+- lib/scan/runner.rb
+- lib/scan/slack_poster.rb
+- lib/scan/test_command_generator.rb
+- lib/scan/test_result_parser.rb
 - lib/scan/version.rb
-- scan.gemspec
 homepage: https://fastlane.tools
 licenses:
 - MIT
@@ -69,7 +248,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -77,9 +256,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: To be announced
+summary: Making sure no bad code gets on board
 test_files: []
 has_rdoc: