1require 'yaml' 2require 'fileutils' 3require_relative '../../auto/unity_test_summary' 4require_relative '../../auto/generate_test_runner' 5require_relative '../../auto/colour_reporter' 6 7C_EXTENSION = '.c'.freeze 8 9def load_configuration(config_file) 10 $cfg_file = config_file 11 $cfg = YAML.load(File.read($cfg_file)) 12end 13 14def configure_clean 15 CLEAN.include($cfg['compiler']['build_path'] + '*.*') unless $cfg['compiler']['build_path'].nil? 16end 17 18def configure_toolchain(config_file = DEFAULT_CONFIG_FILE) 19 config_file += '.yml' unless config_file =~ /\.yml$/ 20 load_configuration(config_file) 21 configure_clean 22end 23 24def unit_test_files 25 path = $cfg['compiler']['unit_tests_path'] + 'Test*' + C_EXTENSION 26 path.tr!('\\', '/') 27 FileList.new(path) 28end 29 30def local_include_dirs 31 include_dirs = $cfg['compiler']['includes']['items'].dup 32 include_dirs.delete_if { |dir| dir.is_a?(Array) } 33 include_dirs 34end 35 36def extract_headers(filename) 37 includes = [] 38 lines = File.readlines(filename) 39 lines.each do |line| 40 m = line.match(/^\s*#include\s+\"\s*(.+\.[hH])\s*\"/) 41 includes << m[1] unless m.nil? 42 end 43 includes 44end 45 46def find_source_file(header, paths) 47 paths.each do |dir| 48 src_file = dir + header.ext(C_EXTENSION) 49 return src_file if File.exist?(src_file) 50 end 51 nil 52end 53 54def tackit(strings) 55 result = if strings.is_a?(Array) 56 "\"#{strings.join}\"" 57 else 58 strings 59 end 60 result 61end 62 63def squash(prefix, items) 64 result = '' 65 items.each { |item| result += " #{prefix}#{tackit(item)}" } 66 result 67end 68 69def build_compiler_fields 70 command = tackit($cfg['compiler']['path']) 71 defines = if $cfg['compiler']['defines']['items'].nil? 72 '' 73 else 74 squash($cfg['compiler']['defines']['prefix'], $cfg['compiler']['defines']['items']) 75 end 76 options = squash('', $cfg['compiler']['options']) 77 includes = squash($cfg['compiler']['includes']['prefix'], $cfg['compiler']['includes']['items']) 78 includes = includes.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR) 79 80 { command: command, defines: defines, options: options, includes: includes } 81end 82 83def compile(file, _defines = []) 84 compiler = build_compiler_fields 85 cmd_str = "#{compiler[:command]}#{compiler[:defines]}#{compiler[:options]}#{compiler[:includes]} #{file} " \ 86 "#{$cfg['compiler']['object_files']['prefix']}#{$cfg['compiler']['object_files']['destination']}" 87 obj_file = "#{File.basename(file, C_EXTENSION)}#{$cfg['compiler']['object_files']['extension']}" 88 execute(cmd_str + obj_file) 89 obj_file 90end 91 92def build_linker_fields 93 command = tackit($cfg['linker']['path']) 94 options = if $cfg['linker']['options'].nil? 95 '' 96 else 97 squash('', $cfg['linker']['options']) 98 end 99 includes = if $cfg['linker']['includes'].nil? || $cfg['linker']['includes']['items'].nil? 100 '' 101 else 102 squash($cfg['linker']['includes']['prefix'], $cfg['linker']['includes']['items']) 103 end.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR) 104 105 { command: command, options: options, includes: includes } 106end 107 108def link_it(exe_name, obj_list) 109 linker = build_linker_fields 110 cmd_str = "#{linker[:command]}#{linker[:options]}#{linker[:includes]} " + 111 (obj_list.map { |obj| "#{$cfg['linker']['object_files']['path']}#{obj} " }).join + 112 $cfg['linker']['bin_files']['prefix'] + ' ' + 113 $cfg['linker']['bin_files']['destination'] + 114 exe_name + $cfg['linker']['bin_files']['extension'] 115 execute(cmd_str) 116end 117 118def build_simulator_fields 119 return nil if $cfg['simulator'].nil? 120 121 command = if $cfg['simulator']['path'].nil? 122 '' 123 else 124 (tackit($cfg['simulator']['path']) + ' ') 125 end 126 pre_support = if $cfg['simulator']['pre_support'].nil? 127 '' 128 else 129 squash('', $cfg['simulator']['pre_support']) 130 end 131 post_support = if $cfg['simulator']['post_support'].nil? 132 '' 133 else 134 squash('', $cfg['simulator']['post_support']) 135 end 136 137 { command: command, pre_support: pre_support, post_support: post_support } 138end 139 140def execute(command_string, verbose = true, raise_on_fail = true) 141 report command_string 142 output = `#{command_string}`.chomp 143 report(output) if verbose && !output.nil? && !output.empty? 144 145 if !$?.nil? && !$?.exitstatus.zero? && raise_on_fail 146 raise "Command failed. (Returned #{$?.exitstatus})" 147 end 148 149 output 150end 151 152def report_summary 153 summary = UnityTestSummary.new 154 summary.root = __dir__ 155 results_glob = "#{$cfg['compiler']['build_path']}*.test*" 156 results_glob.tr!('\\', '/') 157 results = Dir[results_glob] 158 summary.targets = results 159 summary.run 160 fail_out 'FAIL: There were failures' if summary.failures > 0 161end 162 163def run_tests(test_files) 164 report 'Running system tests...' 165 166 # Tack on TEST define for compiling unit tests 167 load_configuration($cfg_file) 168 test_defines = ['TEST'] 169 $cfg['compiler']['defines']['items'] = [] if $cfg['compiler']['defines']['items'].nil? 170 $cfg['compiler']['defines']['items'] << 'TEST' 171 172 include_dirs = local_include_dirs 173 174 # Build and execute each unit test 175 test_files.each do |test| 176 obj_list = [] 177 178 # Detect dependencies and build required required modules 179 extract_headers(test).each do |header| 180 # Compile corresponding source file if it exists 181 src_file = find_source_file(header, include_dirs) 182 obj_list << compile(src_file, test_defines) unless src_file.nil? 183 end 184 185 # Build the test runner (generate if configured to do so) 186 test_base = File.basename(test, C_EXTENSION) 187 runner_name = test_base + '_Runner.c' 188 if $cfg['compiler']['runner_path'].nil? 189 runner_path = $cfg['compiler']['build_path'] + runner_name 190 test_gen = UnityTestRunnerGenerator.new($cfg_file) 191 test_gen.run(test, runner_path) 192 else 193 runner_path = $cfg['compiler']['runner_path'] + runner_name 194 end 195 196 obj_list << compile(runner_path, test_defines) 197 198 # Build the test module 199 obj_list << compile(test, test_defines) 200 201 # Link the test executable 202 link_it(test_base, obj_list) 203 204 # Execute unit test and generate results file 205 simulator = build_simulator_fields 206 executable = $cfg['linker']['bin_files']['destination'] + test_base + $cfg['linker']['bin_files']['extension'] 207 cmd_str = if simulator.nil? 208 executable 209 else 210 "#{simulator[:command]} #{simulator[:pre_support]} #{executable} #{simulator[:post_support]}" 211 end 212 output = execute(cmd_str, true, false) 213 test_results = $cfg['compiler']['build_path'] + test_base 214 test_results += if output.match(/OK$/m).nil? 215 '.testfail' 216 else 217 '.testpass' 218 end 219 File.open(test_results, 'w') { |f| f.print output } 220 end 221end 222 223def build_application(main) 224 report 'Building application...' 225 226 obj_list = [] 227 load_configuration($cfg_file) 228 main_path = $cfg['compiler']['source_path'] + main + C_EXTENSION 229 230 # Detect dependencies and build required required modules 231 include_dirs = get_local_include_dirs 232 extract_headers(main_path).each do |header| 233 src_file = find_source_file(header, include_dirs) 234 obj_list << compile(src_file) unless src_file.nil? 235 end 236 237 # Build the main source file 238 main_base = File.basename(main_path, C_EXTENSION) 239 obj_list << compile(main_path) 240 241 # Create the executable 242 link_it(main_base, obj_list) 243end 244 245def fail_out(msg) 246 puts msg 247 puts 'Not returning exit code so continuous integration can pass' 248 # exit(-1) # Only removed to pass example_3, which has failing tests on purpose. 249 # Still fail if the build fails for any other reason. 250end 251