Fix #5546 - Adjust overrride of Dir.glob so that it finds json_schema attributes by jmarrec · Pull Request #5548 · NatLabRockies/OpenStudio

jmarrec · 2025-12-09T10:02:55Z

Pull request overview

Fixes json-schema gem is broken #5546

Demonstration

git@github.com:voxpupuli/json-schema.git
cd json-schema/lib
gvim test.rb

test.rb

files = [
  "json-schema/attributes/format.rb",
  "json-schema/attributes/formats/custom.rb"
]

match_all_patterns = [
  "json-schema/**/*.rb",
  "json-schema/attributes/**/*.rb",
]

match_only_single_patterns = [
  "json-schema/attributes/*.rb",
  "json-schema/attributes/*/*.rb",
]

puts "|             Pattern            |                   File                   | Matches  | Matches (FNM_PATHNAME) | Expected |"
puts "|--------------------------------|------------------------------------------|----------|------------------------|----------|"
match_all_patterns.each do |pattern|
  files.each do |f|
    matches = File.fnmatch(pattern, f)
    matches_pathname = File.fnmatch(pattern, f, File::FNM_PATHNAME)
    expected = Dir.glob(pattern).include?(f)
    puts "| #{pattern.ljust(30)} | #{f.ljust(40)} | #{matches.to_s.center(8)} | #{matches_pathname.to_s.center(22)} | #{expected.to_s.center(8)} |"
  end
end

match_only_single_patterns.each do |pattern|
  files.each do |f|
    matches = File.fnmatch(pattern, f)
    matches_pathname = File.fnmatch(pattern, f, File::FNM_PATHNAME)
    expected = Dir.glob(pattern).include?(f)
    puts "| #{pattern.ljust(30)} | #{f.ljust(40)} | #{matches.to_s.center(8)} | #{matches_pathname.to_s.center(22)} | #{expected.to_s.center(8)} |"
  end
end

$ruby test.rb
|             Pattern            |                   File                   | Matches  | Matches (FNM_PATHNAME) | Expected |
|--------------------------------|------------------------------------------|----------|------------------------|----------|
| json-schema/**/*.rb            | json-schema/attributes/format.rb         |   true   |          true          |   true   |
| json-schema/**/*.rb            | json-schema/attributes/formats/custom.rb |   true   |          true          |   true   |
| json-schema/attributes/**/*.rb | json-schema/attributes/format.rb         |  false   |          true          |   true   |
| json-schema/attributes/**/*.rb | json-schema/attributes/formats/custom.rb |   true   |          true          |   true   |
| json-schema/attributes/*.rb    | json-schema/attributes/format.rb         |   true   |          true          |   true   |
| json-schema/attributes/*.rb    | json-schema/attributes/formats/custom.rb |   true   |         false          |  false   |
| json-schema/attributes/*/*.rb  | json-schema/attributes/format.rb         |  false   |         false          |  false   |
| json-schema/attributes/*/*.rb  | json-schema/attributes/formats/custom.rb |   true   |          true          |   true   |

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 · 2025-12-09T10:04:01Z

+    # Without this 'path/**/*.rb' will match 'path/sub/file.rb' but not 'path/file.rb', cf #5546
+    flags = flags | File::FNM_PATHNAME


Can't be fooled by the amount of code change, massive pain to diagnose and fix.

<broken record>We should drop the embedded shenanigans!</broken record>

github-actions · 2025-12-09T10:14:53Z

🧪 Test Results Dashboard

Summary

Metric	Value
Total Tests	4156
Passed	4146
Failed	10
Errors	0
Skipped	0
Success Rate	99.8%
Generated	2025-12-12 18:05:27 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

… attributes ``` git@github.com:voxpupuli/json-schema.git cd json-schema/lib gvim test.rb ``` **test.rb** ```ruby files = [ "json-schema/attributes/format.rb", "json-schema/attributes/formats/custom.rb" ] match_all_patterns = [ "json-schema/**/*.rb", "json-schema/attributes/**/*.rb", ] match_only_single_patterns = [ "json-schema/attributes/*.rb", "json-schema/attributes/*/*.rb", ] puts "| Pattern | File | Matches | Matches (FNM_PATHNAME) | Expected |" puts "|--------------------------------|------------------------------------------|----------|------------------------|----------|" match_all_patterns.each do |pattern| files.each do |f| matches = File.fnmatch(pattern, f) matches_pathname = File.fnmatch(pattern, f, File::FNM_PATHNAME) expected = Dir.glob(pattern).include?(f) puts "| #{pattern.ljust(30)} | #{f.ljust(40)} | #{matches.to_s.center(8)} | #{matches_pathname.to_s.center(22)} | #{expected.to_s.center(8)} |" end end match_only_single_patterns.each do |pattern| files.each do |f| matches = File.fnmatch(pattern, f) matches_pathname = File.fnmatch(pattern, f, File::FNM_PATHNAME) expected = Dir.glob(pattern).include?(f) puts "| #{pattern.ljust(30)} | #{f.ljust(40)} | #{matches.to_s.center(8)} | #{matches_pathname.to_s.center(22)} | #{expected.to_s.center(8)} |" end end ``` ``` $ruby test.rb | Pattern | File | Matches | Matches (FNM_PATHNAME) | Expected | |--------------------------------|------------------------------------------|----------|------------------------|----------| | json-schema/**/*.rb | json-schema/attributes/format.rb | true | true | true | | json-schema/**/*.rb | json-schema/attributes/formats/custom.rb | true | true | true | | json-schema/attributes/**/*.rb | json-schema/attributes/format.rb | false | true | true | | json-schema/attributes/**/*.rb | json-schema/attributes/formats/custom.rb | true | true | true | | json-schema/attributes/*.rb | json-schema/attributes/format.rb | true | true | true | | json-schema/attributes/*.rb | json-schema/attributes/formats/custom.rb | true | false | false | | json-schema/attributes/*/*.rb | json-schema/attributes/format.rb | false | false | false | | json-schema/attributes/*/*.rb | json-schema/attributes/formats/custom.rb | true | true | true | ```

