Fix #5125 - Add versionModified, repo, org, releaseTag to BCLSearchResult #5126

jmarrec · 2024-03-26T14:00:24Z

Pull request overview

Fix Searching the BCL for components and measures should be more helpful (and more up to date): add version_modified, repo_url to BCLSearchResult #5125
Add versionModified, repo, org, releaseTag to BCLSearchResult
- shush some annoying warnings due to trying to parse VersionString with empty string (lots of them printed out)

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

…sult + shush some annoying warnings due to trying to parse VersionString with empty string

Needs NREL/OpenStudio#5126

jmarrec · 2024-03-26T14:00:55Z

src/utilities/bcl/BCL.hpp

+  std::string org() const;
+  std::string repo() const;
+  std::string releaseTag() const;
+  boost::optional<openstudio::DateTime> versionModified() const;


New functions for BCLSearchResults

jmarrec · 2024-03-26T14:01:25Z

src/utilities/bcl/BCL.cpp

+  if (auto orgElement = componentElement.child("org")) {
+    m_org = orgElement.text().as_string();
+  }
+  if (auto repoElement = componentElement.child("repo")) {
+    m_repo = repoElement.text().as_string();
+  }
+  if (auto release_tagElement = componentElement.child("release_tag")) {
+    m_releaseTag = release_tagElement.text().as_string();
+  }
+  if (auto versionModifiedElement = componentElement.child("version_modified")) {
+    const std::string versionModified = versionModifiedElement.text().as_string();
+    if (!versionModified.empty()) {
+      // fromXsdDateTime forwards to fromISO8601 and handles both formats
+      if (auto dt_ = openstudio::DateTime::fromXsdDateTime(versionModified)) {
+        m_versionModified = *dt_;
+      }
+    }
+  }


jmarrec · 2024-03-26T14:01:42Z

src/utilities/bcl/test/BCL_GTest.cpp

+TEST_F(BCLFixture, RemoteBCL_BCLSearchResult) {
+  RemoteBCL remoteBCL;
+
+  const std::string openstudio_results_uid = "a25386cd-60e4-46bc-8b11-c755f379d916";
+  // get openstudio_results
+  // std::vector<BCLSearchResult> responses = remoteBCL.searchMeasureLibrary("openstudio_results", 980);
+  std::vector<BCLSearchResult> responses = remoteBCL.searchMeasureLibrary(openstudio_results_uid, 980);
+
+  ASSERT_EQ(1, responses.size());
+  auto& response = responses.front();
+
+  EXPECT_FALSE(response.name().empty());
+  EXPECT_EQ("Openstudio results", response.name());
+
+  EXPECT_FALSE(response.uid().empty());
+  EXPECT_EQ(openstudio_results_uid, response.uid());
+
+  EXPECT_FALSE(response.versionId().empty());
+  EXPECT_FALSE(response.description().empty());
+  EXPECT_FALSE(response.modelerDescription().empty());
+  EXPECT_TRUE(response.fidelityLevel().empty());
+  EXPECT_EQ("measure", response.componentType());
+
+  EXPECT_TRUE(response.provenanceRequired());
+  EXPECT_TRUE(response.provenances().empty());
+  EXPECT_FALSE(response.tags().empty());
+  EXPECT_FALSE(response.attributes().empty());
+  EXPECT_FALSE(response.files().empty());
+  EXPECT_TRUE(response.costs().empty());
+
+  EXPECT_FALSE(response.org().empty());
+  EXPECT_EQ("NREL", response.org());
+  EXPECT_FALSE(response.repo().empty());
+  EXPECT_EQ("openstudio-common-measures-gem", response.repo());
+  EXPECT_FALSE(response.releaseTag().empty());
+
+  auto dt_ = response.versionModified();
+  ASSERT_TRUE(dt_);
+  const openstudio::DateTime dateTime(Date(MonthOfYear::Nov, 14, 2022));
+  EXPECT_GT(*dt_, dateTime);
+}


src/utilities/bcl/test/BCL_GTest.cpp

ci-commercialbuildings · 2024-03-27T15:54:19Z

