For halted workflow, return before FT and OSM save #5539

joseph-robertson · 2025-12-02T20:07:31Z

Pull request overview

File run_translation.rb in the OpenStudio-workflow-gem has a return before FT, but OSWorkflow.cpp in OpenStudio's src/workflow folder does not. We'll now expect no in.idf or pre-preprocess.idf.

Furthermore, the OpenStudio-workflow-gem saves the model to in.osm even if the workflow was halted. This PR maintains that behavior.

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

github-actions · 2025-12-05T22:00:54Z

🧪 Test Results Dashboard

Summary

Metric	Value
Total Tests	4156
Passed	4146
Failed	10
Errors	0
Skipped	0
Success Rate	99.8%
Generated	2025-12-15 16:46:56 UTC

⚠️ Minor Issues Detected

🔍 Failed Tests (10 failures)

Linux-c++ (10 failures)

OpenStudioCLI.Classic.test_measure_manager.OpenStudioCLI.Classic.test_measure_manager (run1)

Error Message:

Failed

Full Details:

No details available

CLITest-test_bundle-bundle.CLITest-test_bundle-bundle (run1)

Error Message:

Failed

Full Details:

No details available

CLITest-test_bundle-bundle_git.CLITest-test_bundle-bundle_git (run1)

Error Message:

Failed

Full Details:

No details available

CLITest-test_bundle-bundle_native_embedded.CLITest-test_bundle-bundle_native_embedded (run1)

Error Message:

Failed

Full Details:

No details available

CLITest-test_bundle-bundle.CLITest-test_bundle-bundle (run3)

Error Message:

Failed

Full Details:

No details available

CLITest-test_bundle-bundle_git.CLITest-test_bundle-bundle_git (run3)

Error Message:

Failed

Full Details:

No details available

CLITest-test_bundle-bundle_native_embedded.CLITest-test_bundle-bundle_native_embedded (run3)

Error Message:

Failed

Full Details:

No details available

CLITest-test_bundle-bundle.CLITest-test_bundle-bundle (run2)

Error Message:

Failed

Full Details:

No details available

CLITest-test_bundle-bundle_git.CLITest-test_bundle-bundle_git (run2)

Error Message:

Failed

Full Details:

No details available

CLITest-test_bundle-bundle_native_embedded.CLITest-test_bundle-bundle_native_embedded (run2)

Error Message:

Failed

Full Details:

No details available

📊 Test Run Information

Run	XML File	Status
run1	`results.xml`	✅ Found
run3	`results.xml`	✅ Found
run2	`results.xml`	✅ Found

jmarrec · 2025-12-08T10:21:43Z

src/workflow/RunTranslator.cpp

    LOG(Info, "Workflow halted, skipping OSM to IDF translation");
    // This allows model arguments to still be calculated
    workspace_ = Workspace{};
+    return;


jmarrec · 2025-12-08T10:32:10Z

src/workflow/OSWorkflow.cpp

+  // Skip saving the OSM if halted
+  if (runner.halted()) {
+    LOG(Info, "Workflow halted, skipping saving the OSM");
+    return;
+  }


Not sure whether we actually want this or not.

This is saving to root dir only if debug.

And the in.osm is saved in the run/ folder anyways.

Also, It's say the source of truth should be the classic CLI. Run this example https://github.com/NREL/OpenStudio-workflow-gem/blob/4a799dbf4c5477610c9e9665dfa7729fe74fc52e/spec/files/halt_workflow_osw/halt_workflow.osw

cd OpenStudio-workflow-gem/spec/files/halt_workflow_osw openstudio classic --verbose run --show-stdout --debug -w halt_workflow.osw

I do end up with the "in.osm" (and in.idf, empty) in the root dir.

git clean -fxd openstudio classic --verbose run --show-stdout -w halt_workflow.osw git ls-files . --ignored --exclude-standard --others

out.osw run/data_point.zip run/data_point_out.json run/finished.job run/in.osm run/measure_attributes.json run/objectives.json run/pre-preprocess.idf run/results.json run/run.log run/started.job

