Fix #5076 - /tmp/xmlvalidation directories not cleaned up for factory methods bclXMLValidator & gbxmlValidator

[jmarrec]

Pull request overview

• Fix /tmp/xmlvalidation directories #5076
• /tmp/xmlvalidation directories not cleaned up for factory methods bclXMLValidator & gbxmlValidator

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]

Ok tests fail before fix, work with fix

Before:

[==========] Running 1 test from 1 test suite.
[----------] Global test environment set-up.
[----------] 1 test from XMLValidatorFixture
[ RUN      ] XMLValidatorFixture.XMLValidator_bclXMLValidator_Cleanup
/Users/julien/Software/Others/OpenStudio2/src/utilities/xml/Test/XMLValidator_GTest.cpp:171: Failure
Value of: openstudio::filesystem::exists(tmpDir)
  Actual: true
Expected: false
Expected tmpDir to be deleted: "/var/folders/bz/sgrc10ls2d9fz7418xw3wgym0000gn/T/xmlvalidation-fac0-5db6-68ba-39e5-1705421114-0"
[  FAILED  ] XMLValidatorFixture.XMLValidator_bclXMLValidator_Cleanup (0 ms)
[----------] 1 test from XMLValidatorFixture (0 ms total)

[----------] Global test environment tear-down
[==========] 1 test from 1 test suite ran. (1 ms total)
[  PASSED  ] 0 tests.
[  FAILED  ] 1 test, listed below:
[  FAILED  ] XMLValidatorFixture.XMLValidator_bclXMLValidator_Cleanup

 1 FAILED TEST

    Start 185: XMLValidatorFixture.XMLValidator_gbxmlValidator_Cleanup
2/2 Test #185: XMLValidatorFixture.XMLValidator_gbxmlValidator_Cleanup ....***Failed    0.01 sec
Running main() from /Users/julien/.conan/data/gtest/1.11.0/_/_/build/dbd8bc9563b5a1f4052cc1968e26d22031450443/source_subfolder/googletest/src/gtest_main.cc
Note: Google Test filter = XMLValidatorFixture.XMLValidator_gbxmlValidator_Cleanup
[==========] Running 1 test from 1 test suite.
[----------] Global test environment set-up.
[----------] 1 test from XMLValidatorFixture
[ RUN      ] XMLValidatorFixture.XMLValidator_gbxmlValidator_Cleanup
/Users/julien/Software/Others/OpenStudio2/src/utilities/xml/Test/XMLValidator_GTest.cpp:183: Failure
Value of: openstudio::filesystem::exists(tmpDir)
  Actual: true
Expected: false
Expected tmpDir to be deleted: "/var/folders/bz/sgrc10ls2d9fz7418xw3wgym0000gn/T/xmlvalidation-6495-53c1-ddfb-bb6b-1705421114-0"
[  FAILED  ] XMLValidatorFixture.XMLValidator_gbxmlValidator_Cleanup (1 ms)
[----------] 1 test from XMLValidatorFixture (1 ms total)

[----------] Global test environment tear-down
[==========] 1 test from 1 test suite ran. (1 ms total)
[  PASSED  ] 0 tests.
[  FAILED  ] 1 test, listed below:
[  FAILED  ] XMLValidatorFixture.XMLValidator_gbxmlValidator_Cleanup

 1 FAILED TEST


0% tests passed, 2 tests failed out of 2

Total Test time (real) =   0.14 sec

The following tests FAILED:
        184 - XMLValidatorFixture.XMLValidator_bclXMLValidator_Cleanup (Failed)
        185 - XMLValidatorFixture.XMLValidator_gbxmlValidator_Cleanup (Failed)

[ci-commercialbuildings]

CI Results for c103518:

• Ubuntu 20.04:

  • OpenStudio-3.7.0+c103518ec4-Ubuntu-20.04-x86_64.deb
  • OpenStudio-3.7.0+c103518ec4-Ubuntu-20.04-x86_64.tar.gz
  • perf_test/results.html

• Ubuntu 22.04:

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

• Darwin:

• Windows:

• Code Coverage:

[kbenne]

It fixes the issue so I support this, but maybe we could rethink the interface a little bit.

[kbenne]

It feels awkward and potentially error prone to need to make this assignment. Maybe we could use a temp directory class like Spawn uses https://github.com/NREL/Spawn/blob/develop/util/temp_directory.hpp and perhaps also move the construction of the temp directory into the construction of the XMLValidator. I understand there might be cases where you don't want XMLValidator to use a temp directory, but perhaps if that is a requirement we could design on overload or something.