jmarrec · 2025-12-09T10:19:19Z

+  def test_json_schema
+    require 'json-schema'
+
+    schema = {
+      "type" => "object",
+      "required" => ["a"],
+      "properties" => {
+        "a" => {
+          "type" => "integer"
+        }
+      }
+    }
+
+    data_valid = { "a" => 5 }
+    JSON::Validator.validate(schema, data_valid)
+
+    data_invalid = { "a" => "taco" }
+
+    error = assert_raises(JSON::Schema::ValidationError) do
+      # "The property '#/a' of type String did not match the following type: integer"
+      JSON::Validator.validate!(schema, data_invalid)
+    end
+    assert_match(/The property '#\/a' of type string did not match the following type: integer/, error.message)
+
+  end


As @shorowit pointed out, a test is an excellent idea...

Before fix

1) Error: EmbeddedRuby_Test#test_json_schema: NoMethodError: undefined method `validate' for nil:NilClass :/ruby/3.2.0/gems/json-schema-4.3.1/lib/json-schema/schema/validator.rb:25:in `block in validate' :/ruby/3.2.0/gems/json-schema-4.3.1/lib/json-schema/schema/validator.rb:23:in `each' :/ruby/3.2.0/gems/json-schema-4.3.1/lib/json-schema/schema/validator.rb:23:in `validate' :/ruby/3.2.0/gems/json-schema-4.3.1/lib/json-schema/schema.rb:32:in `validate' :/ruby/3.2.0/gems/json-schema-4.3.1/lib/json-schema/validator.rb:115:in `validate' :/ruby/3.2.0/gems/json-schema-4.3.1/lib/json-schema/validator.rb:259:in `validate!' :/ruby/3.2.0/gems/json-schema-4.3.1/lib/json-schema/validator.rb:243:in `validate' /home/julien/Software/Others/OpenStudio/src/cli/test/test_embedded_ruby.rb:259:in `test_json_schema'

…6_json_schema

ci-commercialbuildings · 2025-12-12T18:24:35Z

CI Results for 8f0f77f:

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

shorowit

Confirmed that the gem now runs.

jmarrec self-assigned this Dec 9, 2025

jmarrec added severity - Normal Bug component - CLI Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge. component - Ruby bindings labels Dec 9, 2025

jmarrec commented Dec 9, 2025

View reviewed changes

jmarrec requested a review from shorowit December 9, 2025 10:05

jmarrec added 2 commits December 9, 2025 11:15

#5546 - add a json_schema test in test_embedded_ruby.rb

6554c95

jmarrec force-pushed the 5546_json_schema branch from d18db0d to 708b0a1 Compare December 9, 2025 10:18

jmarrec commented Dec 9, 2025

View reviewed changes

Merge branch 'develop' of https://github.com/NREL/OpenStudio into 554…

8f0f77f

…6_json_schema

shorowit approved these changes Dec 12, 2025

View reviewed changes

anchapin merged commit 160ffa4 into develop Dec 12, 2025
3 of 6 checks passed

anchapin deleted the 5546_json_schema branch December 12, 2025 20:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix #5546 - Adjust overrride of Dir.glob so that it finds json_schema attributes#5548

Fix #5546 - Adjust overrride of Dir.glob so that it finds json_schema attributes#5548
anchapin merged 3 commits into
developfrom
5546_json_schema

jmarrec commented Dec 9, 2025

Uh oh!

jmarrec Dec 9, 2025

Uh oh!

github-actions Bot commented Dec 9, 2025 •

edited

Loading

Uh oh!

jmarrec Dec 9, 2025

Uh oh!

ci-commercialbuildings commented Dec 12, 2025 •

edited

Loading

Uh oh!

shorowit left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		# Without this 'path/*/.rb' will match 'path/sub/file.rb' but not 'path/file.rb', cf #5546
		flags = flags \| File::FNM_PATHNAME

Conversation

jmarrec commented Dec 9, 2025

Pull request overview

Demonstration

Pull Request Author

Review Checklist

Uh oh!

jmarrec Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Dec 9, 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!

jmarrec Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

shorowit left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions Bot commented Dec 9, 2025 •

edited

Loading

ci-commercialbuildings commented Dec 12, 2025 •

edited

Loading