Before fix

git clean -fxd openstudio run --show-stdout -w halt_workflow.osw git ls-files . --ignored --exclude-standard --others

out.osw run/data_point.zip run/data_point_out.json run/finished.job + run/in.idf run/in.osm run/measure_attributes.json run/pre-preprocess.idf # And this is full of stuff run/results.json run/run.log run/started.job

With this PR:

git clean -fxd $os_build/Products/openstudio run --show-stdout -w halt_workflow.osw git ls-files . --ignored --exclude-standard --others

I still have run/in.idf and run/pre-processed.idf but at least they contain only the "Version" object.

(py312)(3.2.2)julien@halt_workflow_osw (master *=)$ cat run/in.idf Version, 25.2.0; !- Version Identifier (py312)(3.2.2)julien@halt_workflow_osw (master *=)$ cat run/pre-preprocess.idf Version, 25.2.0; !- Version Identifier

So with halt workflow (debug or not), we'll now expect no in.idf or pre-preprocess.idf, but we'll still expect an (almost empty) in.osm?

Yes, in.osm would not be necessarily empty
Seed + whatever measure ran until halted.

And the reason for preserving in.osm is mainly to stay consistent with the classic workflow? You don't think it makes more sense to not produce the in.osm?

Consistent with workflow-gem.

And I could see myself wanting to look at in.osm (I could halt workflow before FT for that reason: don't fail, but produce the model with measures applied). Anyways, if I even think there's a valid application out there and I don't see a strong drawback, I'd want to keep the existing behavior in check.

And I do not see a strong drawback here (only one I can think of is disk space, but that's not a very pressing concern).

Note that you can specify the "completed status" when you halt the workflow, and it can be "Success", "Fail", "Invalid", and "Cancel". We are using "Invalid" in ResStock, which arguably could mean that you shouldn't get an in.osm. But it's not the end of the world. The most important thing is to not get an in.idf, considering that you won't be running the simulation.

jmarrec · 2025-12-08T10:50:27Z

@joseph-robertson I'm tempted to say that the RunPreprocess check for halted is misplaced in the original workflow gem: https://github.com/NREL/OpenStudio-workflow-gem/blob/4a799dbf4c5477610c9e9665dfa7729fe74fc52e/lib/openstudio/workflow/jobs/run_preprocess.rb#L46-L49

the C++ implementation does it exactly the same.

OpenStudio/src/workflow/RunPreProcess.cpp

Lines 50 to 54 in 887ed96

    
           // Skip the pre-processor if halted 
        
           if (runner.halted()) { 
        
             LOG(Info, "Workflow halted, skipping the EnergyPlus pre-processor"); 
        
             return; 
        
           }

I don't see why you would create pre-process.idf and apply energyplus output requests if you halted, and didn't create an IDF to begin with.

(But then again, I completely fail to see what haltWorkflow is all about since I never had a use case for it)

…): no point creating pre-process.idf nor collecting E+ output requests

shorowit · 2025-12-08T14:27:57Z

(But then again, I completely fail to see what haltWorkflow is all about since I never had a use case for it)

It’s possible that ResStock (and I assume ComStock) are the only users of it. It’s used to skip simulations when an upgrade doesn’t apply to a given building sample. See #2601

jmarrec · 2025-12-09T08:08:27Z

@anchapin the windows node is offline and can't be launched from jenkins admin panel

https://ci.openstudio.net/computer/openstudio%2Dwin%2Dserver%2Dvs%2D2019%2Dssh%2Dincr%2Daws/log

SSHLauncher{...}
[12/09/25 08:07:16] [SSH] Opening SSH connection to xxx.xxx.xxx.xxx

No route to host (Host unreachable)
SSH Connection failed with IOException: "No route to host (Host unreachable)", retrying in 30 seconds. There are 3 more retries left.

anchapin · 2025-12-09T15:47:23Z

@anchapin the windows node is offline and can't be launched from jenkins admin panel

https://ci.openstudio.net/computer/openstudio%2Dwin%2Dserver%2Dvs%2D2019%2Dssh%2Dincr%2Daws/log
SSHLauncher{...}
[12/09/25 08:07:16] [SSH] Opening SSH connection to xxx.xxx.xxx.xxx

No route to host (Host unreachable)
SSH Connection failed with IOException: "No route to host (Host unreachable)", retrying in 30 seconds. There are 3 more retries left.

I'm working on making a new windows node on AWS since our old one had to be shut down. I'm hoping it will be ready soon but I'm dealing with 'packer' difficulties.

joseph-robertson · 2025-12-11T02:27:42Z

Run folder:

Before

After

ci-commercialbuildings · 2025-12-15T17:59:14Z

CI Results for bd3c759:

Ubuntu 24.04:
Ubuntu 22.04:
Darwin:
Windows:
- OpenStudio-3.11.0-rc1+bd3c759684-Windows.exe
- OpenStudio-3.11.0-rc1+bd3c759684-Windows.tar.gz
Code Coverage:

joseph-robertson self-assigned this Dec 2, 2025

joseph-robertson added severity - Normal Bug component - Workflow Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge. labels Dec 2, 2025

joseph-robertson changed the base branch from develop to 3.11.0-rc1 December 2, 2025 20:36

joseph-robertson changed the title ~~Return before FT for halted workflow~~ For halted workflow, return before FT and OSM save Dec 2, 2025

joseph-robertson added 2 commits December 4, 2025 00:20

Return before FT for halted workflow.

f5a8716

Return before saving OSM for halted workflow.

0b2eb37

jmarrec force-pushed the fix-halt-workflow branch from c55f9ad to 0b2eb37 Compare December 3, 2025 23:20

Merge branch 'develop' into fix-halt-workflow

982783d

joseph-robertson changed the base branch from 3.11.0-rc1 to develop December 4, 2025 16:43

shorowit mentioned this pull request Dec 4, 2025

IDF/OSM generated even though run is "Invalid" NREL/resstock#1540

Closed

Remove temporary comment.

6792a3c

joseph-robertson marked this pull request as ready for review December 5, 2025 23:27

jmarrec requested changes Dec 8, 2025

View reviewed changes

jmarrec added 2 commits December 8, 2025 11:45

Revert not debug saving

a71cca8

Don't re-save IDF at the end

3476260

If you halted and didn't do anything in runTranslator (no IDF created…

3afeb78

…): no point creating pre-process.idf nor collecting E+ output requests

Trigger new windows build.

9b52600

joseph-robertson requested a review from jmarrec December 11, 2025 02:30

Merge branch 'develop' into fix-halt-workflow

bd3c759

joseph-robertson merged commit 5eac20d into develop Dec 15, 2025
3 of 6 checks passed

joseph-robertson deleted the fix-halt-workflow branch December 15, 2025 20:46

For halted workflow, return before FT and OSM save #5539

For halted workflow, return before FT and OSM save #5539

Conversation

joseph-robertson commented Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull request overview

Pull Request Author

Review Checklist

Uh oh!

github-actions bot commented Dec 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🧪 Test Results Dashboard

Summary

⚠️ Minor Issues Detected

🔍 Failed Tests (10 failures)

Linux-c++ (10 failures)

📊 Test Run Information

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jmarrec commented Dec 8, 2025

Uh oh!

shorowit commented Dec 8, 2025

Uh oh!

jmarrec commented Dec 9, 2025

Uh oh!

anchapin commented Dec 9, 2025

Uh oh!

joseph-robertson commented Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ci-commercialbuildings commented Dec 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

joseph-robertson commented Dec 2, 2025 •

edited

Loading

github-actions bot commented Dec 5, 2025 •

edited

Loading

joseph-robertson commented Dec 11, 2025 •

edited

Loading

ci-commercialbuildings commented Dec 15, 2025 •

edited

Loading