CI Results for 8dc8a9c:

Ubuntu 20.04:
Ubuntu 22.04:
Darwin:
- OpenStudio-3.8.0-beta+4e66cbb91d-Darwin-x86_64.dmg
- OpenStudio-3.8.0-beta+4e66cbb91d-Darwin-x86_64.tar.gz
Windows:
Code Coverage:

joseph-robertson · 2024-03-27T15:57:53Z

src/utilities/bcl/test/BCL_GTest.cpp

+  EXPECT_EQ("NREL", response.org());
+  EXPECT_FALSE(response.repo().empty());
+  EXPECT_EQ("openstudio-common-measures-gem", response.repo());
+  EXPECT_FALSE(response.releaseTag().empty());


What does it equal then?

https://bcl.nrel.gov/api/search/?fq=uuid:a25386cd-60e4-46bc-8b11-c755f379d916&all_content_versions=1

Currently that's v0.9.0. But this is going to change every time the openstudio_results is updated, so I don't want to pin it and have to update the test

Needs NREL/OpenStudio#5126

jmarrec added 3 commits March 26, 2024 13:38

Fix #5125 - Add versionModified, repo, org, releaseTag to BCLSEarchRe…

d78870d

…sult + shush some annoying warnings due to trying to parse VersionString with empty string

Use an optional DateTime directly instead of storing a std::string

80b5d88

Add test for new BCLSearchResult (and existing) members

c36bfae

jmarrec added component - Measures component - Utilities Other Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge. labels Mar 26, 2024

jmarrec self-assigned this Mar 26, 2024

jmarrec marked this pull request as ready for review March 26, 2024 14:00

jmarrec added a commit to openstudiocoalition/OpenStudioApplication that referenced this pull request Mar 26, 2024

Implement org, repo, etc

09b9c24

Needs NREL/OpenStudio#5126

jmarrec mentioned this pull request Mar 26, 2024

#672 - More BCLSearchResults info (pending a PR) openstudiocoalition/OpenStudioApplication#698

Open

jmarrec commented Mar 27, 2024

View reviewed changes

Adjust test

8dc8a9c

jmarrec requested a review from joseph-robertson March 27, 2024 15:43

joseph-robertson requested changes Mar 27, 2024

View reviewed changes

joseph-robertson self-requested a review March 27, 2024 16:02

joseph-robertson approved these changes Mar 27, 2024

View reviewed changes

jmarrec merged commit 1b653ae into develop Mar 27, 2024
3 of 6 checks passed

jmarrec deleted the 5125_BCLSearchResult_Improve branch March 27, 2024 16:03

jmarrec added a commit to openstudiocoalition/OpenStudioApplication that referenced this pull request May 13, 2024

Implement org, repo, etc

81d6ee9

Needs NREL/OpenStudio#5126

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix #5125 - Add versionModified, repo, org, releaseTag to BCLSearchResult #5126

Fix #5125 - Add versionModified, repo, org, releaseTag to BCLSearchResult #5126

jmarrec commented Mar 26, 2024

jmarrec Mar 26, 2024

jmarrec Mar 26, 2024

jmarrec Mar 26, 2024

ci-commercialbuildings commented Mar 27, 2024 •

edited

joseph-robertson Mar 27, 2024

jmarrec Mar 27, 2024

Fix #5125 - Add versionModified, repo, org, releaseTag to BCLSearchResult #5126

Fix #5125 - Add versionModified, repo, org, releaseTag to BCLSearchResult #5126

Conversation

jmarrec commented Mar 26, 2024

Pull request overview

Pull Request Author

Review Checklist

jmarrec Mar 26, 2024

Choose a reason for hiding this comment

jmarrec Mar 26, 2024

Choose a reason for hiding this comment

jmarrec Mar 26, 2024

Choose a reason for hiding this comment

ci-commercialbuildings commented Mar 27, 2024 • edited

joseph-robertson Mar 27, 2024

Choose a reason for hiding this comment

jmarrec Mar 27, 2024

Choose a reason for hiding this comment

ci-commercialbuildings commented Mar 27, 2024 •

edited