Upgrading ruby to 3.3

[kbrock]

3.2 ref

Highlights:

• optional: Regexp.timeout = 1.0 or Regexp.new('^a*b?a*()\1$', timeout: Float::INFINITY)
• All methods wishing to delegate keyword arguments through *args must now be marked with ruby2_keywords, with no exception.
• Hash#shift (empty returns nil instead of default)
• Struct no longer needs keyword_init
• removed: Fixnum, Bignum Random::DEFAULT, Struct::Group, Struct::Passwd
• removed: Dir.exists?, File.exists?
• removed: Kernel#=~, Kernel#taint, Kernel#untaint, Kernel#tainted?, Kernel#trust, Kernel#untrust, Kernel#untrusted?
• lib no longer included: libyaml. (was in psych. May need libyaml-dev on ubuntu)
• lib no longer included: libffi. (was in fiddle - only used on windows)
• add Queue#pop, SizedQueue#push, SizedQueue#pop added param timeout:

3.3

punt:

• ERB::Util.html_escape is made faster than CGI.escapeHTML
• no longer need require "set" (supporting older ruby versions)
  • this is not hurting anyone, and this change is not compatible for ruby <3.2 - which we still support

External PRs

These were changed in external libraries and make using them easier, but are not required for our upgrade.

• Extracted: Update gemspec dependencies for ruby 3 oVirt/ovirt-engine-sdk-ruby#19
• update signature for hash_foreach value oVirt/ovirt-engine-sdk-ruby#17
• Lenient call with gvl ruby/ruby#11649

Related PRs

• update signature for hash_foreach value oVirt/ovirt-engine-sdk-ruby#17
• Drop openstruct activerecord-virtual_attributes#171
• Test with Ruby 3.1 and 3.3 amazon_ssa_support#128
• Test with Ruby 3.1 and 3.3 dbus_api_service#55
• Testing with ruby 3.2, 3.3 (keeping 2.6, 2.7) linux_admin#256
• spec: Support ruby 3.1 and 3.3 error message formats #23203
• Gemfile supports ruby 3.3 #23204
• Upgrade fast_gettext #23205
• Fix Marshal.load ArgumentError on ruby3.3 #23219
• DRb has been extracted from stdlib to a gem #23232
• upgrade Factorybot to ruby3.3 friendly version #23234
• test with ruby 3.3 manageiq-appliance-build#577
• Set ruby stream to 3.3 manageiq-appliance-build#578
• test with ruby 3.3 manageiq-appliance_console#269
• Testing with ruby 3.2, 3.3 manageiq-api#1270
• Testing with ruby 3.2, 3.3 manageiq-automation_engine#559
• Testing with ruby 3.2, 3.3 manageiq-content#754
• Testing with ruby 3.2, 3.3 manageiq-consumption#223
• Testing with ruby 3.2, 3.3 (keeping 2.5-2.7) manageiq-cross_repo#111
• Testing with ruby 3.2, 3.3 manageiq-decorators#108
• Testing with ruby 3.3 manageiq-decorators#109
• Test with Ruby 3.1 and 3.3 manageiq-gems-pending#597
• Testing with ruby 3.2, 3.3 manageiq-schema#755
• Testing with ruby 3.2, 3.3 manageiq-ui-classic#9277
• Drop sass rails manageiq-ui-classic#9286
• Fix bin/webpack when ui-classic not bundled manageiq-ui-classic#9293
• Testing with ruby 3.2, 3.3 (keep supporting 2.7) manageiq-password#45
• Switch to ruby 3.3 manageiq-pods#1184
• Testing with ruby 3.2, 3.3 (keep supporting 2.6, 2.7) manageiq-ssh-util#27
• Remove Kernel.taint manageiq-smartstate#199
• Testing with ruby 3.3 manageiq-smartstate#208
• Testing with ruby 3.2, 3.3 manageiq-schema#765
• [WIP] explictly require fiddle more_core_extensions#124
• Testing with ruby 3.2, 3.3 (keeping 2.5-2.7) more_core_extensions#125
• Testing with ruby 3.2, 3.3 multi_repo#35
• Drop end of life rails < 7 and only support rubies 7 supports, 2.7+ (breaking change) ovirt_metrics#58
• Build rpms using ruby 3.3 manageiq-rpm_build#517

