[WIP] Ruby 3 upgrade

[sethboyles]

Working on Ruby 3 upgrade.

Biggest issue so far was changing keyword args: https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0/

There is the https://github.com/ruby/ruby2_keywords gem, but we figured we would try to adapt to the new, stricter usage first. If it's too risky, we can try the gem instead

What needs to be done before this is good to go:

• Help **fog-azure-rm** upgrade (or pin) **azure-storage** #2197
• Bump fog-core version to ~> 2.1 fog/fog-google#422 is merged and released
• Fix URI.encode deprecation warnings for Ruby 3 compatibility cf-uaa-lib#73 is merged and consumed, preferably in a release rather than pointing at master or a specific branch
• Either have this issue addressed in fog-local, or account for it on our end 0.7 escapes safe characters (change in behavior from 0.6) fog/fog-local#24
  • (update: PR here: Don't escape safe characters in keys fog/fog-local#25 )
  • merged in and bumped in this branch
• Update resources listed here: Updating-Ruby-Package-in-CAPI-Release
  • Update capi-release with a PR
  • Updating the capi-migration-compatibility dockerfile
  • Updating Capi-workspace [non-blocking]
  • Updating capi-runtime-ci dockerfile
  • Updating the capi-ruby-units dockerfile

If the first 3 are done, and ruby 2.7 tests are passing, I think might be able to ahead and merge, and update the package in capi-release after. But it's probably best to have these ready to go at the same time.

We are unsure if the unit tests have adequate coverage of the different fog gems (e.g fog-aliyun, fog-google, etc). We have run into a few issue where we were using old versions of the fog gems that were using the now removed URI.escape. We are wondering if might run into similar errors when running CATS and BARAS against these providers.

[sethboyles]

I think something about the Sinatra upgrade (2.0 -> 2.1) is causing some tests to fail:

 2) Sinatra::VCAP accessing a route that throws a low level exception should return json content type in the header
     Failure/Error: Unable to find /foo to read failed line

     ZeroDivisionError:
       divided by 0
     Shared Example Group: "http header content type" called from ./spec/unit/lib/sinatra/vcap_spec.rb:108
     # /foo:1
     # /bar:2

Our test calls this endpoint:

cloud_controller_ng/spec/unit/lib/sinatra/vcap_spec.rb

Lines 27 to 32 in cf3a1b3

	get '/div_0' do
	1 / 0
	rescue => e
	e.set_backtrace(['/foo:1', '/bar:2'])
	raise e
	end

Which divides by zero, and the expectation is that Sinatra returns a 500. Looking at the Sinatra changelog, I'm not sure why this behavior would have changed...

[sethboyles]

Reason for divide by 0 issues: sinatra/sinatra#1214.

cloud_controller_ng/spec/unit/lib/sinatra/vcap_spec.rb

Lines 19 to 21 in cf3a1b3

	def in_test_mode?
	false
	end

doesn't override helpers like this anymore:

cloud_controller_ng/lib/sinatra/vcap.rb

Lines 10 to 14 in cf3a1b3

	module Helpers
	def in_test_mode?
	ENV['CC_TEST']
	end
	end

[sethboyles]

Due to another fog issue, we ended up pinning fog-google to 1.7.1. I am not sure that version is compatible with Ruby 3, so we may need to help fog/fog-google#422 move forward so we can move to the newest version of fog-google.

[sethboyles]

This has suddenly been made more pressing, as Ruby 3 (3.1?) is required for the new Jammy Jellyfish stemcells: https://bosh.io/docs/jammy-migration/#openssl-3

[tjvman]

Closing, superseded by #2703