Class: Scan::TestCommandGenerator

Inherits:
Object
  • Object
show all
Defined in:
lib/scan/test_command_generator.rb

Overview

Responsible for building the fully working xcodebuild command

Class Method Summary collapse

Class Method Details

.actionsObject



47
48
49
50
51
52
53
54
55
56
# File 'lib/scan/test_command_generator.rb', line 47

def actions
  config = Scan.config

  actions = []
  actions << :clean if config[:clean]
  actions << :build unless config[:skip_build]
  actions << :test

  actions
end

.build_pathObject

The path to set the Derived Data to



113
114
115
116
117
118
119
120
121
# File 'lib/scan/test_command_generator.rb', line 113

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

.destinationObject

Generate destination parameters



105
106
107
108
109
110
# File 'lib/scan/test_command_generator.rb', line 105

def destination
  unless Scan.cache[:destination]
    Scan.cache[:destination] = [*Scan.config[:destination]].map { |dst| "-destination '#{dst}'" }.join(' ')
  end
  Scan.cache[:destination]
end

.generateObject



5
6
7
8
9
10
11
12
13
14
# File 'lib/scan/test_command_generator.rb', line 5

def generate
  parts = prefix
  parts << "env NSUnbufferedIO=YES xcodebuild"
  parts += options
  parts += actions
  parts += suffix
  parts += pipe

  parts
end

.optionsObject



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# File 'lib/scan/test_command_generator.rb', line 29

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 # generated in `detect_values`
  options << "-derivedDataPath '#{config[:derived_data_path]}'" if config[:derived_data_path]
  options << "-resultBundlePath '#{result_bundle_path}'" if config[:result_bundle]
  options << "-enableCodeCoverage YES" if config[:code_coverage]
  options << "-enableAddressSanitizer YES" if config[:address_sanitizer]
  options << "-xcconfig '#{config[:xcconfig]}'" if config[:xcconfig]
  options << config[:xcargs] if config[:xcargs]

  options
end

.pipeObject



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# File 'lib/scan/test_command_generator.rb', line 63

def pipe
  # During building we just show the output in the terminal
  # Check out the ReportCollector class for more xcpretty things
  pipe = ["| tee '#{xcodebuild_log_path}'"]

  if Scan.config[:output_style] == 'raw'
    return pipe
  end

  formatter = []
  if Scan.config[:formatter]
    formatter << "-f `#{Scan.config[:formatter]}`"
  elsif ENV.key?("TRAVIS")
    formatter << "-f `xcpretty-travis-formatter`"
    UI.success("Automatically switched to Travis formatter")
  end

  if Helper.colors_disabled?
    formatter << "--no-color"
  end

  if Scan.config[:output_style] == 'basic'
    formatter << "--no-utf"
  end

  if Scan.config[:output_style] == 'rspec'
    formatter << "--test"
  end

  return pipe << ["| xcpretty #{formatter.join(' ')}"]
end

.prefixObject



16
17
18
# File 'lib/scan/test_command_generator.rb', line 16

def prefix
  ["set -o pipefail &&"]
end

.project_path_arrayArray

Path to the project or workspace as parameter This will also include the scheme (if given)

Returns:

  • (Array)

    The array with all the components to join



23
24
25
26
27
# File 'lib/scan/test_command_generator.rb', line 23

def project_path_array
  proj = Scan.project.xcodebuild_parameters
  return proj if proj.count > 0
  UI.user_error!("No project/workspace found")
end

.result_bundle_pathObject



123
124
125
126
127
128
# File 'lib/scan/test_command_generator.rb', line 123

def result_bundle_path
  unless Scan.cache[:result_bundle_path]
    Scan.cache[:result_bundle_path] = File.join(Scan.config[:output_directory], Scan.config[:scheme]) + ".test_result"
  end
  return Scan.cache[:result_bundle_path]
end

.suffixObject



58
59
60
61
# File 'lib/scan/test_command_generator.rb', line 58

def suffix
  suffix = []
  suffix
end

.xcodebuild_log_pathObject

Store the raw file



96
97
98
99
100
101
102
# File 'lib/scan/test_command_generator.rb', line 96

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