Logging Decorators on Windows (lowest-est priority)

[mundodisco8]

I'm even a bit embarrashed to ask this 😄, but I've used ceedling in WSL and in Windows and noticed that Windows has no emoji decorators in the output. The documentation mentions the fact that Windows is less emoji-friendly and to the existance of the CEEDLING_DECORATORS env variable.

I added this to my project

:environment:
  # NOTE: According to the documentation, this should provide emojis in the output but it doesn't ¯\_(ツ)_/¯
  - :CEEDLING_DECORATORS: "true"

But the decorators are not there

ceedling test:buttons
Loaded project configuration from working directory.
 > Using: C:/Users/mundo/OneDrive/Desktop/LED_Dimmer/test/project.yml
 > Working directory: C:/Users/mundo/OneDrive/Desktop/LED_Dimmer/test

Ceedling set up completed in 539 milliseconds

Preparing Build Paths...

Collecting Test Context
-----------------------
Parsing test_buttons.c for build directive macros, #includes, and test case names...

Ingesting Test Configurations
-----------------------------
Collecting search paths, flags, and defines test_buttons.c...

Determining Files to be Generated...

Mocking
-------
Generating mock for test_buttons::gpio_HW.h...
Generating mock for test_buttons::interrupt_HW.h...
Generating mock for test_buttons::sleepyTimers_HW.h...

Test Runners
------------
Generating runner for test_buttons.c...

Determining Artifacts to Be Built...

Building Objects
----------------
Compiling test_buttons.c...
Compiling test_buttons::buttons.c...
Compiling test_buttons::unity.c...
Compiling test_buttons::cmock.c...
Compiling test_buttons::test_buttons_runner.c...
Compiling test_buttons::mock_interrupt_HW.c...
Compiling test_buttons::mock_sleepyTimers_HW.c...
Compiling test_buttons::mock_gpio_HW.c...

Building Test Executables
-------------------------
Linking test_buttons.out...

Executing
---------
Running test_buttons.out...

--------------------
OVERALL TEST SUMMARY
--------------------
TESTED:  13
PASSED:  13
FAILED:   0
IGNORED:  0


Ceedling operations completed in 2.31 seconds

I'm using the latest nightly (1.1.0-efc3c2d) on Windows 11 with the New Terminal, using CaskaydiaCove Nerd Font as my font.

Am I missing something?

[mkarlesky]

@mundodisco8 I think (or, rather, hope) you've found a bug in the documentation and not in the feature!

Long story short, since 1.0.0, the logging component of Ceedling, along with a handful of other components, is instantiated at the moment the application begins running — well before the project file is processed. It looks for the environment variable at startup. And, in fact, if it didn't work this way, you'd see disjointed emoji usage as they could be enabled or disabled after some of the first uses of emojis in logging.

First, could you try setting that environment variable in your shell before running Ceedling? My hunch is that it will start working for you, a Windows-specific bug notwithstanding.

[mundodisco8]

I can confirm it works when setting the environmental variable "outside" of Ceedling

$ set CEEDLING_DECORATORS=true

$ ceedling test:effectControl
🚧 Loaded project configuration from working directory.
 > Using: C:/Users/mundo/OneDrive/Desktop/LED_Dimmer/firmware/test/project.yml
 > Working directory: C:/Users/mundo/OneDrive/Desktop/LED_Dimmer/firmware/test

Ceedling set up completed in 445 milliseconds

👟 Preparing Build Paths...

👟 Collecting Test Context
--------------------------
Parsing test_effectControl.c for build directive macros, #includes, and test case names...
[...]

🎉