Ruby: support conan v2 and expose more configuration options for native extension gems

[jmarrec]

Specify library name and version: ruby/3.1.0

Ruby: support conan v2 and expose more configuration options for native extension gems

Reboots:

• #12455 - ruby/3.1.0: expose more configuration options for native extension gems #12456
• ruby: conan v2 support #12208

Both PRs were opened more than a year ago and got stale and closed.

Changelog (old commit messages):

• conan v2 support (work done by myself + a merge of @SpaceIm 's branch from PR ruby: conan v2 support #12208 to reconcile both)

• Extend testing to require one of the native extensions

post_package(): WARN: [MISSING SYSTEM LIBS (KB-H043)] Library './lib/ruby/3.1.0/x86_64-linux/pty.so'
 links to system library 'util' but it is not in cpp_info.system_libs.

• Use --with-opt-dir instead of --with-xx-dir that ruby isn't respecting.

conanio/gccXX (eg 10) removed the libxxx-dev (eg libgmp-dev) from the image. This made me realize that the conan deps weren't being picked up by the build. The openssl was, because --with-openssl-dir is explicitly used in ruby config.

So here, we rely on --with-opt-dir.

cf: https://bugs.ruby-lang.org/issues/19014#change-99241 (--with-gmp-dir was added on September 14, 2022, wrote this in Sep 22, 2022)

• Pass both --with-opt-dir and --with-xxx-dir

https://gist.github.com/mrkn/6647630

---

• I've read the contributing guidelines.
• I've used a recent Conan client version close to the currently deployed.
  • Tested 1.60.1 and 2.0.7 locally
• I've tried at least one configuration locally with the conan-center hook activated.

[stale]

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[valgur]

Shouldn't these be added to self.cpp_info.defines in package_info() instead?

[jmarrec]

I honestly have no idea... you tell me! What I'm trying to do is to pass it to the CMakeLists.txt so they are defined in the executable: https://github.com/jmarrec/conan-center-index/blob/e5c6c958b0b90067ec7d93a468405095f4eff8be/recipes/ruby/all/test_package/CMakeLists.txt#L14-L20

And then I can run different C++ code via a macro: https://github.com/jmarrec/conan-center-index/blob/e5c6c958b0b90067ec7d93a468405095f4eff8be/recipes/ruby/all/test_package/test_package.cpp#L17-L27

[samuel-emrys]

@valgur is right, these would be better placed in the package_info() of the upstream recipe if this is something that is expected for consumer use - consumers shouldn't have to define the variables themselves if they're provided by upstream.

Having said that, if upstream doesn't provide these and you want to use dependency options to do this kind of thing, you shouldn't be trying to parse these in the build() method anyway. Populating cmake with defines needs to happen in the generate() method. To illustrate (for your awareness), passing defines to cmake should be done as follows:

def generate(self):
    ruby_opts = self.dependencies[self.tested_reference_str].options
    tc = CMakeToolchain(self)
    tc.preprocessor_definitions["RUBY_STATIC_RUBY"] = not ruby_opts.shared
    tc.preprocessor_definitions["RUBY_STATIC_LINKED_EXT"] = not ruby_opts.shared and ruby_opts.with_static_linked_ext

def build(self):
    cmake = CMake(self)
    cmake.configure()
    cmake.build()

See the docs for CMakeToolchain for more info.

Note: I've assumed that you want to pass these as defines to the consumer build - as far as I can see, these might actually be better as cmake variables rather than defines, since I can't see a reason why a consumer library would ever want to do the following - I would imagine in most cases the code base itself wouldn't care whether the symbols were resolved statically or dynamically.

#ifdef RUBY_STATIC_RUBY
// do some stuff
#endif

If these don't need to be defines, then the above can change to the following to pass these options as cmake variables instead

def generate(self):
    ruby_opts = self.dependencies[self.tested_reference_str].options
    tc = CMakeToolchain(self)
    tc.variables["RUBY_STATIC_RUBY"] = not ruby_opts.shared
    tc.variables["RUBY_STATIC_LINKED_EXT"] = not ruby_opts.shared and ruby_opts.with_static_linked_ext

[conan-center-bot]

Conan v1 pipeline ✔️

All green in build 26 (7ddb85e1c871647d4ba8d10bdfbb59f2fc6cbde3):

• ruby/3.1.0:
  All packages built successfully! (All logs)

---

Conan v2 pipeline ❌

Note: Conan v2 builds are now mandatory. Please read our discussion about it.

The v2 pipeline failed. Please, review the errors and note this is required for pull requests to be merged. In case this recipe is still not ported to Conan 2.x, please, ping @conan-io/barbarians on the PR and we will help you.

See details:

Failure in build 26 (7ddb85e1c871647d4ba8d10bdfbb59f2fc6cbde3):

• ruby/3.1.0:
  CI failed to create some packages (All logs)

  Logs for packageID 12a7fecab21700c447590b654aefc8eb4a721158:

  [settings]
  arch=armv8
  build_type=Release
  compiler=apple-clang
  compiler.cppstd=17
  compiler.libcxx=libc++
  compiler.version=13
  os=Macos
  [options]
  */*:shared=True
  

  [...]
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/scheduler.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/signal.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/sprintf.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/st.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/strftime.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/string.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/struct.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/symbol.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/thread.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/time.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/transcode.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/transient_heap.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/util.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/variable.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/vm.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/vm_backtrace.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/vm_dump.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/vm_sync.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/vm_trace.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/yjit.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/missing/explicit_bzero.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/missing/setproctitle.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/addr2line.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/dmyenc.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/dln.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/localeinit.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/array.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/mjit.c
  config.status: creating ruby-runner.h
  assembling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/coroutine/arm64/Context.S
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/enc/ascii.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/enc/us_ascii.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/enc/unicode.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/enc/utf_8.c
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/enc/trans/newline.c
  /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/revision.h unchanged
  compiling /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/src/version.c
  linking miniruby
  dyld[77971]: Library not loaded: @rpath/libgmp.10.dylib
    Referenced from: <CF7DBBF0-FBB4-38DB-9A80-39B5E7551078> /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/build-release/miniruby
    Reason: tried: '/usr/local/lib/libgmp.10.dylib' (no such file), '/usr/lib/libgmp.10.dylib' (no such file, not in dyld cache)
  make: *** [exe/ruby] Abort trap: 6
  make: *** Deleting file `exe/ruby'
  
  ruby/3.1.0: ERROR: 
  Package '12a7fecab21700c447590b654aefc8eb4a721158' build failed
  ruby/3.1.0: WARN: Build folder /Users/jenkins/w/prod-v2/bsr/84037/cbdec/p/b/rubyd4c006a583fe1/b/build-release
  ERROR: ruby/3.1.0: Error in build() method, line 215
  	autotools.make()
  	ConanException: Error 2 while executing
  

---

^{Note: To save resources, CI tries to finish as soon as an error is found. For this reason you might find that not all the references have been launched or not all the configurations for a given reference. Also, take into account that we cannot guarantee the order of execution as it depends on CI workload and workers availability.}

[jmarrec]

Re the macOS V2 error that fails when shared: so we build miniruby, then we need to execute miniruby. Which is going to search for the dylibs.

The conanrunenv does have the LD_LIBRARY_PATH and DYLD_LIBRARY_PATH, but we don't have it activated. Not sure how to ensure these are defined when I build.

[github-actions]

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[github-actions]

This pull request has been automatically closed because it has not had recent activity. Thank you for your contributions.