uricp 0.0.37 → 0.0.38

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0432fbf510461f29163cffb6246b417c2aafefdb0b17d01a9cdb3276a285823
-  data.tar.gz: 2f2d65d8de777e59eb1d0ea8ae5a37e2d41061dc8d8ca8ba62ad6d5d36ad8ff0
+  metadata.gz: 64bb8cc88ca0e71e7cc30ba7b1b3bf7f585d7b4d2100ce6bc9f1d06f05bf6d4b
+  data.tar.gz: 5b771704aac9b087c7fb71743aa45cb381ab2871ca5ee2f682e150965a0f6540
 SHA512:
-  metadata.gz: e414dd96633873aa1264f4e619daab69f477429a0ba1d8e3c29c01964cfcfc0f3b53832181716c7f687066d473854aed5055329dd69bdad510dcbb7af7840c0e
-  data.tar.gz: 7d21dcfe38d979ef17f85c1afa1b35017a8def5e65d6363878da440330c761b4cf3dc694600467d64b7ab014a6f79e194bcac3090c43db6908d98fb1ba33098a
+  metadata.gz: be9f8a1cce7949ebc7c12e7abc8168b08a37ac45538f1fe2dc20efcf6edd3c031b3a8ebdf0a544aa12e45cc512e8d5233f93ebf096bf1d3f08f0c2d43ba04c7e
+  data.tar.gz: 113be9c96ac0bdea702276a1bf509c43603d72d79dfe74801cd41bfcaa582151446656867d609a5648b83499f3bf815d74f7794fa2d4ab2b0eec29413b776ac9

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    uricp (0.0.37)
+    uricp (0.0.38)
       childprocess (~> 1.0)
       filesize (= 0.0.2)
       methadone (~> 2.0.2)

data/almalinux8/Dockerfile

@@ -1,24 +1,24 @@
-FROM almalinux:8.9
+FROM almalinux:8
 MAINTAINER support@brightbox.co.uk
 
 RUN echo "gem: --no-ri --no-rdoc" >> "$HOME/.gemrc"
 RUN dnf -y install dnf-plugins-core
-#RUN dnf config-manager --add-repo https://repo.almalinux.org/almalinux/8/devel/almalinux-devel.repo
-#RUN echo "8-stream" > /etc/dnf/vars/stream
-#RUN dnf -y update
-#RUN dnf config-manager --set-enabled powertools,devel
 RUN dnf config-manager --set-enabled powertools
 RUN dnf -y group install "Development Tools"
-RUN dnf -y install https://www.rdoproject.org/repos/rdo-release.el8.rpm
 RUN dnf -y install \
     git \
     lz4 \
     qemu-img \
     ruby-devel \
+    python3-pip \
     rubygems \
-    rubygem-bundler \
-    python3-swiftclient \
-    ceph-common
+    rubygem-bundler
+# Ceph
+RUN dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm
+RUN dnf -y install http://download.ceph.com/rpm-pacific/el8/noarch/ceph-release-1-1.el8.noarch.rpm
+RUN dnf -y install ceph-common
+# Swiftclient
+RUN pip3 install python-swiftclient
 RUN mkdir -p /etc/ceph
 ARG RBD_USR=libvirt
 ARG RBD_PSW

data/features/rbd_access.feature

@@ -32,7 +32,7 @@ Feature: Manipulate file images in ceph
     """
     And the output should contain:
     """
-    rbd clone --id libvirt 'servers/freedos.qcow2@base' 'servers/srv-testy' || { [ $? -eq 22 ] && rbd create --id libvirt -s 0 'servers/srv-testy'; };
+    rbd clone --id libvirt --rbd-default-clone-format 2 'servers/freedos.qcow2@base' 'servers/srv-testy' || { [ $? -eq 22 ] && rbd create --id libvirt -s 0 'servers/srv-testy'; };
     """
 
   Scenario: HTTP URI from file cache via unpopulated rbd cache
@@ -53,7 +53,7 @@ Feature: Manipulate file images in ceph
     """
     And the output should contain:
     """
-    rbd clone --id libvirt 'servers/freedos.qcow2@base' 'servers/srv-testy'
+    rbd clone --id libvirt --rbd-default-clone-format 2 'servers/freedos.qcow2@base' 'servers/srv-testy'
     """
 
     Scenario: HTTP URI to rbd via partial rbd caches
