| 
									
										
										
										
											2019-06-10 16:18:27 +07:00
										 |  |  | ---
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | # Notes:
 | 
					
						
							|  |  |  | # Sample project C code is not presently written to produce a release artifact.
 | 
					
						
							|  |  |  | # As such, release build options are disabled.
 | 
					
						
							|  |  |  | # This sample, therefore, only demonstrates running a collection of unit tests.
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | :project:
 | 
					
						
							| 
									
										
										
										
											2019-06-10 17:42:00 +07:00
										 |  |  |   :use_exceptions: TRUE
 | 
					
						
							| 
									
										
										
										
											2019-06-10 16:18:27 +07:00
										 |  |  |   :use_test_preprocessor: TRUE
 | 
					
						
							|  |  |  |   :use_auxiliary_dependencies: TRUE
 | 
					
						
							| 
									
										
										
										
											2019-10-30 12:24:07 +07:00
										 |  |  |   :use_deep_dependencies: TRUE
 | 
					
						
							| 
									
										
										
										
											2019-06-10 17:42:00 +07:00
										 |  |  |   :build_root: _build
 | 
					
						
							| 
									
										
										
										
											2019-06-10 16:18:27 +07:00
										 |  |  | #  :release_build: TRUE
 | 
					
						
							|  |  |  |   :test_file_prefix: test_
 | 
					
						
							|  |  |  |   :which_ceedling: vendor/ceedling
 | 
					
						
							|  |  |  |   :default_tasks:
 | 
					
						
							|  |  |  |     - test:all
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | #:release_build:
 | 
					
						
							|  |  |  | #  :output: MyApp.out
 | 
					
						
							|  |  |  | #  :use_assembly: FALSE
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | :environment:
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | :extension:
 | 
					
						
							|  |  |  |   :executable: .out
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | :paths:
 | 
					
						
							|  |  |  |   :test:
 | 
					
						
							|  |  |  |     - +:test/**
 | 
					
						
							|  |  |  |     - -:test/support
 | 
					
						
							|  |  |  |   :source:
 | 
					
						
							| 
									
										
										
										
											2019-06-10 17:21:08 +07:00
										 |  |  |     - ../src/**
 | 
					
						
							| 
									
										
										
										
											2019-06-10 16:18:27 +07:00
										 |  |  |   :support:
 | 
					
						
							|  |  |  |     - test/support
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | :defines:
 | 
					
						
							|  |  |  |   # in order to add common defines:
 | 
					
						
							|  |  |  |   #  1) remove the trailing [] from the :common: section
 | 
					
						
							|  |  |  |   #  2) add entries to the :common: section (e.g. :test: has TEST defined)
 | 
					
						
							|  |  |  |   :commmon: &common_defines []
 | 
					
						
							|  |  |  |   :test:
 | 
					
						
							|  |  |  |     - *common_defines
 | 
					
						
							| 
									
										
										
										
											2019-10-30 12:24:07 +07:00
										 |  |  |     - _TEST_
 | 
					
						
							| 
									
										
										
										
											2019-06-10 16:18:27 +07:00
										 |  |  |   :test_preprocess:
 | 
					
						
							|  |  |  |     - *common_defines
 | 
					
						
							| 
									
										
										
										
											2019-10-30 12:24:07 +07:00
										 |  |  |     - _TEST_
 | 
					
						
							| 
									
										
										
										
											2019-06-10 16:18:27 +07:00
										 |  |  | 
 | 
					
						
							|  |  |  | :cmock:
 | 
					
						
							|  |  |  |   :mock_prefix: mock_
 | 
					
						
							|  |  |  |   :when_no_prototypes: :warn
 | 
					
						
							|  |  |  |   :enforce_strict_ordering: TRUE
 | 
					
						
							|  |  |  |   :plugins:
 | 
					
						
							|  |  |  |     - :ignore
 | 
					
						
							|  |  |  |     - :callback
 | 
					
						
							| 
									
										
										
										
											2019-10-30 16:19:47 +07:00
										 |  |  |     - :array
 | 
					
						
							| 
									
										
										
										
											2019-06-10 16:18:27 +07:00
										 |  |  |   :treat_as:
 | 
					
						
							|  |  |  |     uint8:    HEX8
 | 
					
						
							|  |  |  |     uint16:   HEX16
 | 
					
						
							|  |  |  |     uint32:   UINT32
 | 
					
						
							|  |  |  |     int8:     INT8
 | 
					
						
							|  |  |  |     bool:     UINT8
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | :gcov:
 | 
					
						
							|  |  |  |     :html_report_type: basic
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | #:tools:
 | 
					
						
							|  |  |  | # Ceedling defaults to using gcc for compiling, linking, etc.
 | 
					
						
							|  |  |  | # As [:tools] is blank, gcc will be used (so long as it's in your system path)
 | 
					
						
							|  |  |  | # See documentation to configure a given toolchain for use
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | # LIBRARIES
 | 
					
						
							|  |  |  | # These libraries are automatically injected into the build process. Those specified as
 | 
					
						
							|  |  |  | # common will be used in all types of builds. Otherwise, libraries can be injected in just
 | 
					
						
							|  |  |  | # tests or releases. These options are MERGED with the options in supplemental yaml files.
 | 
					
						
							|  |  |  | :libraries:
 | 
					
						
							|  |  |  |   :placement: :end
 | 
					
						
							|  |  |  |   :flag: "${1}"  # or "-L ${1}" for example
 | 
					
						
							|  |  |  |   :common: &common_libraries []
 | 
					
						
							|  |  |  |   :test:
 | 
					
						
							|  |  |  |     - *common_libraries
 | 
					
						
							|  |  |  |   :release:
 | 
					
						
							|  |  |  |     - *common_libraries
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | :plugins:
 | 
					
						
							|  |  |  |   :load_paths:
 | 
					
						
							|  |  |  |     - vendor/ceedling/plugins
 | 
					
						
							|  |  |  |   :enabled:
 | 
					
						
							|  |  |  |     - stdout_pretty_tests_report
 | 
					
						
							|  |  |  |     - module_generator
 | 
					
						
							|  |  |  |     - raw_output_report
 | 
					
						
							|  |  |  | ...
 |