Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project
adheres to Semantic Versioning.
Released on September 04, 2021.
Added
New libraries
core library for fundamental types and functions used by everything elsetest library for testing infrastructureunix library for wrapping Unix-like APIswindows library for wrapping Windows APIs
core library features
core::constant_error namespace, containing a ConstantError template for errors with a constant messagecore::error_chain namespace, containing the ErrorChain class for building complex error typescore::none namespace, containing the None type to use as a placeholdercore::resource_warden namespace, containing a class template for cleaning up raw resources on scope exitcore::result namespace, containing facilities for operations that can fail
test library features
test::abstract_reporter namespace, containing the AbstractReporter interfacetest::cli namespace, containing a function execute() that can be called from main()test::console_reporter namespace, containing a reporter that writes to stdouttest::expect namespace, containing macros to express test assertionstest::outcome namespace, containing types representing scenario outcomestest::reporter namespace, containing factories for specific reporters and also a wrapper typetest::scenario namespace, containing the Scenario type for representing a single test scenariotest::suite namespace, containing the Suite singleton used to hold all of the tests in a suite
unix library features
unix::errno_error namespace, containing utilities for working with errnounix::fs namespace, containing wrappers for filesystem APIs on Unix-like systems
windows library features
windows::fs namespace, containing wrappers for filesystem APIs on Windowswindows::transcoding namespace, containing functions for transcoding UTF8 with UTF16 for Windows APIswindows::windows_error namespace, containing functions and a type for reading and formatting Windows errors
Build system features
- Turned on common compile warnings for AppleClang, Clang, GNU, and MSVC compilers for every target
- Wrappers for CMake's
add_* commands that also turn on Crucible-specific compiler settings
- Options to enable AddressSanitizer, ThreadSanitizer, and UndefinedBehaviorSanitizer on supported toolchains
- Automatically export all symbols from all libraries when building Windows DLLs
- Write all final build outputs (executables and libraries) to
${PROJECT_BINARY_DIR}/artifacts
Repository features
- Build dependencies, build instructions, test instructions, and attribution in the README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project
adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [0.1.0]
Released on September 04, 2021.
### Added
#### New libraries
* `core` library for fundamental types and functions used by everything else
* `test` library for testing infrastructure
* `unix` library for wrapping Unix-like APIs
* `windows` library for wrapping Windows APIs
#### `core` library features
* `core::constant_error` namespace, containing a `ConstantError` template for errors with a constant message
* `core::error_chain` namespace, containing the `ErrorChain` class for building complex error types
* `core::none` namespace, containing the `None` type to use as a placeholder
* `core::resource_warden` namespace, containing a class template for cleaning up raw resources on scope exit
* `core::result` namespace, containing facilities for operations that can fail
#### `test` library features
* `test::abstract_reporter` namespace, containing the `AbstractReporter` interface
* `test::cli` namespace, containing a function `execute()` that can be called from `main()`
* `test::console_reporter` namespace, containing a reporter that writes to stdout
* `test::expect` namespace, containing macros to express test assertions
* `test::outcome` namespace, containing types representing scenario outcomes
* `test::reporter` namespace, containing factories for specific reporters and also a wrapper type
* `test::scenario` namespace, containing the `Scenario` type for representing a single test scenario
* `test::suite` namespace, containing the `Suite` singleton used to hold all of the tests in a suite
#### `unix` library features
* `unix::errno_error` namespace, containing utilities for working with `errno`
* `unix::fs` namespace, containing wrappers for filesystem APIs on Unix-like systems
#### `windows` library features
* `windows::fs` namespace, containing wrappers for filesystem APIs on Windows
* `windows::transcoding` namespace, containing functions for transcoding UTF8 with UTF16 for Windows APIs
* `windows::windows_error` namespace, containing functions and a type for reading and formatting Windows errors
#### Build system features
* Turned on common compile warnings for AppleClang, Clang, GNU, and MSVC compilers for every target
* Wrappers for CMake's `add_*` commands that also turn on Crucible-specific compiler settings
* Options to enable AddressSanitizer, ThreadSanitizer, and UndefinedBehaviorSanitizer on supported toolchains
* Automatically export all symbols from all libraries when building Windows DLLs
* Write all final build outputs (executables and libraries) to `${PROJECT_BINARY_DIR}/artifacts`
#### Repository features
* Build dependencies, build instructions, test instructions, and attribution in the README
[0.1.0]: https://gitlab.com/bravelytyped/crucible/-/tree/v0.1.0