@@ -77,7 +77,7 @@ Feature: Manipulate file images in ceph
     """
     And the output should contain:
     """
-    rbd clone --id libvirt 'servers/freedos.qcow2@base' 'servers/srv-testy'
+    rbd clone --id libvirt --rbd-default-clone-format 2 'servers/freedos.qcow2@base' 'servers/srv-testy'
     """
 
   Scenario: file URI to rbd via cache
@@ -105,23 +105,23 @@ Feature: Manipulate file images in ceph
     When I successfully run `uricp --dry-run rbd:///servers/img-testy rbd:///servers/srv-testy`
     And the output should contain:
     """
-    rbd snap create --id libvirt 'servers/img-testy@uricp_snap'
+    rbd snap create --id libvirt 'servers/img-testy@srv-testy-uricp_snap'
     """
     And the output should contain:
     """
-    rbd snap protect --id libvirt 'servers/img-testy@uricp_snap'
+    rbd snap protect --id libvirt 'servers/img-testy@srv-testy-uricp_snap'
     """
     And the output should not contain:
     """
-    rbd snap unprotect --id libvirt 'servers/img-testy@uricp_snap'
+    rbd snap unprotect --id libvirt 'servers/img-testy@srv-testy-uricp_snap'
     """
     And the output should not contain:
     """
-    rbd snap rm --id libvirt 'servers/img-testy@uricp_snap'
+    rbd snap rm --id libvirt 'servers/img-testy@srv-testy-uricp_snap'
     """
     And the output should contain:
     """
-    rbd clone --id libvirt 'servers/img-testy@uricp_snap' 'servers/srv-testy'
+    rbd clone --id libvirt --rbd-default-clone-format 2 'servers/img-testy@srv-testy-uricp_snap' 'servers/srv-testy'
     """
 
   Scenario: rbd to rbd - unpopulated cache
@@ -129,27 +129,27 @@ Feature: Manipulate file images in ceph
     When I successfully run `uricp --dry-run --cache=/tmp/uricp rbd:///servers/srv-testy rbd:///servers/img-testy`
     And the output should contain:
     """
-    rbd snap create --id libvirt 'servers/srv-testy@uricp_snap'
+    rbd snap create --id libvirt 'servers/srv-testy@img-testy-uricp_snap'
     """
     And the output should contain:
     """
-    rbd snap protect --id libvirt 'servers/srv-testy@uricp_snap'
+    rbd snap protect --id libvirt 'servers/srv-testy@img-testy-uricp_snap'
     """
     And the output should not contain:
     """
-    rbd snap unprotect --id libvirt 'servers/srv-testy@uricp_snap'
+    rbd snap unprotect --id libvirt 'servers/srv-testy@img-testy-uricp_snap'
     """
     And the output should not contain:
     """
-    rbd snap rm --id libvirt 'servers/srv-testy@uricp_snap'
+    rbd snap rm --id libvirt 'servers/srv-testy@img-testy-uricp_snap'
     """
     And the output should not contain:
     """
-    rbd export --no-progress --id libvirt 'servers/srv-testy@uricp_snap' -
+    rbd export --no-progress --id libvirt 'servers/srv-testy@img-testy-uricp_snap' -
     """
     And the output should contain:
     """
-    rbd clone --id libvirt 'servers/srv-testy@uricp_snap' 'servers/img-testy'
+    rbd clone --id libvirt --rbd-default-clone-format 2 'servers/srv-testy@img-testy-uricp_snap' 'servers/img-testy'
     """
     And the output should not contain:
     """
@@ -182,7 +182,47 @@ Feature: Manipulate file images in ceph
     """
     And the output should contain:
     """
