|
| 1 | +require "spec_helper" |
| 2 | +require "json" |
| 3 | + |
| 4 | +# We need to load the driver to test its private methods, but it has heavy |
| 5 | +# dependencies (docker-api, lockfile, etc). Instead, we test the methods |
| 6 | +# by creating a minimal subclass that exposes them. |
| 7 | + |
| 8 | +# Stub the Excon module that the driver references at load time |
| 9 | +module Excon |
| 10 | + def self.defaults |
| 11 | + @defaults ||= {} |
| 12 | + end |
| 13 | +end unless defined?(Excon) |
| 14 | + |
| 15 | +# Stub lockfile |
| 16 | +module Lockfile; end unless defined?(Lockfile) |
| 17 | + |
| 18 | +# Now we can define a test harness that includes the relevant private methods |
| 19 | +# from the driver without requiring the full Docker stack. |
| 20 | +class DriverTestHarness |
| 21 | + attr_accessor :config |
| 22 | + |
| 23 | + def initialize(config = {}) |
| 24 | + @config = config |
| 25 | + end |
| 26 | + |
| 27 | + # Expose the PartialHash class |
| 28 | + class PartialHash < Hash |
| 29 | + def ==(other) |
| 30 | + other.is_a?(Hash) && all? { |key, val| other.key?(key) && other[key] == val } |
| 31 | + end |
| 32 | + end |
| 33 | + |
| 34 | + def parse_image_name(image) |
| 35 | + parts = image.split(":") |
| 36 | + |
| 37 | + if parts.size > 2 |
| 38 | + tag = parts.pop |
| 39 | + repo = parts.join(":") |
| 40 | + else |
| 41 | + tag = parts[1] || "latest" |
| 42 | + repo = parts[0] |
| 43 | + end |
| 44 | + |
| 45 | + [repo, tag] |
| 46 | + end |
| 47 | + |
| 48 | + def repo(image) |
| 49 | + parse_image_name(image)[0] |
| 50 | + end |
| 51 | + |
| 52 | + def tag(image) |
| 53 | + parse_image_name(image)[1] |
| 54 | + end |
| 55 | + |
| 56 | + def short_image_path(image) |
| 57 | + "#{repo(image)}:#{tag(image)}" |
| 58 | + end |
| 59 | + |
| 60 | + def registry_image_path(image) |
| 61 | + if config[:docker_registry] |
| 62 | + "#{config[:docker_registry]}/#{short_image_path(image)}" |
| 63 | + else |
| 64 | + short_image_path(image) |
| 65 | + end |
| 66 | + end |
| 67 | + |
| 68 | + def chef_version |
| 69 | + return "latest" if config[:chef_version] == "stable" |
| 70 | + |
| 71 | + config[:chef_version] |
| 72 | + end |
| 73 | + |
| 74 | + def chef_image |
| 75 | + "#{config[:chef_image]}:#{chef_version}" |
| 76 | + end |
| 77 | + |
| 78 | + def chef_container_name |
| 79 | + config[:platform] != "" ? "chef-#{chef_version}-" + config[:platform].sub("/", "-") : "chef-#{chef_version}" |
| 80 | + end |
| 81 | + |
| 82 | + def oci_platform(platform) |
| 83 | + if !platform.nil? && platform.include?("/") |
| 84 | + os, arch = platform.split("/") |
| 85 | + platform = { os: os, architecture: arch }.to_json |
| 86 | + end |
| 87 | + platform |
| 88 | + end |
| 89 | + |
| 90 | + def coerce_tmpfs(v) |
| 91 | + case v |
| 92 | + when Hash, nil |
| 93 | + v |
| 94 | + else |
| 95 | + Array(v).each_with_object({}) do |y, h| |
| 96 | + name, opts = y.split(":", 2) |
| 97 | + h[name.to_s] = opts.to_s |
| 98 | + end |
| 99 | + end |
| 100 | + end |
| 101 | + |
| 102 | + def image_prefix |
| 103 | + config[:image_prefix] |
| 104 | + end |
| 105 | + |
| 106 | + def instance_name |
| 107 | + "test-instance" |
| 108 | + end |
| 109 | + |
| 110 | + def work_image |
| 111 | + [image_prefix, instance_name].compact.join("/").downcase |
| 112 | + end |
| 113 | + |
| 114 | + def coerce_volumes(v, binds) |
| 115 | + case v |
| 116 | + when PartialHash, nil |
| 117 | + v |
| 118 | + when Hash |
| 119 | + PartialHash[v] |
| 120 | + else |
| 121 | + b = [] |
| 122 | + v.delete_if do |x| |
| 123 | + parts = x.split(":") |
| 124 | + b << x if parts.length > 1 |
| 125 | + end |
| 126 | + b = nil if b.empty? |
| 127 | + binds.push(b) unless binds.include?(b) || b.nil? |
| 128 | + return PartialHash.new if v.empty? |
| 129 | + |
| 130 | + v.each_with_object(PartialHash.new) { |volume, h| h[volume] = {} } |
| 131 | + end |
| 132 | + end |
| 133 | +end |
| 134 | + |
| 135 | +RSpec.describe "Kitchen::Driver::Dokken" do |
| 136 | + let(:driver) { DriverTestHarness.new(config) } |
| 137 | + let(:config) { {} } |
| 138 | + |
| 139 | + describe "#parse_image_name" do |
| 140 | + it "parses repo:tag" do |
| 141 | + expect(driver.parse_image_name("ubuntu:22.04")).to eq(["ubuntu", "22.04"]) |
| 142 | + end |
| 143 | + |
| 144 | + it "defaults tag to latest when not specified" do |
| 145 | + expect(driver.parse_image_name("ubuntu")).to eq(["ubuntu", "latest"]) |
| 146 | + end |
| 147 | + |
| 148 | + it "handles registry with port" do |
| 149 | + expect(driver.parse_image_name("registry.io:5000/myimage:v1")).to eq(["registry.io:5000/myimage", "v1"]) |
| 150 | + end |
| 151 | + |
| 152 | + it "handles registry with port and no tag" do |
| 153 | + expect(driver.parse_image_name("registry.io:5000/myimage")).to eq(["registry.io", "5000/myimage"]) |
| 154 | + end |
| 155 | + |
| 156 | + it "handles namespaced images" do |
| 157 | + expect(driver.parse_image_name("chef/chef:latest")).to eq(["chef/chef", "latest"]) |
| 158 | + end |
| 159 | + end |
| 160 | + |
| 161 | + describe "#repo" do |
| 162 | + it "returns the repo portion" do |
| 163 | + expect(driver.repo("ubuntu:22.04")).to eq("ubuntu") |
| 164 | + end |
| 165 | + |
| 166 | + it "returns full path for namespaced image" do |
| 167 | + expect(driver.repo("chef/chef:latest")).to eq("chef/chef") |
| 168 | + end |
| 169 | + end |
| 170 | + |
| 171 | + describe "#tag" do |
| 172 | + it "returns the tag portion" do |
| 173 | + expect(driver.tag("ubuntu:22.04")).to eq("22.04") |
| 174 | + end |
| 175 | + |
| 176 | + it "defaults to latest" do |
| 177 | + expect(driver.tag("ubuntu")).to eq("latest") |
| 178 | + end |
| 179 | + end |
| 180 | + |
| 181 | + describe "#short_image_path" do |
| 182 | + it "normalizes image to repo:tag format" do |
| 183 | + expect(driver.short_image_path("ubuntu")).to eq("ubuntu:latest") |
| 184 | + end |
| 185 | + |
| 186 | + it "preserves explicit tag" do |
| 187 | + expect(driver.short_image_path("ubuntu:22.04")).to eq("ubuntu:22.04") |
| 188 | + end |
| 189 | + end |
| 190 | + |
| 191 | + describe "#registry_image_path" do |
| 192 | + context "without docker_registry" do |
| 193 | + let(:config) { { docker_registry: nil } } |
| 194 | + |
| 195 | + it "returns short_image_path" do |
| 196 | + expect(driver.registry_image_path("ubuntu:22.04")).to eq("ubuntu:22.04") |
| 197 | + end |
| 198 | + end |
| 199 | + |
| 200 | + context "with docker_registry" do |
| 201 | + let(:config) { { docker_registry: "myregistry.io" } } |
| 202 | + |
| 203 | + it "prepends registry" do |
| 204 | + expect(driver.registry_image_path("ubuntu:22.04")).to eq("myregistry.io/ubuntu:22.04") |
| 205 | + end |
| 206 | + end |
| 207 | + end |
| 208 | + |
| 209 | + describe "#chef_version" do |
| 210 | + it "maps 'stable' to 'latest'" do |
| 211 | + driver.config[:chef_version] = "stable" |
| 212 | + expect(driver.chef_version).to eq("latest") |
| 213 | + end |
| 214 | + |
| 215 | + it "returns the configured version" do |
| 216 | + driver.config[:chef_version] = "17.10.0" |
| 217 | + expect(driver.chef_version).to eq("17.10.0") |
| 218 | + end |
| 219 | + |
| 220 | + it "returns 'latest' as-is" do |
| 221 | + driver.config[:chef_version] = "latest" |
| 222 | + expect(driver.chef_version).to eq("latest") |
| 223 | + end |
| 224 | + end |
| 225 | + |
| 226 | + describe "#chef_image" do |
| 227 | + it "combines chef_image config with chef_version" do |
| 228 | + driver.config[:chef_image] = "chef/chef" |
| 229 | + driver.config[:chef_version] = "17.10.0" |
| 230 | + expect(driver.chef_image).to eq("chef/chef:17.10.0") |
| 231 | + end |
| 232 | + end |
| 233 | + |
| 234 | + describe "#chef_container_name" do |
| 235 | + it "generates name without platform" do |
| 236 | + driver.config[:platform] = "" |
| 237 | + driver.config[:chef_version] = "latest" |
| 238 | + expect(driver.chef_container_name).to eq("chef-latest") |
| 239 | + end |
| 240 | + |
| 241 | + it "generates name with platform" do |
| 242 | + driver.config[:platform] = "linux/amd64" |
| 243 | + driver.config[:chef_version] = "17.10.0" |
| 244 | + expect(driver.chef_container_name).to eq("chef-17.10.0-linux-amd64") |
| 245 | + end |
| 246 | + end |
| 247 | + |
| 248 | + describe "#oci_platform" do |
| 249 | + it "returns nil for nil input" do |
| 250 | + expect(driver.oci_platform(nil)).to be_nil |
| 251 | + end |
| 252 | + |
| 253 | + it "returns empty string as-is" do |
| 254 | + expect(driver.oci_platform("")).to eq("") |
| 255 | + end |
| 256 | + |
| 257 | + it "converts os/arch format to JSON" do |
| 258 | + result = driver.oci_platform("linux/amd64") |
| 259 | + parsed = JSON.parse(result) |
| 260 | + expect(parsed).to eq({ "os" => "linux", "architecture" => "amd64" }) |
| 261 | + end |
| 262 | + |
| 263 | + it "returns non-slash platforms as-is" do |
| 264 | + expect(driver.oci_platform("linux")).to eq("linux") |
| 265 | + end |
| 266 | + end |
| 267 | + |
| 268 | + describe "#coerce_tmpfs" do |
| 269 | + it "returns nil for nil" do |
| 270 | + expect(driver.coerce_tmpfs(nil)).to be_nil |
| 271 | + end |
| 272 | + |
| 273 | + it "returns hash unchanged" do |
| 274 | + hash = { "/tmp" => "rw,noexec" } |
| 275 | + expect(driver.coerce_tmpfs(hash)).to eq(hash) |
| 276 | + end |
| 277 | + |
| 278 | + it "converts array of strings to hash" do |
| 279 | + result = driver.coerce_tmpfs(["/tmp:rw,noexec", "/run"]) |
| 280 | + expect(result).to eq({ "/tmp" => "rw,noexec", "/run" => "" }) |
| 281 | + end |
| 282 | + |
| 283 | + it "handles single string" do |
| 284 | + result = driver.coerce_tmpfs(["/tmp"]) |
| 285 | + expect(result).to eq({ "/tmp" => "" }) |
| 286 | + end |
| 287 | + end |
| 288 | + |
| 289 | + describe "#work_image" do |
| 290 | + it "returns instance_name without prefix" do |
| 291 | + driver.config[:image_prefix] = nil |
| 292 | + expect(driver.work_image).to eq("test-instance") |
| 293 | + end |
| 294 | + |
| 295 | + it "prepends image_prefix when set" do |
| 296 | + driver.config[:image_prefix] = "myprefix" |
| 297 | + expect(driver.work_image).to eq("myprefix/test-instance") |
| 298 | + end |
| 299 | + end |
| 300 | + |
| 301 | + describe "PartialHash" do |
| 302 | + it "matches when all keys are present in other hash" do |
| 303 | + partial = DriverTestHarness::PartialHash.new |
| 304 | + partial["a"] = 1 |
| 305 | + expect(partial == { "a" => 1, "b" => 2 }).to be true |
| 306 | + end |
| 307 | + |
| 308 | + it "does not match when a key is missing" do |
| 309 | + partial = DriverTestHarness::PartialHash.new |
| 310 | + partial["a"] = 1 |
| 311 | + expect(partial == { "b" => 2 }).to be false |
| 312 | + end |
| 313 | + |
| 314 | + it "does not match when values differ" do |
| 315 | + partial = DriverTestHarness::PartialHash.new |
| 316 | + partial["a"] = 1 |
| 317 | + expect(partial == { "a" => 2 }).to be false |
| 318 | + end |
| 319 | + |
| 320 | + it "empty PartialHash matches any hash" do |
| 321 | + partial = DriverTestHarness::PartialHash.new |
| 322 | + expect(partial == { "a" => 1 }).to be true |
| 323 | + end |
| 324 | + |
| 325 | + it "does not match non-hash objects" do |
| 326 | + partial = DriverTestHarness::PartialHash.new |
| 327 | + partial["a"] = 1 |
| 328 | + expect(partial == "not a hash").to be false |
| 329 | + end |
| 330 | + end |
| 331 | + |
| 332 | + describe "#coerce_volumes" do |
| 333 | + it "returns nil for nil" do |
| 334 | + expect(driver.coerce_volumes(nil, [])).to be_nil |
| 335 | + end |
| 336 | + |
| 337 | + it "converts hash to PartialHash" do |
| 338 | + result = driver.coerce_volumes({ "/data" => {} }, []) |
| 339 | + expect(result).to be_a(DriverTestHarness::PartialHash) |
| 340 | + expect(result).to eq({ "/data" => {} }) |
| 341 | + end |
| 342 | + |
| 343 | + it "separates bind mounts from volumes" do |
| 344 | + binds = [] |
| 345 | + result = driver.coerce_volumes(["/host:/container", "/data"], binds) |
| 346 | + expect(result).to eq({ "/data" => {} }) |
| 347 | + expect(binds.flatten).to include("/host:/container") |
| 348 | + end |
| 349 | + |
| 350 | + it "returns empty PartialHash when all items are bind mounts" do |
| 351 | + binds = [] |
| 352 | + result = driver.coerce_volumes(["/host:/container"], binds) |
| 353 | + expect(result).to eq({}) |
| 354 | + expect(result).to be_a(DriverTestHarness::PartialHash) |
| 355 | + end |
| 356 | + |
| 357 | + it "leaves PartialHash input unchanged" do |
| 358 | + ph = DriverTestHarness::PartialHash["/data" => {}] |
| 359 | + binds = [] |
| 360 | + expect(driver.coerce_volumes(ph, binds)).to equal(ph) |
| 361 | + end |
| 362 | + end |
| 363 | +end |
0 commit comments