providers:

• Testing with ruby 3.2, 3.3 manageiq-providers-amazon#870
• Testing with ruby 3.2, 3.3 manageiq-providers-ansible_tower#315
• Testing with ruby 3.2, 3.3 manageiq-providers-autosde#252
• test with ruby 3.3 manageiq-providers-awx#38
• Testing with ruby 3.2, 3.3 manageiq-providers-azure#562
• Testing with ruby 3.2, 3.3 manageiq-providers-azure_stack#111
• Test with Ruby 3.1 and 3.3 manageiq-providers-cisco_intersight#122
• Test with 3.3 manageiq-providers-dummy_provider#65
• test with Ruby3.3 manageiq-providers-embedded_terraform#85
• Testing with ruby 3.2, 3.3 manageiq-providers-foreman#133
• Testing with ruby 3.2, 3.3 manageiq-providers-google#270
• Test with Ruby 3.1 and 3.3 manageiq-providers-ibm_cic#53
• Testing with ruby 3.2, 3.3 manageiq-providers-ibm_cloud#506
• Testing with ruby 3.3 manageiq-providers-ibm_power_hmc#163
• Testing with ruby 3.2, 3.3 manageiq-providers-ibm_power_vc#119
• Testing with ruby 3.2, 3.3 manageiq-providers-ibm_terraform#111
• Test with Ruby 3.1 and 3.3 manageiq-providers-ibm_terraform#112
• Testing with ruby 3.2, 3.3 manageiq-providers-kubernetes#540
• Testing with ruby 3.2, 3.3 manageiq-providers-kubevirt#253
• Testing with ruby 3.2, 3.3 manageiq-providers-lenovo#417
• Testing with ruby 3.2, 3.3 manageiq-providers-nsxt#129
• Testing with ruby 3.2, 3.3 manageiq-providers-nuage#322
• Testing with ruby 3.2, 3.3 manageiq-providers-openshift#270
• Testing with ruby 3.2, 3.3 manageiq-providers-openstack#891
• Testing with ruby 3.2, 3.3 manageiq-providers-oracle_cloud#107
• Test with Ruby 3.1 and 3.3 manageiq-providers-oracle_cloud#109
• Testing with ruby 3.2, 3.3 manageiq-providers-ovirt#678
• Test with ruby 3.3 manageiq-providers-red_hat_virtualization#56
• Testing with ruby 3.2, 3.3 manageiq-providers-redfish#207
• Testing with ruby 3.2, 3.3 manageiq-providers-vmware#923
• test with ruby 3.3 manageiq-providers-workflows#120

current solution

gem install --verbose ovirt-engine-sdk -v4.6.0 -- --with-cflags="-Wno-error=incompatible-function-pointer-types -Wno-error=implicit-function-declaration"

[jrafanie]

@kbrock Even if we jump from 3.1 to 3.3 in a release, we should include 3.2 with 3.3 so if they fail in CI, we can determine if it's a problem unique to 3.3 or also a problem in 3.2

[kbrock]

Yea, since we will never use 3.2, I'm mixed on this one.
Already got 2 thumbs up, so I'll add it.
But it seems a waste of cycles and unnecessary granularity

[bdunne]

For build, EL9 ships with ruby 3.0 by default and has dnf modules for 3.1 and 3.3, but not 3.2.

[Fryguy]

so weird that el9 jumped a version 😕

[kbrock]

The gem build failure for ovirt-engine-sdk is frustrating.
I can see that @jrafanie and others had issues building it for oVirt/ovirt-engine-sdk-ruby#11

Hopefully it shouldn't be too hard. Guess this is where it all begins. Wish they had a C guide titled "this is what changed over the past 20 years" - because that code has a bunch of stuff I do not recognize

[jrafanie]

ov_http_request.c:75:29: warning: excess elements in array initializer
   75 |         .reserved = { NULL, NULL }
      |                             ^~~~