-    rbd clone --id libvirt 'servers/img-testy@base' 'servers/srv-testy'
+    rbd clone --id libvirt --rbd-default-clone-format 2 'servers/img-testy@base' 'servers/srv-testy'
+    """
+
+  Scenario: rbd disk to rbd disk - cache ignored
+    Given a correctly initialised cache at "/tmp/uricp"
+    When I successfully run `uricp --dry-run --cache=/tmp/uricp rbd:///servers/vol-testy rbd:///servers/vol-copyy`
+    And the output should contain:
+    """
+    rbd clone --id libvirt --rbd-default-clone-format 2 'servers/vol-testy@vol-copyy-uricp_snap' 'servers/vol-copyy'
+    """
+    And the output should not contain:
+    """
+    @base
+    """
+
+  Scenario: rbd disk to a file that is not an image - cache ignored
+    Given a correctly initialised cache at "/tmp/uricp"
+    When I successfully run `uricp --dry-run --cache=/tmp/uricp rbd:///servers/vol-testy file:///tmp/uricp/backup.raw`
+    And the output should contain:
+    """
+    rbd export --no-progress --id libvirt 'servers/vol-testy@backup.raw-uricp_snap' -
+    """
+    And the output should contain:
+    """
+    rbd snap rm --id libvirt 'servers/vol-testy@backup.raw-uricp_snap'
+    """
+    And the output should not contain:
+    """
+    rbd clone
+    """
+
+  Scenario: rbd disk with a base snapshot to rbd disk
+    Given a correctly initialised cache at "/tmp/uricp"
+    When I successfully run `uricp --dry-run --dry-cache=rbd --cache=/tmp/uricp rbd:///servers/srv-testy-vol rbd:///servers/vol-copyy`
+    And the output should contain:
+    """
+    rbd clone --id libvirt --rbd-default-clone-format 2 'servers/srv-testy-vol@vol-copyy-uricp_snap' 'servers/vol-copyy'
+    """
+    And the output should not contain:
+    """
+    @base
     """
 
   Scenario: RBD export.
@@ -190,23 +230,23 @@ Feature: Manipulate file images in ceph
     When I successfully run `uricp --dry-run --compress rbd:///servers/srv-testy file:///tmp/img-testy`
     And the output should contain:
     """
-    rbd snap create --id libvirt 'servers/srv-testy@uricp_snap'
+    rbd snap create --id libvirt 'servers/srv-testy@img-testy-uricp_snap'
     """
     And the output should contain:
     """
-    rbd snap protect --id libvirt 'servers/srv-testy@uricp_snap'
+    rbd snap protect --id libvirt 'servers/srv-testy@img-testy-uricp_snap'
     """
     And the output should contain:
     """
-    rbd snap unprotect --id libvirt 'servers/srv-testy@uricp_snap'
+    rbd snap unprotect --id libvirt 'servers/srv-testy@img-testy-uricp_snap'
     """
     And the output should contain:
     """
-    rbd snap rm --id libvirt 'servers/srv-testy@uricp_snap'
+    rbd snap rm --id libvirt 'servers/srv-testy@img-testy-uricp_snap'
     """
     And the output should contain:
     """
-    rbd export --no-progress --id libvirt 'servers/srv-testy@uricp_snap' -
+    rbd export --no-progress --id libvirt 'servers/srv-testy@img-testy-uricp_snap' -
     """
 
   Scenario: RBD export with cacheing - populated cache
@@ -232,27 +272,27 @@ Feature: Manipulate file images in ceph
     When I successfully run `uricp --dry-run --compress --cache=/tmp/uricp rbd:///servers/srv-testy file:///tmp/img-testy`
     And the output should contain:
     """
-    rbd snap create --id libvirt 'servers/srv-testy@uricp_snap'
+    rbd snap create --id libvirt 'servers/srv-testy@img-testy-uricp_snap'
     """
     And the output should contain:
     """
-    rbd snap protect --id libvirt 'servers/srv-testy@uricp_snap'
+    rbd snap protect --id libvirt 'servers/srv-testy@img-testy-uricp_snap'
     """
     And the output should not contain:
     """
-    rbd snap unprotect --id libvirt 'servers/srv-testy@uricp_snap'
+    rbd snap unprotect --id libvirt 'servers/srv-testy@img-testy-uricp_snap'
     """
     And the output should not contain:
     """
