Improve OpenStudio's support for Python unitttest

[kbenne]

In the Python unittest library, unittest.main() was not working as expected, because tests defined in the main scope where not being detected. This meant that openstudio labs execute_python_script foo_measure_test.rb did not work as expected.

The solution here is to register the main module properly within Python.

• An example Measure test is located at NREL/openstudio-common-measures-gem@0c73cdb
• A Measure test can be invoked with openstudio labs --python_path=. execute_python_script tests/test_measure.py

close #4906

Pull request overview

• Fixes #ISSUENUMBERHERE (IF THIS IS A DEFECT)

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]

I don't want to sound like a broken record, but I would urge we standardize around pytest and not unittest. yes, I now this isn't part of the standard library, but I think we should just pip install it into the EnergyPlus/python_standard_lib directory.

[jmarrec]

Do you have a link to somewhere where they do this sys.modules["__main__"] = module or something to convince me this is the right way to do it? Don't want to go chasing info if you already have it.

I have a completely non-justified feeling this might cause trouble in some edge case we haven't foreseen, when this isn't a unittest file or something.

[kbenne]

You could be right. Here is my justification though.

https://docs.python.org/3/library/__main__.html#import-main

Python inserts an empty __main__ module in [sys.modules](https://docs.python.org/3/library/sys.html#sys.modules) at interpreter startup, and populates it by running top-level code....

[jmarrec]

https://stackoverflow.com/a/62492464/2543372

[jmarrec]

https://github.com/python/cpython/blob/754519a9f8c2bb06d85ff9b3e9fe6f967ac46d5c/Lib/unittest/loader.py#L336-L338

[jmarrec]

Assuming CI comes clean, this will merge

[ci-commercialbuildings]

CI Results for b5d7c00:

• Ubuntu 20.04:

• Ubuntu 22.04:

  • OpenStudio-3.7.0-alpha+b5d7c006ab-Ubuntu-22.04-x86_64.deb
  • OpenStudio-3.7.0-alpha+b5d7c006ab-Ubuntu-22.04-x86_64.tar.gz

• Darwin:

  • OpenStudio-3.7.0-alpha+b5d7c006ab-Darwin-x86_64.dmg
  • OpenStudio-3.7.0-alpha+b5d7c006ab-Darwin-x86_64.tar.gz

• Windows:

  • OpenStudio-3.7.0-alpha+b5d7c006ab-Windows.exe
  • OpenStudio-3.7.0-alpha+b5d7c006ab-Windows.tar.gz

• Code Coverage:

[jmarrec]

Just the usual suspect OpenStudioCLI.Labs.test_logger_rb (Failed) on windows. Thanks @kbenne