Merge pull request #95 from rake-compiler/flavorjones-move-to-ghcr.io

change location of docker images to ghcr.io

Author: flavorjones

.github/workflows/ci.yml

@@ -59,6 +59,7 @@ jobs:
         run: |
           docker buildx create --driver docker-container --use
           bundle exec rake build:${PLATFORM} RCD_DOCKER_BUILD="docker buildx build --cache-from=type=local,src=tmp/build-cache --cache-to=type=local,dest=tmp/build-cache-new --load"
+          docker images
 
       - name: Move build cache and remove outdated layers
         run: |

.github/workflows/publish-images.yml

@@ -22,9 +22,7 @@ jobs:
           - arm64-darwin
           - arm-linux
           - aarch64-linux
-        include:
-          - platform: jruby
-            tag: jruby
+          - jruby
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -39,11 +37,18 @@ jobs:
         with:
           ruby-version: "3.1"
           bundler-cache: true
-      - id: rcd_image_version
-        run: bundle exec ruby -e 'require "rake_compiler_dock"; puts "rcd_image_version=#{RakeCompilerDock::IMAGE_VERSION}"' >> $GITHUB_OUTPUT
+      - id: rcd_config
+        run: |
+          bundle exec ruby -e ' \
+            require "rake_compiler_dock"; \
+            print "image_name="; \
+            puts RakeCompilerDock::Starter.container_image_name(:platform => %q(${{matrix.platform}})); \
+            print "snapshot_name="; \
+            puts RakeCompilerDock::Starter.container_image_name(:platform => %q(${{matrix.platform}}), :version => %q(snapshot)); \
+          ' | tee -a $GITHUB_OUTPUT
+
       - name: Build docker image
         env:
-          DOCKERHUB_USER: rake-compiler
           RCD_DOCKER_BUILD: docker buildx build --cache-from=type=local,src=tmp/build-cache --cache-to=type=local,dest=tmp/build-cache-new --load
         run: |
           docker buildx create --driver docker-container --use
@@ -56,10 +61,7 @@ jobs:
           registry: ghcr.io
           username: ${{github.actor}}
           password: ${{secrets.GITHUB_TOKEN}}
-      - env:
-          OLD_TAG: rake-compiler/rake-compiler-dock-${{matrix.tag || format('mri-{0}', matrix.platform)}}:${{steps.rcd_image_version.outputs.rcd_image_version}}
-          NEW_TAG: ghcr.io/rake-compiler/rake-compiler-dock-snapshot:${{matrix.platform}}
-        run: |
+      - run: |
           docker images
-          docker tag ${OLD_TAG} ${NEW_TAG}
-          docker push ${NEW_TAG}
+          docker tag ${{steps.rcd_config.outputs.image_name}} ${{steps.rcd_config.outputs.snapshot_name}}
+          docker push ${{steps.rcd_config.outputs.snapshot_name}}

History.md

@@ -9,6 +9,17 @@
 * Ensure autoconf is installed in the base iamges.
 * Start publishing snapshots to ghcr.io
 * Bump JRuby to 9.4.0.0
+* Move docker images to ghcr.io/rake-compiler:
+  * `ghcr.io/rake-compiler/rake-compiler-dock-image:1.3.0-jruby`
+  * `ghcr.io/rake-compiler/rake-compiler-dock-image:1.3.0-mri-aarch64-linux`
+  * `ghcr.io/rake-compiler/rake-compiler-dock-image:1.3.0-mri-arm-linux`
+  * `ghcr.io/rake-compiler/rake-compiler-dock-image:1.3.0-mri-arm64-darwin`
+  * `ghcr.io/rake-compiler/rake-compiler-dock-image:1.3.0-mri-x64-mingw-ucrt`
+  * `ghcr.io/rake-compiler/rake-compiler-dock-image:1.3.0-mri-x64-mingw32`
+  * `ghcr.io/rake-compiler/rake-compiler-dock-image:1.3.0-mri-x86-linux`
+  * `ghcr.io/rake-compiler/rake-compiler-dock-image:1.3.0-mri-x86-mingw32`
+  * `ghcr.io/rake-compiler/rake-compiler-dock-image:1.3.0-mri-x86_64-darwin`
+  * `ghcr.io/rake-compiler/rake-compiler-dock-image:1.3.0-mri-x86_64-linux`
 
 
 1.2.2 / 2022-06-27

README.md

@@ -187,7 +187,7 @@ jobs:
     name: "native-gem"
     runs-on: ubuntu-latest
     container:
-      image: "larskanis/rake-compiler-dock-mri-x86_64-linux:1.2.1"
+      image: "ghcr.io/rake-compiler/rake-compiler-dock-image:1.2.2-mri-x86_64-linux"
     steps:
       - uses: actions/checkout@v2
       - run: bundle install && bundle exec rake gem:x86_64-linux:rcd
@@ -221,11 +221,9 @@ For an example of rake tasks that support this style of invocation, visit https:
 
 ### Living on the edge: using weekly snapshots
 
-OCI images snapshotted from `master` are published weekly to Github Container Registry:
+OCI images snapshotted from `master` are published weekly to Github Container Registry with the string "snapshot" in place of the version number in the tag name, e.g.:
 
-> https://github.com/rake-compiler/rake-compiler-dock/pkgs/container/rake-compiler-dock-snapshot
-
-The images are named `ghcr.io/rake-compiler/rake-compiler-dock-snapshot` and are tagged with the platform name (e.g., `ghcr.io/rake-compiler/rake-compiler-dock-snapshot:x86_64-linux`.
+- `ghcr.io/rake-compiler/rake-compiler-dock-image:snapshot-mri-x86_64-linux`
 
 These images are intended for integration testing. They may not work properly and should not be considered production ready.
 
@@ -242,7 +240,7 @@ The following variables are recognized by rake-compiler-dock:
     Must be a space separated list out of `x86-mingw32`, `x64-mingw-ucrt`, `x64-mingw32`, `x86-linux`, `x86_64-linux`, `arm-linux`, `aarch64-linux`, `x86_64-darwin` and `arm64-darwin`.
     It is ignored when `rubyvm` is set to `:jruby`.
 * `RCD_IMAGE` - The docker image that is downloaded and started.
-    Defaults to "larskanis/rake-compiler-dock:IMAGE_VERSION" with an image version that is determined by the gem version.
+    Defaults to "ghcr.io/rake-compiler/rake-compiler-dock-image:IMAGE_VERSION-PLATFORM" with an image version that is determined by the gem version.
 
 The following variables are passed through to the docker container without modification:
 

Rakefile

@@ -6,7 +6,6 @@ require_relative "build/parallel_docker_build"
 
 RakeCompilerDock::GemHelper.install_tasks
 
-DOCKERHUB_USER = ENV['DOCKERHUB_USER'] || "larskanis"
 docker_build_cmd = Shellwords.split(ENV['RCD_DOCKER_BUILD'] || "docker build")
 
 platforms = [
@@ -29,7 +28,8 @@ namespace :build do
     desc "Build image for platform #{platform}"
     task platform => sdf
     task sdf do
-      sh(*docker_build_cmd, "-t", "#{DOCKERHUB_USER}/rake-compiler-dock-mri-#{platform}:#{RakeCompilerDock::IMAGE_VERSION}", "-f", "Dockerfile.mri.#{platform}", ".")
+      image_name = RakeCompilerDock::Starter.container_image_name(platform: platform)
+      sh(*docker_build_cmd, "-t", image_name, "-f", "Dockerfile.mri.#{platform}", ".")
     end
 
     df = ERB.new(File.read("Dockerfile.mri.erb"), trim_mode: ">").result(binding)
@@ -40,7 +40,8 @@ namespace :build do
   desc "Build image for JRuby"
   task :jruby => "Dockerfile.jruby"
   task "Dockerfile.jruby" do
-    sh(*docker_build_cmd, "-t", "#{DOCKERHUB_USER}/rake-compiler-dock-jruby:#{RakeCompilerDock::IMAGE_VERSION}", "-f", "Dockerfile.jruby", ".")
+    image_name = RakeCompilerDock::Starter.container_image_name(rubyvm: "jruby")
+    sh(*docker_build_cmd, "-t", image_name, "-f", "Dockerfile.jruby", ".")
   end
 
   RakeCompilerDock::ParallelDockerBuild.new(platforms.map{|pl, _| "Dockerfile.mri.#{pl}" } + ["Dockerfile.jruby"], workdir: "tmp/docker", docker_build_cmd: docker_build_cmd)
@@ -57,14 +58,14 @@ task :build => "build:all"
 namespace :prepare do
   desc "Build cross compiler for x64-mingw-ucrt aka RubyInstaller-3.1+"
   task "mingw64-ucrt" do
-    sh(*docker_build_cmd, "-t", "#{DOCKERHUB_USER}/mingw64-ucrt:20.04", ".",
+    sh(*docker_build_cmd, "-t", "larskanis/mingw64-ucrt:20.04", ".",
        chdir: "mingw64-ucrt")
   end
 end
 
 desc "Run tests"
 task :test do
-  sh "ruby -w -W2 -I. -Ilib -e \"#{Dir["test/test_*.rb"].map{|f| "require '#{f}';"}.join}\" -- -v"
+  sh %Q{ruby -w -W2 -I. -Ilib -e "#{Dir["test/test_*.rb"].map{|f| "require '#{f}';"}.join}" -- -v #{ENV['TESTOPTS']}}
 end
 
 desc "Update predefined_user_group.rb"
@@ -92,12 +93,12 @@ end
 namespace :release do
   desc "push all docker images"
   task :images do
-    jimg = "#{DOCKERHUB_USER}/rake-compiler-dock-jruby:#{RakeCompilerDock::IMAGE_VERSION}"
-    sh "docker", "push", jimg
+    image_name = RakeCompilerDock::Starter.container_image_name(rubyvm: "jruby")
+    sh("docker", "push", image_name)
 
     platforms.each do |platform, _|
-      img = "#{DOCKERHUB_USER}/rake-compiler-dock-mri-#{platform}:#{RakeCompilerDock::IMAGE_VERSION}"
-      sh "docker", "push", img
+      image_name = RakeCompilerDock::Starter.container_image_name(platform: platform)
+      sh("docker", "push", image_name)
     end
   end
 end

lib/rake_compiler_dock/starter.rb

@@ -40,17 +40,9 @@ def exec(*args)
         end
         user = options.fetch(:username){ current_user }
         group = options.fetch(:groupname){ current_group }
-        rubyvm = options.fetch(:rubyvm){ ENV['RCD_RUBYVM'] } || "mri"
-        jrubyvm = rubyvm.to_s == "jruby"
-
-        platforms = options.fetch(:platform){ ENV['RCD_PLATFORM'] } || (jrubyvm ? "jruby" : "x86-mingw32 x64-mingw32")
-        platforms.split(" ").each do |platform|
-          image_name = options.fetch(:image) do
-            platform_postfix = jrubyvm ? "" : "-#{platform}"
-            ENV['RCD_IMAGE'] ||
-                ENV['RAKE_COMPILER_DOCK_IMAGE'] ||
-                "larskanis/rake-compiler-dock-#{rubyvm}#{platform_postfix}:#{IMAGE_VERSION}"
-          end
+
+        platforms(options).split(" ").each do |platform|
+          image_name = container_image_name(options.merge(platform: platform))
 
           check = check_docker(mountdir) if options.fetch(:check_docker){ true }
           docker_opts = options.fetch(:options) do
@@ -166,6 +158,38 @@ def check_docker(pwd)
       def sanitize_windows_path(path)
         path.gsub(/^([a-z]):/i){ "/#{$1.downcase}" }
       end
+
+      def container_image_name(options={})
+        options.fetch(:image) do
+          image_name = ENV['RCD_IMAGE'] || ENV['RAKE_COMPILER_DOCK_IMAGE']
+          return image_name unless image_name.nil?
+
+          "%s/rake-compiler-dock-image:%s-%s%s" % [
+            container_registry,
+            options.fetch(:version) { IMAGE_VERSION },
+            container_rubyvm(options),
+            container_jrubyvm?(options) ? "" : "-#{options.fetch(:platform)}",
+          ]
+        end
+      end
+
+      def container_registry
+        ENV['CONTAINER_REGISTRY'] || "ghcr.io/rake-compiler"
+      end
+
+      def container_rubyvm(options={})
+        return "jruby" if options[:platform] == "jruby"
+        options.fetch(:rubyvm) { ENV['RCD_RUBYVM'] } || "mri"
+      end
+
+      def container_jrubyvm?(options={})
+        container_rubyvm(options).to_s == "jruby"
+      end
+
+      def platforms(options={})
+        options.fetch(:platform) { ENV['RCD_PLATFORM'] } ||
+          (container_jrubyvm?(options) ? "jruby" : "x86-mingw32 x64-mingw32")
+      end
     end
   end
 end

test/test_environment_variables.rb

@@ -9,11 +9,12 @@
 class TestEnvironmentVariables
   module Common
     TEST_PLATFORM = ENV["TEST_PLATFORM"] || "x64-mingw-ucrt"
-    DOCKERHUB_USER = ENV['DOCKERHUB_USER'] || "larskanis"
-
     IS_JRUBY = TEST_PLATFORM.to_s == "jruby"
-    platform = IS_JRUBY ? "jruby" : "mri-#{TEST_PLATFORM}"
-    TEST_IMAGE_NAME = "#{DOCKERHUB_USER}/rake-compiler-dock-#{platform}:#{RakeCompilerDock::IMAGE_VERSION}"
+    TEST_IMAGE_NAME = if IS_JRUBY
+      RakeCompilerDock::Starter.container_image_name(rubyvm: "jruby")
+    else
+      RakeCompilerDock::Starter.container_image_name(platform: TEST_PLATFORM)
+    end
 
     def rcd_env
       self.class.instance_variable_get("@rcd_env") || begin

test/test_starter.rb

@@ -30,4 +30,123 @@ def test_make_valid_group_name
     assert_equal "_", Starter.make_valid_group_name(nil)
   end
 
+  def test_container_image_name
+    # with env vars
+    with_env({"RCD_IMAGE" => "env-var-value"}) do
+      assert_equal("env-var-value", Starter.container_image_name)
+    end
+    with_env({"RAKE_COMPILER_DOCK_IMAGE" => "env-var-value"}) do
+      assert_equal("env-var-value", Starter.container_image_name)
+    end
+
+    # with image option
+    assert_equal("option-value", Starter.container_image_name({:image => "option-value"}))
+
+    # with env var and image option, image option wins
+    with_env({"RCD_IMAGE" => "env-var-value"}) do
+      assert_equal("option-value", Starter.container_image_name({:image => "option-value"}))
+    end
+
+    # mri platform arg
+    assert_equal(
+      "ghcr.io/rake-compiler/rake-compiler-dock-image:#{IMAGE_VERSION}-mri-platform-option-value",
+      Starter.container_image_name({:platform => "platform-option-value"}),
+    )
+
+    # jruby rubyvm arg
+    assert_equal(
+      "ghcr.io/rake-compiler/rake-compiler-dock-image:#{IMAGE_VERSION}-jruby",
+      Starter.container_image_name({:rubyvm => "jruby"}),
+    )
+
+    # jruby platform arg
+    assert_equal(
+      "ghcr.io/rake-compiler/rake-compiler-dock-image:#{IMAGE_VERSION}-jruby",
+      Starter.container_image_name({:platform => "jruby"}),
+    )
+
+    # container registry env var
+    with_env({"CONTAINER_REGISTRY" => "registry-value"}) do
+      assert_equal(
+        "registry-value/rake-compiler-dock-image:#{IMAGE_VERSION}-mri-x86_64-darwin",
+        Starter.container_image_name({:platform => "x86_64-darwin"}),
+      )
+    end
+
+    # snapshots
+    assert_equal(
+      "ghcr.io/rake-compiler/rake-compiler-dock-image:snapshot-mri-x86_64-darwin",
+      Starter.container_image_name({:platform =>"x86_64-darwin", :version => "snapshot"}),
+    )
+  end
+
+  def test_container_registry
+    assert_equal("ghcr.io/rake-compiler", Starter.container_registry)
+
+    with_env({"CONTAINER_REGISTRY" => "env-var-value"}) do
+      assert_equal("env-var-value", Starter.container_registry)
+    end
+  end
+
+  def test_container_rubyvm
+    # no args
+    assert_equal("mri", Starter.container_rubyvm)
+
+    # with env var
+    with_env({"RCD_RUBYVM" => "env-var-value"}) do
+      assert_equal("env-var-value", Starter.container_rubyvm)
+    end
+
+    # with rubyvm option
+    assert_equal("option-value", Starter.container_rubyvm({:rubyvm => "option-value"}))
+
+    # with rubyvm option and env var, rubyvm option wins
+    with_env({"RCD_RUBYVM" => "env-var-value"}) do
+      assert_equal("option-value", Starter.container_rubyvm({:rubyvm => "option-value"}))
+    end
+
+    # with jruby platform option
+    assert_equal("jruby", Starter.container_rubyvm({:platform => "jruby"}))
+  end
+
+  def test_container_jrubyvm?
+    assert(Starter.container_jrubyvm?({:rubyvm => "jruby"}))
+    assert(Starter.container_jrubyvm?({:platform => "jruby"}))
+    refute(Starter.container_jrubyvm?({:rubyvm => "mri"}))
+    refute(Starter.container_jrubyvm?({:platform => "x86_64-linux"}))
+  end
+
+  def test_platforms
+    # no args
+    assert_equal("x86-mingw32 x64-mingw32", Starter.platforms)
+
+    # with env var
+    with_env({"RCD_PLATFORM" => "env-var-value"}) do
+      assert_equal("env-var-value", Starter.platforms)
+    end
+
+    # with platform option
+    assert_equal("option-value", Starter.platforms({:platform => "option-value"}))
+
+    # with platform option and env var, platform option wins
+    with_env({"RCD_PLATFORM" => "arm64-darwin"}) do
+      assert_equal("option-value", Starter.platforms({:platform => "option-value"}))
+    end
+
+    # when options rubyvm is set to jruby
+    assert_equal("jruby", Starter.platforms({:rubyvm => "jruby"}))
+  end
+
+  def with_env(env = {})
+    original_env = {}
+    env.each do |k, v|
+      original_env[k] = ENV[k]
+      ENV[k] = v
+    end
+    yield
+  ensure
+    original_env.each do |k, v|
+      ENV[k] = v
+    end
+  end
 end