-    rbd snap rm --id libvirt 'servers/srv-testy@uricp_snap'
+    rbd snap rm --id libvirt 'servers/srv-testy@img-testy-uricp_snap'
     """
     And the output should not contain:
     """
-    rbd export --no-progress --id libvirt 'servers/srv-testy@uricp_snap' -
+    rbd export --no-progress --id libvirt 'servers/srv-testy@img-testy-uricp_snap' -
     """
     And the output should contain:
     """
-    rbd clone --id libvirt 'servers/srv-testy@uricp_snap' 'servers/img-testy'
+    rbd clone --id libvirt --rbd-default-clone-format 2 'servers/srv-testy@img-testy-uricp_snap' 'servers/img-testy'
     """
     And the output should contain:
     """
@@ -272,27 +312,27 @@ Feature: Manipulate file images in ceph
     When I successfully run `uricp  --dry-run --auth-token 'd75945e3b9159f1f14e91b2022bc53ea10481ed15e4a' --target-format 'raw' --compress --segment-size '1073741824B' --cache '/var/cache/domtrix' rbd:/servers/vol-yd63x https://orbit.gb1s.brightbox.com/v1/acc-8tgbq/images/img-cfwe0`
     And the output should contain:
     """
-    rbd snap create --id libvirt 'servers/vol-yd63x@uricp_snap'
+    rbd snap create --id libvirt 'servers/vol-yd63x@img-cfwe0-uricp_snap'
     """
     And the output should contain:
     """
-    rbd snap protect --id libvirt 'servers/vol-yd63x@uricp_snap'
+    rbd snap protect --id libvirt 'servers/vol-yd63x@img-cfwe0-uricp_snap'
     """
     And the output should not contain:
     """
-    rbd snap unprotect --id libvirt 'servers/vol-yd63x@uricp_snap'
+    rbd snap unprotect --id libvirt 'servers/vol-yd63x@img-cfwe0-uricp_snap'
     """
     And the output should not contain:
     """
-    rbd snap rm --id libvirt 'servers/vol-yd63x@uricp_snap'
+    rbd snap rm --id libvirt 'servers/vol-yd63x@img-cfwe0-uricp_snap'
     """
     And the output should not contain:
     """
-    rbd export --no-progress --id libvirt 'servers/vol-yd63x@uricp_snap' -
+    rbd export --no-progress --id libvirt 'servers/vol-yd63x@img-cfwe0-uricp_snap' -
     """
     And the output should contain:
     """
-    rbd clone --id libvirt 'servers/vol-yd63x@uricp_snap' 'servers/img-cfwe0'
+    rbd clone --id libvirt --rbd-default-clone-format 2 'servers/vol-yd63x@img-cfwe0-uricp_snap' 'servers/img-cfwe0'
     """
     And the output should contain:
     """

data/features/support/env.rb

@@ -1,6 +1,20 @@
 require 'aruba/cucumber'
 require 'methadone/cucumber'
 require 'fileutils'
+require 'tmpdir'
+
+# The features refer to their scratch area as /tmp/uricp. Put it under the
+# standard temp directory instead ($TMPDIR, defaulting to /tmp).
+FEATURE_DIR = '/tmp/uricp'
+TEST_DIR = File.join(Dir.tmpdir, 'uricp')
+
+# Rewrite the path in every step argument, including docstrings.
+module UseTestDir
+  def invoke(args)
+    super(args.map { |a| a.is_a?(String) ? String.new(a).gsub(FEATURE_DIR, TEST_DIR) : a })
+  end
+end
+Cucumber::RbSupport::RbStepDefinition.prepend(UseTestDir)
 
 ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
 LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
@@ -15,6 +29,6 @@ end
 After do
   ENV['RUBYLIB'] = @original_rubylib
   
-  FileUtils.rm_rf(Dir.glob('/tmp/uricp/*'))
+  FileUtils.rm_rf(Dir.glob(File.join(TEST_DIR, '*')))
 
 end

data/lib/uricp/strategy/common.rb

@@ -7,6 +7,7 @@ module Uricp::Strategy
     include Methadone::SH
 
     VOL_REGEX = /^(srv|vol)-.....$/
+    IMAGE_REGEX = /\Aimg-/.freeze
 
     def initialize(options)
       @options = options
@@ -115,8 +116,11 @@ module Uricp::Strategy
       'base'
     end
 
+    # Prefixed with the target name so snapshot listings show which
+    # copy each snapshot was taken for.
     def rbd_snapshot_name
-      @rbd_snapshot_name ||= dry_run? ? DRY_SNAP : SecureRandom.uuid
+      @rbd_snapshot_name ||=
+        "#{File.basename(to.path)}-#{dry_run? ? DRY_SNAP : SecureRandom.uuid}"
     end
 
     def get_temp_filename(base_dir)
@@ -176,6 +180,12 @@ module Uricp::Strategy
       uri.scheme == 'rbd' && uri.path.include?('@')
     end
 
+    # Only images are cached in RBD. Anything else, such as a server or volume
+    # disk, may change after it is copied, so it is never used as a cache.
+    def image_cache_name?(uri)
+      File.basename(uri.path).match?(IMAGE_REGEX)
+    end
+
     def rbd_cache_upload_available?
       rbd_cache_name && !rbd_cache_image_exists?(rbd_cache_name)
     end

data/lib/uricp/strategy/rbd_cache_clone.rb

@@ -14,6 +14,9 @@ module Uricp::Strategy
       end
 
       with_active_cache do
+        # Only cache copies to an image; anything else is a plain copy
+        return proposal(nil) unless image_cache_name?(to)
+
         options['cache_name'] = File.basename(options['to_uri'].path)
         cache_target = rbd_cache_image_spec(from)
         if rbd_cache_image_exists?(cache_target) || in_rbd_cache(cache_target)
@@ -30,7 +33,7 @@ module Uricp::Strategy
 
     def proposal(cache_check)
       @proposed_options = options.dup
-      @proposed_options['rbd_cache_target'] = rbd_uri(cache_check)
+      @proposed_options['rbd_cache_target'] = rbd_uri(cache_check) if cache_check
       @proposed_options.delete('cache')
       @proposed_options.delete('cache_name')
       @proposed_options.delete('dry-cache')

data/lib/uricp/strategy/rbd_cached_get.rb

@@ -8,7 +8,7 @@ module Uricp::Strategy
     include Uricp::Strategy::CacheCommon
 
     def appropriate?
-      if from.scheme != 'rbd' || rbd_snapshot_spec?(from)
+      if from.scheme != 'rbd' || rbd_snapshot_spec?(from) || !image_cache_name?(from)
         debug "#{self.class.name}: not appropriate"
         return false
       end

data/lib/uricp/strategy/rbd_cached_put.rb

@@ -16,7 +16,7 @@ module Uricp::Strategy
     end
 
     def command
-      "rbd clone --id #{rbd_id} '#{rbd_image_spec(from)}' "\
+      "rbd clone --id #{rbd_id} --rbd-default-clone-format 2 '#{rbd_image_spec(from)}' "\
         "'#{rbd_image_spec(to)}' || { [ $? -eq 22 ] && "\
         "rbd create --id #{rbd_id} -s 0 '#{rbd_image_spec(to)}'; };"
     end

data/lib/uricp/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Uricp
-  VERSION = '0.0.37'
+  VERSION = '0.0.38'
   DEFAULT_SEGMENT_SIZE = '5 GiB'
 end

data/uricp.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = ''
   spec.license       = 'gplv3'
 
-  spec.files         = `git ls-files -z`.split("\x0")
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.start_with?('docs/') || (f.end_with?('.md') && f != 'README.md') }
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uricp
 version: !ruby/object:Gem::Version
-  version: 0.0.37
+  version: 0.0.38
 platform: ruby
 authors:
 - Neil Wilson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-22 00:00:00.000000000 Z
+date: 2026-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -161,6 +161,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".tool-versions"
 - Gemfile
 - Gemfile.lock
 - Jenkinsfile
@@ -227,7 +228,7 @@ homepage: ''
 licenses:
 - gplv3
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -242,8 +243,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Copy one URL to another with optional cacheing
 test_files: