Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

#Fix 9436 - TIMESTAMP Column in Custom Monthly Report Tables under both peak heating and peak cooling report has a trailing space #9647

Merged
merged 3 commits into from
Sep 15, 2022
Merged

#Fix 9436 - TIMESTAMP Column in Custom Monthly Report Tables under both peak heating and peak cooling report has a trailing space #9647

merged 3 commits into from
Sep 15, 2022

Conversation

jmarrec
Copy link
Contributor

@jmarrec jmarrec commented Sep 6, 2022

Pull request overview

Pull Request Author

Add to this list or remove from it as applicable. This is a simple templated set of guidelines.

  • Title of PR should be user-synopsis style (clearly understandable in a standalone changelog context)
  • Label the PR with at least one of: Defect, Refactoring, NewFeature, Performance, and/or DoNoPublish
  • Pull requests that impact EnergyPlus code must also include unit tests to cover enhancement or defect repair
  • Author should provide a "walkthrough" of relevant code changes using a GitHub code review comment process
  • If any diffs are expected, author must demonstrate they are justified using plots and descriptions
  • If changes fix a defect, the fix should be demonstrated in plots and descriptions
  • If any defect files are updated to a more recent version, upload new versions here or on DevSupport
  • If IDD requires transition, transition source, rules, ExpandObjects, and IDFs must be updated, and add IDDChange label
  • If structural output changes, add to output rules file and add OutputChange label
  • If adding/removing any LaTeX docs or figures, update that document's CMakeLists file dependencies

Reviewer

This will not be exhaustively relevant to every PR.

  • Perform a Code Review on GitHub
  • If branch is behind develop, merge develop and build locally to check for side effects of the merge
  • 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
  • Check that performance is not impacted (CI Linux results include performance check)
  • Run Unit Test(s) locally
  • Check any new function arguments for performance impacts
  • Verify IDF naming conventions and styles, memos and notes and defaults
  • If new idf included, locally check the err file and other outputs

@jmarrec
Add a gtest for #9436 that shows the issue
3e2c973 
```shell
[ RUN      ] SQLiteFixture.OutputReportTabularMonthly_CurlyBraces
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/OutputReportTabular.unit.cc:10147: Failure
Failed
Extra space after brace in monthly table for : 'ELECTRICITY:FACILITY {TIMESTAMP} '
[  FAILED  ] SQLiteFixture.OutputReportTabularMonthly_CurlyBraces (218 ms)
```
@jmarrec
Fix #9436 -Remove space in {TIMESTAMP} columns
6f40375
@jmarrec
TODO: UPDATE ME. Add to Output Changes
9199a43
@jmarrec jmarrec added the Defect Includes code to repair a defect in EnergyPlus label Sep 6, 2022
@jmarrec jmarrec self-assigned this Sep 6, 2022
amirroth
amirroth reviewed Sep 6, 2022
View reviewed changes
tst/EnergyPlus/unit/OutputReportTabular.unit.cc
@@ -10132,6 +10132,20 @@ TEST_F(SQLiteFixture, OutputReportTabularMonthly_CurlyBraces)
std::string colHeader = col[0];
EXPECT_TRUE(false) << "Missing braces in monthly table for : " << colHeader;
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to add a unit test for this type of thing? I think we've lost the plot on unit tests.

@jmarrec jmarrec added this to the EnergyPlus 22.2 milestone Sep 15, 2022
Myoldmopar
Myoldmopar approved these changes Sep 15, 2022
View reviewed changes
Copy link
Member

@Myoldmopar Myoldmopar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great. Although it's technically an output change, it's the right move, and I suspect the primary consumer of this is the one proposing the change. Good to go.

tst/EnergyPlus/unit/OutputReportTabular.unit.cc
for (auto &col : extraSpaceAfterBracesHeaders) {
std::string colHeader = col[0];
ADD_FAILURE() << "Extra space after brace in monthly table for : '" << colHeader << "'";
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

src/EnergyPlus/OutputReportTabular.cc
@@ -7534,7 +7534,7 @@ void WriteMonthlyTables(EnergyPlusData &state)
curConversionFactor *= 3600.0;
}
columnHead(columnRecount - 1) = ort->MonthlyColumns(curCol).varName + curAggString + " [" + curUnits + ']';
columnHead(columnRecount) = ort->MonthlyColumns(curCol).varName + " {TIMESTAMP} ";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

src/Transition/OutputRulesFiles/OutputChanges22-1-0-to-22-2-0.md
@@ -100,17 +100,21 @@ The Adaptive Comfort Summary/Report was renamed to match the HTML:

See pull request [#9461](https://github.com/NREL/EnergyPlus/pull/9461) for more details.

### Output:Table:Monthly and Output:Table:Annual

In `Output:Table:Monthly` and `Output:Table:Annual`, variables with an aggregation type such as `Maximum`, `Minimum`, `MaximumDuringHoursShown`, and `MinimumDuringHoursShown` produce an extra `<Variable of Meter Name> {TIMESTAMP}` column that had an extra trailing space in the SQL. That extra trailing space was removed. cf [#9647](https://github.com/NREL/EnergyPlus/pull/9647)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for documenting it here.

@Myoldmopar
Copy link
Member

Builds and tests fine, merging.

@Myoldmopar Myoldmopar merged commit de5b76f into develop Sep 15, 2022
@Myoldmopar Myoldmopar deleted the 9436_SQL_Timestamp_trailing branch September 15, 2022 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@amirroth amirroth amirroth left review comments

@Myoldmopar Myoldmopar Myoldmopar approved these changes

Assignees

@jmarrec jmarrec

Labels
Defect Includes code to repair a defect in EnergyPlus
Projects
None yet
Milestone
EnergyPlus 22.2
6 participants
@jmarrec @Myoldmopar @amirroth @nrel-bot @nrel-bot-3 @nrel-bot-2c