Class: Setupinator

Inherits:
Object show all
Defined in:
lib/ceedling/setupinator.rb

Overview

Ceedling - Test-Centered Build System for C
ThrowTheSwitch.org
Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
SPDX-License-Identifier: MIT

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#config_hash ⇒ Object (readonly)

Returns the value of attribute config_hash.



10
11
12
 
# File 'lib/ceedling/setupinator.rb', line 10

def config_hash
  @config_hash
end

Instance Method Details

#ceedling=(value) ⇒ Object

Injector method for setting Ceedling application object hash



26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/ceedling/setupinator.rb', line 26

def ceedling=(value)
  # Capture application objects hash as instance variable
  @ceedling = value

  # Get our dependencies from object hash rather than DIY constructor
  # This is a shortcut / validates aspects of our setup
  @configurator         = value[:configurator]
  @loginator            = value[:loginator]
  @reportinator         = value[:reportinator]
  @plugin_manager       = value[:plugin_manager]
  @plugin_reportinator  = value[:plugin_reportinator]
  @test_runner_manager  = value[:test_runner_manager]
end

#do_setup(app_cfg) ⇒ Object

Load up all the constants and accessors our rake files, objects, & external scripts will need.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/ceedling/setupinator.rb', line 42

def do_setup( app_cfg )
  @config_hash = app_cfg[:project_config]

  ##
  ## 1. Miscellaneous handling and essential configuration prep
  ##

  # Set special purpose test case filters (from command line)
  @configurator.include_test_case = app_cfg[:include_test_case]
  @configurator.exclude_test_case = app_cfg[:exclude_test_case]

  # Verbosity handling
  @configurator.set_verbosity( config_hash )

  # Logging configuration
  @loginator.set_logfile( app_cfg[:log_filepath] )
  @configurator.project_logging = @loginator.project_logging

  log_step( 'Validating configuration contains minimum required sections', heading:false )

  # Complain early about anything essential that's missing
  @configurator.validate_essential( config_hash )

  # Merge any needed runtime settings into user configuration
  @configurator.merge_ceedling_runtime_config( config_hash, CEEDLING_RUNTIME_CONFIG.deep_clone )

  ##
  ## 2. Handle basic configuration
  ##

  log_step( 'Base configuration handling', heading:false )

  # Evaluate environment vars before plugin configurations that might reference with inline Ruby string expansion
  @configurator.eval_environment_variables( config_hash )

  # Standardize paths and add to Ruby load paths
  plugins_paths_hash = @configurator.prepare_plugins_load_paths( app_cfg[:ceedling_plugins_path], config_hash )

  ##
  ## 3. Plugin Handling
  ##

  log_step( 'Plugin Handling' )

  # Plugin handling
  @configurator.discover_plugins( plugins_paths_hash, config_hash )
  @configurator.merge_config_plugins( config_hash )
  @configurator.populate_plugins_config( plugins_paths_hash, config_hash )

  ##
  ## 4. Collect and apply defaults to user configuration
  ##

  log_step( 'Assembling Default Settings' )

  # Assemble defaults
  defaults_hash = DEFAULT_CEEDLING_PROJECT_CONFIG.deep_clone()
  @configurator.merge_tools_defaults( config_hash, defaults_hash )
  @configurator.populate_cmock_defaults( config_hash, defaults_hash )
  @configurator.merge_plugins_defaults( plugins_paths_hash, config_hash, defaults_hash )

  # Set any missing essential or plugin values in configuration with assembled default values
  @configurator.populate_with_defaults( config_hash, defaults_hash )

  ##
  ## 5. Fill out / modify remaining configuration from user configuration + defaults
  ##

  log_step( 'Completing Project Configuration' )

  # Populate Unity configuration with values to tie vendor tool configurations together
  @configurator.populate_unity_config( config_hash )

  # Populate CMock configuration with values to tie vendor tool configurations together
  @configurator.populate_cmock_config( config_hash )

  # Configure test runner generation
  @configurator.populate_test_runner_generation_config( config_hash )

  # Automagically enable use of exceptions based on CMock settings
  @configurator.populate_exceptions_config( config_hash )

  # Evaluate environment vars again before subsequent configurations that might reference with inline Ruby string expansion
  @configurator.eval_environment_variables( config_hash )

  # Standardize values and expand inline Ruby string substitutions
  @configurator.eval_paths( config_hash )
  @configurator.eval_flags( config_hash )
  @configurator.eval_defines( config_hash )
  @configurator.standardize_paths( config_hash )

  # Fill out any missing tool config value
  @configurator.populate_tools_config( config_hash )

  # From any tool definition shortcuts:
  #  - Redefine executable if set
  #  - Add arguments from tool definition shortcuts if set
  @configurator.populate_tools_shortcuts( config_hash )

  # Configure test runner build & runtime options
  @test_runner_manager.configure_build_options( config_hash )
  @test_runner_manager.configure_runtime_options( app_cfg[:include_test_case], app_cfg[:exclude_test_case] )

  ##
  ## 6. Validate configuration
  ##

  log_step( 'Validating final project configuration', heading:false )

  @configurator.validate_final( config_hash, app_cfg )

  ##
  ## 7. Flatten configuration + process it into globals and accessors
  ##

  # Skip logging this step as the end user doesn't care about this internal preparation

  # Partially flatten config + build Configurator accessors and globals
  @configurator.build( app_cfg[:ceedling_lib_path], app_cfg[:logging_path], config_hash, :environment )

  ##
  ## 8. Final plugins handling
  ##

  # Detailed logging already happend for plugin processing
  log_step( 'Loading Plugins' )

  @configurator.insert_rake_plugins( @configurator.rake_plugins )
  
  # Merge in any environment variables that plugins specify after the main build
  @plugin_manager.load_programmatic_plugins( @configurator.programmatic_plugins, @ceedling ) do |env|
    # Evaluate environment vars that plugins may have added
    @configurator.eval_environment_variables( env )
    @configurator.build_supplement( config_hash, env )
  end
  
  # Inject dependencies for plugin needs
  @plugin_reportinator.set_system_objects( @ceedling )
end

#inspect ⇒ Object

Override to prevent exception handling from walking & stringifying the object variables. Object variables are gigantic and produce a flood of output.



19
20
21
22
 
# File 'lib/ceedling/setupinator.rb', line 19

def inspect
  # TODO: When identifying information is added to constructor, insert it into `inspect()` string
  return this.class.name
end

#setup ⇒ Object 



12
13
14
 
# File 'lib/ceedling/setupinator.rb', line 12

def setup
  @config_hash = {}
end