ov_http_request.c:75:29: note: (near initialization for
‘ov_http_request_type.function.reserved’)
ov_http_request.c: In function ‘ov_http_request_define’:
ov_http_request.c:347:77: error: ‘rb_cData’ undeclared (first use in this
function)
347 |     ov_http_request_class = rb_define_class_under(ov_module,
"HttpRequest", rb_cData);
|                                                                         
^~~~~~~~
ov_http_request.c:347:77: note: each undeclared identifier is reported only once
for each function it appears in
ov_http_request.c: At top level:
cc1: note: unrecognized command-line option ‘-Wno-self-assign’ may have been
intended to silence earlier diagnostics
cc1: note: unrecognized command-line option ‘-Wno-parentheses-equality’ may have
been intended to silence earlier diagnostics
cc1: note: unrecognized command-line option ‘-Wno-constant-logical-operand’ may
have been intended to silence earlier diagnostics
make: *** [Makefile:248: ov_http_request.o] Error 1

This looks alittle different. There's no option reported in the output to silence it.

[Fryguy]

That's also an error, whereas the others were warnings.

[jrafanie]

That's also an error, whereas the others were warnings.

sorry, it's different than the one we had previously where it told you that you can ignore it by opting into that behavior:

implicit function declarations [-Wimplicit-function-declaration]

oVirt/ovirt-engine-sdk-ruby#11

This one is a undeclared variable if I'm reading correctly.

[micwoj92]

@jrafanie in the linked issue from your last comment you tried to build version 4.6.0 of ovirt engine sdk. This error is because the CI pulls 4.4.1 and it is unrelated. This issue has already been fixed with latest version. See oVirt/ovirt-engine-sdk-ruby@97df88c

[kbrock]

@miq-bot cross_repo_test #23142 including ManageIQ/manageiq-providers-ovirt#676 ManageIQ/manageiq-providers-red_hat_virtualization#54

[Fryguy]

@kbrock I find this site more useful for detailing changes in Ruby:

• 3.2: https://rubyreferences.github.io/rubychanges/3.2.html
• 3.3: https://rubyreferences.github.io/rubychanges/3.3.html

[kbrock]

update:

• no longer warn for ruby >= 3.2

unsure: Do we want to force ruby => 3.1?

[kbrock]

update:

• testing with 3.1, 3.3
• allow 3.1-3.4
• warn >= 3.4

[miq-bot]

Checked commit kbrock@1e99a38 with ruby 3.1.5, rubocop 1.56.3, haml-lint 0.51.0, and yamllint
1 file checked, 0 offenses detected
Everything looks fine. ⭐

[jrafanie]

• Hash#shift (empty returns nil instead of default)

Is there anything we need to do here? I assume it's difficult to find.

[kbrock]

@jrafanie no. I searched through the code and it looks like we are all set, but left it as "outstanding" to let people know that a few of these may still be lurking.

ok. Ignoring specs:

• Array.new(size, default_value): 1 instance. all set.
• Array.new(size) {}: 12 instances. all set
• • Array.new(size) do: 4 instances.

[jrafanie]

Does this resolve the issue around rubocop and warning for testing of untested rubies?

[kbrock]

Yes. adding the padding on the top ( < 3.5 instead of < 3.4) with the warning in there will help us in the future too.

[jrafanie]

LGTM, just minor question. As long as we have smoke tested images/appliances with ruby 3.3, I'm good with shipping this!

❤️

[jrafanie]

@bdunne are you good with smoke tests of appliances/pods with ruby 3.3? Are we good to go?

@kbrock add radjabov if this is for backport.

[jrafanie]

LGTM, @bdunne @Fryguy merge when ready.

[jrafanie]

🎉 🕺 🏆 🎉 🕺 🏆 🎉 🕺 🏆

[Fryguy]

Backported to radjabov in commit a4e4a73.

commit a4e4a739cdd1feeda8948253bfdd8564b6508592
Author: Jason Frey <[email protected]>
Date:   Wed Nov 13 17:30:47 2024 -0500

    Merge pull request #23142 from kbrock/ruby33
    
    Upgrading ruby to 3.3
    
    (cherry picked from commit 3fb39c3b87d88a144d8bf03cf49b7a42dbf5bd8d)