Fix #4847 - OpenStudio logging behaves differently on Windows/Linux

[jmarrec]

Pull request overview

• Fixes OpenStudio logging singleton issues (especially on Windows) when using interpreted bindings (ruby measures) #4847

Pull Request Author

• Model API Changes / Additions
• Any new or modified fields have been implemented in the EnergyPlus ForwardTranslator (and ReverseTranslator as appropriate)
• Model API methods are tested (in src/model/test)
• EnergyPlus ForwardTranslator Tests (in src/energyplus/Test)
• If a new object or method, added a test in NREL/OpenStudio-resources: Add Link
• If needed, added VersionTranslation rules for the objects (src/osversion/VersionTranslator.cpp)
• Verified that C# bindings built fine on Windows, partial classes used as needed, etc.
• All new and existing tests passes
• If methods have been deprecated, update rest of code to use the new methods

Labels:

• If change to an IDD file, add the label IDDChange
• If breaking existing API, add the label APIChange
• If deemed ready, add label Pull Request - Ready for CI so that CI builds your PR

Review Checklist

This will not be exhaustively relevant to every PR.

• Perform a Code Review on GitHub
• Code Style, strip trailing whitespace, etc.
• All related changes have been implemented: model changes, model tests, FT changes, FT tests, VersionTranslation, OS App
• Labeling is ok
• If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
• If feature, test running new feature, try creative ways to break it
• CI status: all green or justified

[jmarrec]

Before fix at 5d61bc7 we get the windows error in action, see log https://ci.openstudio.net/blue/organizations/jenkins/openstudio-incremental-windows/detail/PR-4852/3/pipeline#step-61-log-8

Running: D:\git\OpenStudio\build\Products\openstudio.exe execute_ruby_script D:\git\OpenStudio\src\cli\test\logger_test.rb

0 [test] <0> Warn
1 [test] <1> Error
2 [test] <1> Error
3 LOGGER - STDOUT Warn
4 [test] <1> Error
5 LOGGER - STDOUT Warn
6 LOGGER - STDOUT Error

Traceback (most recent call last):
  File "D:/git/OpenStudio/src/cli/test/run_test_logger.py", line 54, in <module>
    raise IOError(f"Expected 3 lines, got {n}")
OSError: Expected 3 lines, got 7


2/2 Test #3637: OpenStudioCLI.Labs.test_logger_rb ...***Failed    1.08 sec

Namespace(labs=True, logger_file=WindowsPath('D:/git/OpenStudio/src/cli/test/logger_test.rb'), os_cli_path=WindowsPath('D:/git/OpenStudio/build/Products/openstudio.exe'))

Running: D:\git\OpenStudio\build\Products\openstudio.exe labs execute_ruby_script D:\git\OpenStudio\src\cli\test\logger_test.rb

0 [test] <0> Warn
1 [test] <1> Error
2 [test] <1> Error
3 LOGGER - STDOUT Warn
4 LOGGER - STDOUT Error

Traceback (most recent call last):
  File "D:/git/OpenStudio/src/cli/test/run_test_logger.py", line 54, in <module>
    raise IOError(f"Expected 3 lines, got {n}")
OSError: Expected 3 lines, got 5

[shorowit]

I can't speak to the correctness of the implementation, but I tried this out on Windows and Ubuntu, and they both gave the desired result. So I can confirm that this fixes the issue.

[shorowit]

Although I noticed that when I run the CLI using labs on Windows, it doesn't work. Not sure if that's specific to this PR.

On Windows, first command (without labs) is successful, second command (with labs) is not:

On Ubuntu, it works both with and without labs:

[shorowit]

@jmarrec @tijcolem I tried the Windows labs command using build 5eaa0d8 and the same issue occurs there. So it's not caused by this PR. I'll see if I can find when it started failing.

[shorowit]

Found the bug, see #4856.

[ci-commercialbuildings]

CI Results for 8301544:

• Ubuntu 20.04:

  • OpenStudio-3.6.0-alpha+9072507214-Ubuntu-20.04-x86_64.deb
  • OpenStudio-3.6.0-alpha+9072507214-Ubuntu-20.04-x86_64.tar.gz
  • perf_test/results.html

• Ubuntu 22.04:

  • OpenStudio-3.6.0-alpha+83015445b1-Ubuntu-22.04-x86_64.deb
  • OpenStudio-3.6.0-alpha+83015445b1-Ubuntu-22.04-x86_64.tar.gz

• Darwin:

  • OpenStudio-3.6.0-alpha+cb6633ca8b-Darwin-x86_64.dmg
  • OpenStudio-3.6.0-alpha+cb6633ca8b-Darwin-x86_64.tar.gz

• Windows:

  • OpenStudio-3.6.0-alpha+2bcb7565e1-Windows.exe
  • OpenStudio-3.6.0-alpha+2bcb7565e1-Windows.tar.gz

• Code Coverage: