Restore cross-compiled code from final gem file

Author: andyundso

.circleci/config.yml

@@ -141,19 +141,29 @@ jobs:
           key: v1-bundle-<< parameters.ruby_version >>-{{ .Branch }}-{{ checksum "tiny_tds.gemspec" }}
 
       - restore_cache:
-          name: restore cross-compiled code
+          name: restore cross-compiled gems
           keys:
-            - compiled-<< pipeline.git.revision >>
+            - gems-<< pipeline.git.revision >>
 
       - run:
-          name: restore cross-compiled code
+          name: restore cross-compiled code from gem
           command: |
             $Env:PATH = "C:\\Ruby<< parameters.ruby_version >>-x64\\bin;$Env:PATH"
+            $rubyArchitecture = (ruby -e 'puts RUBY_PLATFORM').Trim()
+            $gemVersion = (Get-Content VERSION).Trim()
 
-            $rubyArchitecture = (ruby -e 'puts RUBY_PLATFORM').Trim()            
-            $source = "C:\home\circleci\project\tmp\$rubyArchitecture\stage\lib\tiny_tds"
-            $destination = ".\lib\tiny_tds"
+            # Install appropriate gem
+            # The project on Windows is checked out at C:/Users/circleci.PACKER-633B1A5A/project
+            # However, since the cache with the gems was created on Linux, it uses a different path
+            gem install --local --install-dir=./tmp "C:\home\circleci\project\gems\tiny_tds-$gemVersion-$rubyArchitecture.gem"
+
+            # Restore precompiled code
+            $source = (Resolve-Path ".\tmp\gems\tiny_tds-$gemVersion-$rubyArchitecture\lib\tiny_tds").Path
+            $destination = (Resolve-Path ".\lib\tiny_tds").Path
             Get-ChildItem $source -Recurse -Exclude "*.rb" | Copy-Item -Destination {Join-Path $destination $_.FullName.Substring($source.length)}
+            
+            # Restore ports
+            Copy-Item -Path ".\tmp\gems\tiny_tds-$gemVersion-$rubyArchitecture\ports" -Destination "." -Recurse
 
       - restore_cache:
           name: restore mssql installation file
@@ -176,16 +186,6 @@ jobs:
             choco install toxiproxy-server --version=2.5.0 -y
             Start-Process toxiproxy-server
 
-      - restore_cache:
-          name: restore ports cache
-          keys:
-            - ports-libiconv115-openssl111s-freetds1124
-
-      - run:
-          name: copy ports cache into project
-          command: |
-            Move-Item C:\home\circleci\project\ports .
-
       - run:
           name: test gem
           command: |
@@ -223,18 +223,26 @@ jobs:
             - ./vendor/bundle
           key: v1-bundle-{{ .Branch }}-{{ checksum "tiny_tds.gemspec" }}
 
+      - run:
+          name: Write used versions for ports into file
+          command: |
+            bundle exec rake ports:version_file
+
       - restore_cache:
           name: restore ports cache
           keys:
-            - ports-libiconv115-openssl111s-freetds1124
+            - ports-{{ checksum ".ports_versions" }}
+            - ports-
 
       - run:
           name: Build gems
           command: |
             bundle exec rake gem
             bundle exec rake gem:native
 
-            # Move gem files to a separate directory, as CircleCI artifacts don't support wildcards for paths
+      - run:
+          name: Move gems into separate directory before caching
+          command: |
             mkdir gems
             mv pkg/*.gem gems
 
@@ -245,13 +253,13 @@ jobs:
           name: save ports cache
           paths:
             - ./ports
-          key: ports-libiconv115-openssl111s-freetds1124
+          key: ports-{{ checksum ".ports_versions" }}
 
       - save_cache:
-          name: save cross-compiled-code
+          name: save gems into cache
           paths:
-            - ./tmp
-          key: compiled-<< pipeline.git.revision >>
+            - ./gems
+          key: gems-<< pipeline.git.revision >>
 
 workflows:
   test_supported_ruby_versions:

.gitignore

@@ -19,3 +19,4 @@ misc
 /ports/*
 !/ports/patches/
 test/reports
+.ports_versions

tasks/ports.rake

@@ -7,9 +7,11 @@ require_relative 'ports/freetds'
 require_relative '../ext/tiny_tds/extconsts'
 
 namespace :ports do
-  openssl = Ports::Openssl.new(OPENSSL_VERSION)
-  libiconv = Ports::Libiconv.new(ICONV_VERSION)
-  freetds = Ports::Freetds.new(FREETDS_VERSION)
+  libraries_to_compile = {
+    freetds: Ports::Freetds.new(FREETDS_VERSION),
+    libiconv: Ports::Libiconv.new(ICONV_VERSION),
+    openssl: Ports::Openssl.new(OPENSSL_VERSION)
+  }
 
   directory "ports"
   CLEAN.include "ports/*mingw32*"
@@ -18,51 +20,51 @@ namespace :ports do
   task :openssl, [:host] do |task, args|
     args.with_defaults(host: RbConfig::CONFIG['host'])
 
-    openssl.files = [OPENSSL_SOURCE_URI]
-    openssl.host = args.host
-    openssl.cook
-    openssl.activate
+    libraries_to_compile[:openssl].files = [OPENSSL_SOURCE_URI]
+    libraries_to_compile[:openssl].host = args.host
+    libraries_to_compile[:openssl].cook
+    libraries_to_compile[:openssl].activate
   end
 
   task :libiconv, [:host] do |task, args|
     args.with_defaults(host: RbConfig::CONFIG['host'])
 
-    libiconv.files = [ICONV_SOURCE_URI]
-    libiconv.host = args.host
-    libiconv.cook
-    libiconv.activate
+    libraries_to_compile[:libiconv].files = [ICONV_SOURCE_URI]
+    libraries_to_compile[:libiconv].host = args.host
+    libraries_to_compile[:libiconv].cook
+    libraries_to_compile[:libiconv].activate
   end
 
   task :freetds, [:host] do |task, args|
     args.with_defaults(host: RbConfig::CONFIG['host'])
 
-    freetds.files = [FREETDS_SOURCE_URI]
-    freetds.host = args.host
+    libraries_to_compile[:freetds].files = [FREETDS_SOURCE_URI]
+    libraries_to_compile[:freetds].host = args.host
 
-    if openssl
+    if libraries_to_compile[:openssl]
       # freetds doesn't have an option that will provide an rpath
       # so we do it manually
-      ENV['OPENSSL_CFLAGS'] = "-Wl,-rpath -Wl,#{openssl.path}/lib"
+      ENV['OPENSSL_CFLAGS'] = "-Wl,-rpath -Wl,#{libraries_to_compile[:openssl].path}/lib"
       # Add the pkgconfig file with MSYS2'ish path, to prefer our ports build
       # over MSYS2 system OpenSSL.
-      ENV['PKG_CONFIG_PATH'] = "#{openssl.path.gsub(/^(\w):/i){"/"+$1.downcase}}/lib/pkgconfig:#{ENV['PKG_CONFIG_PATH']}"
-      freetds.configure_options << "--with-openssl=#{openssl.path}"
+      ENV['PKG_CONFIG_PATH'] = "#{libraries_to_compile[:openssl].path.gsub(/^(\w):/i) { "/" + $1.downcase }}/lib/pkgconfig:#{ENV['PKG_CONFIG_PATH']}"
+      libraries_to_compile[:freetds].configure_options << "--with-openssl=#{libraries_to_compile[:openssl].path}"
     end
 
-    if libiconv
-      freetds.configure_options << "--with-libiconv-prefix=#{libiconv.path}"
+    if libraries_to_compile[:libiconv]
+      libraries_to_compile[:freetds].configure_options << "--with-libiconv-prefix=#{libraries_to_compile[:libiconv].path}"
     end
 
-    freetds.cook
-    freetds.activate
+    libraries_to_compile[:freetds].cook
+    libraries_to_compile[:freetds].activate
   end
 
-  task :compile, [:host] do |task,args|
+  task :compile, [:host] do |task, args|
     args.with_defaults(host: RbConfig::CONFIG['host'])
 
     puts "Compiling ports for #{args.host}..."
 
-    ['openssl','libiconv','freetds'].each do |lib|
+    libraries_to_compile.keys.each do |lib|
       Rake::Task["ports:#{lib}"].invoke(args.host)
     end
   end
@@ -79,6 +81,19 @@ namespace :ports do
       RakeCompilerDock.sh build.join(' && '), platform: gem_platform
     end
   end
+
+  desc "Notes the actual versions for the compiled ports into a file"
+  task "version_file" do
+    ports_version = {}
+
+    libraries_to_compile.each do |library, library_recipe|
+      ports_version[library] = library_recipe.version
+    end
+
+    File.open(".ports_versions", "w") do |f|
+      f.write ports_version
+    end
+  end
 end
 
 desc 'Build ports and activate libraries for the current architecture.'