kitchen-incus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c78973342a2b93eab14c8bec45e92867b1280e5aec1c766949c24d25d54101fe
+  data.tar.gz: 18578dc78622ae94a27d34b698ea11757eaeb407ff8051d95182ff21e8311fbf
+SHA512:
+  metadata.gz: 8e79f774bb991d984088c0733c3357f684070ad8943ded3970f58fb4398e6012830c5cf01ef8f5fdfbbfe42ae62a92ae700e63cffe3fbd3fc89ff54249ee3784
+  data.tar.gz: 0e354aea27540b346213fe108d496cdfd16a34200545b038ce594d3f99df81ada6ef7b4ec6fb0bb68cb221bf91400c50698a72918f394a2c9234065e8df6789c

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-10-27
+
+### Added
+
+- Initial release.
+- Test Kitchen `incus` driver: create, start, wait, delete, and live status.
+- Test Kitchen `incus` transport: `incus exec`, tar-stream uploads with `incus file push` fallback, `incus file pull` downloads, and `kitchen login`.
+- Bundled `incus` InSpec train backend for the `inspec` verifier.
+- Cinc-by-default provisioning via `kitchen-cinc`.
+
+[0.1.0]: https://github.com/aae42/kitchen-incus/releases/tag/v0.1.0

data/LICENSE

@@ -0,0 +1,217 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+
+Copyright 2026 Andrew Brossia
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,87 @@
+# kitchen-incus
+
+A [Test Kitchen](https://kitchen.ci) driver and transport for [Incus](https://linuxcontainers.org/incus/) containers and virtual machines.
+
+Everything goes through the `incus` CLI, so any remote your client can reach works: the local unix socket, or a remote HTTPS server or cluster. Instances don't need SSH or a network route from your workstation.
+
+- **Driver** (`incus`): creates, starts, waits for, and deletes instances. It also reports live status for `kitchen list --live`.
+- **Transport** (`incus`): runs commands with `incus exec`, uploads files as a tar stream (falling back to `incus file push`), downloads with `incus file pull`, and opens `kitchen login` with `incus exec … -- su -l`.
+- **InSpec**: when the transport is `incus`, the `inspec` verifier runs through a bundled `incus` train backend.
+- **Cinc by default**: this gem depends on `kitchen-cinc`. Use `cinc_infra`, `cinc_zero`, `cinc_solo`, or `cinc_apply`. The `chef_*` provisioner names also install Cinc unless `kitchen-chef-enterprise` is installed.
+
+## Usage
+
+```yaml
+driver:
+  name: incus
+
+transport:
+  name: incus
+
+provisioner:
+  name: cinc_infra
+
+verifier:
+  name: inspec
+
+platforms:
+  - name: debian-12          # image defaults to images:debian/12
+  - name: rockylinux-9
+  - name: ubuntu-24.04-vm
+    driver:
+      image: images:ubuntu/24.04
+      vm: true
+      config:
+        limits.cpu: 2
+        limits.memory: 2GiB
+
+suites:
+  - name: default
+    run_list:
+      - recipe[my_cookbook::default]
+```
+
+`kitchen create`, `converge`, `verify`, `test`, `login`, `exec`, `destroy`, and `list --live --probe` all work.
+
+## Driver options
+
+| Option | Default | Description |
+| --- | --- | --- |
+| `remote` | client default | Incus remote. The resolved name is saved in state, so `destroy` still targets the right server if you later switch remotes. |
+| `project` | remote's current project | Incus project |
+| `image` | `images:<distro>/<version>` | Derived from the platform name (`ubuntu-24.04` → `images:ubuntu/24.04`) |
+| `vm` | `false` | Launch a VM instead of a container |
+| `profiles` | `[]` | Profiles to apply. Empty means the server default. Setting this replaces `default`. |
+| `config` | `{}` | Instance config keys, e.g. `security.nesting: true` |
+| `devices` | `{}` | `{ name => { type: disk, source: /src, path: /dst } }` |
+| `storage_pool` | `nil` | `--storage` |
+| `network` | `nil` | `--network` |
+| `instance_type` | `nil` | `--type`, e.g. `c2-m4` |
+| `instance_name` | `kitchen-<instance>-<random>` | Explicit instance name |
+| `ready_timeout` | `300` | Seconds to wait for the instance to accept commands |
+| `wait_for_network` | `true` | Also wait for a global IP address |
+| `install_prerequisites` | `true` | Install `curl`, `sudo`, `tar`, and `ca-certificates` if they're missing (apt, dnf, yum, zypper, apk, pacman) |
+| `provision_commands` | `[]` | Shell commands to run after boot |
+| `incus_binary` | `incus` | Path to the client |
+
+## Transport options
+
+| Option | Default | Description |
+| --- | --- | --- |
+| `user` | root | uid that commands run as |
+| `env` | `{}` | Extra environment variables for every command |
+| `login_command` | `["su", "-l"]` | Command that `kitchen login` runs |
+| `ready_timeout` | `300` | Seconds `wait_until_ready` waits |
+
+## Standalone InSpec / cinc-auditor
+
+```
+cinc-auditor exec profile -t incus://my-instance --remote myremote
+```
+
+## Development
+
+```
+bundle exec rspec
+cd test/kitchen && RUBYLIB=../../lib kitchen test     # live run on your current Incus remote
+```

data/lib/kitchen/driver/incus.rb

@@ -0,0 +1,252 @@
+# frozen_string_literal: true
+
+require "securerandom"
+require "time"
+require "kitchen"
+require "kitchen/driver/base"
+require_relative "../incus/cli"
+require_relative "../incus/version"
+
+module Kitchen
+  module Driver
+    # Test Kitchen driver for Incus containers and virtual machines.
+    #
+    # Instances are managed with the `incus` CLI, so any remote configured in
+    # the client (local unix socket or a remote HTTPS server/cluster) works.
+    class Incus < Kitchen::Driver::Base
+      kitchen_driver_api_version 2
+
+      plugin_version Kitchen::Incus::VERSION
+
+      # Incus remote to use; nil uses the client's default remote.
+      default_config :remote, nil
+      # Incus project; nil uses the remote's current project.
+      default_config :project, nil
+      # Image to launch. Defaults to images:<distro>/<version> derived from
+      # the platform name (e.g. ubuntu-24.04 -> images:ubuntu/24.04).
+      default_config :image do |driver|
+        driver.default_image
+      end
+      # Launch a virtual machine instead of a container.
+      default_config :vm, false
+      # Profiles to apply (empty = server default profile).
+      default_config :profiles, []
+      # Instance config keys (e.g. limits.cpu: 2, security.nesting: true).
+      default_config :config, {}
+      # Extra devices: { name => { type: disk, source: /x, path: /y } }.
+      default_config :devices, {}
+      default_config :storage_pool, nil
+      default_config :network, nil
+      # Instance type shorthand (e.g. c2-m4) passed to `incus init --type`.
+      default_config :instance_type, nil
+      # Explicit instance name; default is kitchen-<instance>-<random>.
+      default_config :instance_name, nil
+      # Seconds to wait for the instance to accept commands (and get an IP).
+      default_config :ready_timeout, 300
+      # Wait for a global IP address before continuing (needed to download Cinc).
+      default_config :wait_for_network, true
+      # Shell commands run inside the instance after it boots.
+      default_config :provision_commands, []
+      # Install curl/ca-certificates/sudo when missing, so Cinc can be
+      # downloaded and the provisioner's default `sudo -E` works.
+      default_config :install_prerequisites, true
+      default_config :incus_binary, "incus"
+
+      # Shell script that installs the packages the Cinc installer and Test
+      # Kitchen expect, using whichever package manager is present.
+      PREREQS_SCRIPT = <<~'SH'
+        missing=""
+        command -v curl >/dev/null 2>&1 || command -v wget >/dev/null 2>&1 || missing="$missing curl"
+        command -v sudo >/dev/null 2>&1 || missing="$missing sudo"
+        command -v tar >/dev/null 2>&1 || missing="$missing tar"
+        [ -e /etc/ssl/certs/ca-certificates.crt ] || [ -e /etc/pki/tls/certs/ca-bundle.crt ] || missing="$missing ca-certificates"
+        [ -z "$missing" ] && exit 0
+        echo "Installing missing prerequisites:$missing"
+        if command -v apt-get >/dev/null 2>&1; then
+          export DEBIAN_FRONTEND=noninteractive
+          apt-get update -q && apt-get install -y -q $missing
+        elif command -v dnf >/dev/null 2>&1; then dnf install -y $missing
+        elif command -v yum >/dev/null 2>&1; then yum install -y $missing
+        elif command -v zypper >/dev/null 2>&1; then zypper --non-interactive install $missing
+        elif command -v apk >/dev/null 2>&1; then apk add --no-cache $missing
+        elif command -v pacman >/dev/null 2>&1; then pacman -Sy --noconfirm $missing
+        else echo "No supported package manager found; please install:$missing" >&2; exit 1
+        fi
+      SH
+
+      def finalize_config!(instance)
+        super
+        warn_if_chef_provisioner(instance)
+        self
+      end
+
+      # (see Base#create)
+      def create(state)
+        super
+
+        if state[:incus_instance] && cli(state).state(state[:incus_instance])
+          info("Incus instance #{cli(state).target(state[:incus_instance])} already exists")
+          cli(state).run("start", *cli(state).project_args, cli(state).target(state[:incus_instance]), allow_failure: true)
+        else
+          state[:incus_instance] = config[:instance_name] || generate_name
+          # Record the resolved remote/project so later actions hit the same
+          # server even if the client's default remote changes.
+          state[:incus_remote] = config[:remote] || resolve_default_remote
+          state[:incus_project] = config[:project]
+          launch(state)
+        end
+
+        wait_until_ready(state)
+        state[:hostname] = ip_address(cli(state).state(state[:incus_instance]))
+        bootstrap(state)
+        info("Incus instance #{cli(state).target(state[:incus_instance])} ready#{state[:hostname] ? " (#{state[:hostname]})" : ""}")
+      rescue Kitchen::Incus::CommandFailed => e
+        raise ActionFailed, e.message
+      end
+
+      # (see Base#destroy)
+      def destroy(state)
+        name = state[:incus_instance]
+        return if name.nil?
+
+        c = cli(state)
+        info("Destroying Incus instance #{c.target(name)}")
+        result = c.run("delete", *c.project_args, "--force", c.target(name), allow_failure: true)
+        if !result.success? && result.stderr !~ /not found/i
+          raise ActionFailed, "Failed to delete #{c.target(name)}: #{result.stderr.strip}"
+        end
+
+        %i{incus_instance incus_remote incus_project hostname}.each { |k| state.delete(k) }
+      end
+
+      # (see Base#status)
+      def status(state)
+        name = state[:incus_instance]
+        now = Time.now.utc.iso8601
+        return { live: false, state: "not created", source: "incus", checked_at: now } if name.nil?
+
+        doc = cli(state).state(name)
+        if doc.nil?
+          return { live: false, state: "missing", source: "incus", resource_id: name,
+                   message: "Instance not found on Incus server", checked_at: now }
+        end
+
+        status = doc["status"].to_s
+        { live: status == "Running", state: status.downcase, source: "incus",
+          resource_id: cli(state).target(name), checked_at: now }
+      end
+
+      # (see Base#doctor)
+      def doctor(_state)
+        result = cli({}).run("version", allow_failure: true, timeout: 30)
+        if result.stdout =~ /Server version: unreachable/ || !result.success?
+          error("Unable to reach Incus server: #{(result.stdout + result.stderr).strip}")
+          return true
+        end
+        false
+      rescue Kitchen::Incus::CommandFailed => e
+        error(e.message)
+        true
+      end
+
+      # Derive an images: remote alias from the platform name.
+      #
+      # @return [String]
+      def default_image
+        name = instance.platform.name
+        if (m = name.match(/\A(.+?)-(\d[\w.]*)\z/))
+          "images:#{m[1]}/#{m[2]}"
+        else
+          "images:#{name}"
+        end
+      end
+
+      private
+
+      def cli(state)
+        Kitchen::Incus::CLI.new(
+          binary: config[:incus_binary],
+          remote: state.fetch(:incus_remote, config[:remote]),
+          project: state.fetch(:incus_project, config[:project]),
+          logger:
+        )
+      end
+
+      def resolve_default_remote
+        remote = cli({}).run("remote", "get-default", timeout: 30).stdout.strip
+        remote.empty? ? nil : remote
+      end
+
+      def launch(state)
+        c = cli(state)
+        target = c.target(state[:incus_instance])
+        info("Creating Incus #{config[:vm] ? "VM" : "container"} #{target} from #{config[:image]}")
+
+        args = ["init", *c.project_args, config[:image], target, "--quiet"]
+        args << "--vm" if config[:vm]
+        Array(config[:profiles]).each { |p| args.push("--profile", p) }
+        config[:config].each { |k, v| args.push("--config", "#{k}=#{v}") }
+        args.push("--storage", config[:storage_pool]) if config[:storage_pool]
+        args.push("--network", config[:network]) if config[:network]
+        args.push("--type", config[:instance_type]) if config[:instance_type]
+        c.run(*args)
+
+        config[:devices].each do |dev, props|
+          props = props.transform_keys(&:to_s)
+          type = props.delete("type") || raise(ActionFailed, "device #{dev} is missing a type")
+          c.run("config", "device", "add", *c.project_args, target, dev.to_s, type,
+            *props.map { |k, v| "#{k}=#{v}" })
+        end
+
+        c.run("start", *c.project_args, target)
+      end
+
+      def wait_until_ready(state)
+        c = cli(state)
+        name = state[:incus_instance]
+        deadline = Time.now + config[:ready_timeout].to_i
+        info("Waiting for #{c.target(name)} to accept commands#{config[:wait_for_network] ? " and get an IP" : ""}")
+
+        loop do
+          ready = c.exec(name, "true", allow_failure: true, timeout: 30).success?
+          ready &&= !ip_address(c.state(name)).nil? if config[:wait_for_network]
+          return if ready
+          raise ActionFailed, "Timed out after #{config[:ready_timeout]}s waiting for #{c.target(name)}" if Time.now > deadline
+
+          sleep 2
+        end
+      end
+
+      # First global address on a non-loopback interface, IPv4 preferred.
+      def ip_address(doc)
+        addrs = (doc&.dig("network") || {}).reject { |_, n| n["type"] == "loopback" }
+          .values.flat_map { |n| n["addresses"] || [] }
+          .select { |a| a["scope"] == "global" }
+        (addrs.find { |a| a["family"] == "inet" } || addrs.first)&.dig("address")
+      end
+
+      def bootstrap(state)
+        c = cli(state)
+        name = state[:incus_instance]
+        commands = []
+        commands << PREREQS_SCRIPT if config[:install_prerequisites]
+        commands.concat(Array(config[:provision_commands]))
+        commands.each { |cmd| c.exec(name, cmd, live: true) }
+      end
+
+      def generate_name
+        base = instance.name.downcase.gsub(/[^a-z0-9-]/, "-").squeeze("-")
+        # Incus names: <= 63 chars, letters/digits/hyphens, must not start with a digit.
+        "kitchen-#{base}"[0, 55].sub(/-+\z/, "") + "-#{SecureRandom.hex(3)}"
+      end
+
+      def warn_if_chef_provisioner(instance)
+        prov = instance.provisioner
+        return unless prov.class.name.to_s =~ /\AKitchen::Provisioner::Chef/
+        return if defined?(Kitchen::Provisioner::CincBase) && prov.is_a?(Kitchen::Provisioner::CincBase)
+
+        warn("Provisioner #{prov.name} will install Chef Infra Client; use `cinc_infra` (kitchen-cinc) to install Cinc instead")
+      end
+    end
+  end
+end

data/lib/kitchen/incus/cli.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+require "json"
+require "open3"
+require "mixlib/shellout"
+
+module Kitchen
+  module Incus
+    # Raised when an `incus` CLI invocation fails.
+    class CommandFailed < StandardError
+      attr_reader :exit_code, :stderr
+
+      def initialize(message, exit_code = nil, stderr = nil)
+        @exit_code = exit_code
+        @stderr = stderr
+        super(message)
+      end
+    end
+
+    # Thin wrapper around the `incus` command line client.
+    #
+    # Every command is executed with an argument vector (never through a
+    # shell), so instance names, paths and commands are not subject to shell
+    # interpolation on the workstation.
+    class CLI
+      Result = Struct.new(:stdout, :stderr, :exit_code) do
+        def success?
+          exit_code == 0
+        end
+      end
+
+      # Default timeout for long running commands (converges, image pulls).
+      DEFAULT_TIMEOUT = 60 * 60 * 3
+
+      attr_reader :binary, :remote, :project
+
+      # @param binary [String] path to the incus client
+      # @param remote [String, nil] incus remote name; nil uses the default remote
+      # @param project [String, nil] incus project; nil uses the remote's current project
+      # @param logger [Kitchen::Logger, nil] logger used for debug + live output
+      def initialize(binary: "incus", remote: nil, project: nil, logger: nil)
+        @binary = binary || "incus"
+        @remote = blank?(remote) ? nil : remote.to_s
+        @project = blank?(project) ? nil : project.to_s
+        @logger = logger
+      end
+
+      # @param name [String] instance name
+      # @return [String] `remote:name` or `name`
+      def target(name)
+        remote ? "#{remote}:#{name}" : name.to_s
+      end
+
+      # `--project` flag (must follow the sub-command).
+      def project_args
+        project ? ["--project", project] : []
+      end
+
+      # Run an incus sub-command and capture its output.
+      #
+      # @param args [Array<String>] sub-command and arguments
+      # @param input [String, nil] data written to stdin
+      # @param live [Boolean] stream output to the logger while running
+      # @param allow_failure [Boolean] return the result instead of raising
+      # @return [Result]
+      def run(*args, input: nil, live: false, allow_failure: false, timeout: DEFAULT_TIMEOUT)
+        argv = [binary, *args.flatten.map(&:to_s)]
+        debug("[incus] #{argv.join(" ")}")
+        opts = { timeout:, environment: { "LC_ALL" => nil } }
+        opts[:input] = input if input
+        opts[:live_stream] = @logger if live && @logger
+        sh = Mixlib::ShellOut.new(*argv, **opts)
+        sh.run_command
+        result = Result.new(sh.stdout, sh.stderr, sh.exitstatus)
+        if !result.success? && !allow_failure
+          raise CommandFailed.new(
+            "`#{argv.join(" ")}` exited #{result.exit_code}: #{result.stderr.strip}",
+            result.exit_code, result.stderr
+          )
+        end
+        result
+      rescue Errno::ENOENT
+        raise CommandFailed, "incus client `#{binary}` not found on PATH"
+      end
+
+      # Execute a shell command inside an instance.
+      #
+      # @param name [String] instance name
+      # @param command [String] POSIX shell command
+      # @param user [Integer, nil] uid to run as
+      # @param env [Hash] environment variables
+      # @return [Result]
+      def exec(name, command, user: nil, env: {}, **opts)
+        run(*exec_args(name, user:, env:), "--", "sh", "-c", command, **opts)
+      end
+
+      # Arguments for `incus exec` up to (not including) the `--` separator.
+      def exec_args(name, user: nil, env: {}, interactive: false)
+        args = ["exec", *project_args]
+        args << (interactive ? "-t" : "-T")
+        args += ["--user", user.to_s] if user
+        env.each { |k, v| args += ["--env", "#{k}=#{v}"] }
+        args << target(name)
+        args
+      end
+
+      # Copy a local file or directory into the instance under remote_dir.
+      #
+      # Uses a tar stream over `incus exec` so a whole directory tree is moved
+      # in a single API round trip (much faster than `incus file push -r`
+      # against remote servers). Falls back to `incus file push` when the
+      # instance has no tar.
+      def push(name, local, remote_dir, user: nil)
+        local = File.expand_path(local)
+        unless guest_has_tar?(name)
+          return run("file", "push", *project_args, "-r", "-p", local, "#{target(name)}#{remote_dir.chomp("/")}/")
+        end
+
+        tar = ["tar", "-C", File.dirname(local), "-cf", "-", File.basename(local)]
+        incus = [binary, *exec_args(name, user:), "--", "tar", "-C", remote_dir, "-xf", "-"]
+        debug("[incus] #{tar.join(" ")} | #{incus.join(" ")}")
+
+        statuses = nil
+        err_r, err_w = IO.pipe
+        # COPYFILE_DISABLE stops macOS bsdtar from adding ._ resource files.
+        Open3.pipeline_w([{ "COPYFILE_DISABLE" => "1" }, *tar], incus, err: err_w) do |stdin, threads|
+          stdin.close
+          statuses = threads.map(&:value)
+        end
+        err_w.close
+        stderr = err_r.read
+        err_r.close
+        return if statuses.all?(&:success?)
+
+        raise CommandFailed.new("upload of #{local} to #{target(name)}:#{remote_dir} failed: #{stderr.strip}",
+          statuses.map(&:exitstatus).find { |c| c != 0 }, stderr)
+      end
+
+      # Copy a file or directory out of the instance.
+      def pull(name, remote_path, local)
+        run("file", "pull", *project_args, "-r", "#{target(name)}#{remote_path}", local)
+      end
+
+      # @return [Hash, nil] the instance state document, or nil if absent
+      def state(name)
+        result = run("query", api_path("/1.0/instances/#{name}/state"), allow_failure: true, timeout: 60)
+        return JSON.parse(result.stdout) if result.success?
+        return nil if result.stderr =~ /not found/i
+
+        raise CommandFailed.new("unable to query #{target(name)}: #{result.stderr.strip}", result.exit_code, result.stderr)
+      end
+
+      private
+
+      def guest_has_tar?(name)
+        @guest_has_tar ||= {}
+        return @guest_has_tar[name] if @guest_has_tar.key?(name)
+
+        @guest_has_tar[name] = exec(name, "command -v tar", allow_failure: true, timeout: 60).success?
+      end
+
+      # `incus query` refuses `--project`, so the project goes into the URL.
+      def api_path(path)
+        path = "#{path}?project=#{project}" if project
+        remote ? "#{remote}:#{path}" : path
+      end
+
+      def blank?(value)
+        value.nil? || value.to_s.strip.empty?
+      end
+
+      def debug(msg)
+        @logger&.debug(msg)
+      end
+    end
+  end
+end

data/lib/kitchen/incus/inspec_support.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "train-incus"
+
+module Kitchen
+  module Incus
+    # Mixed into a Kitchen::Verifier::Inspec instance by the incus transport
+    # so InSpec runs through the `incus` train backend (see train-incus.rb).
+    # kitchen-inspec dispatches on `runner_options_for_<transport name>`.
+    module InspecSupport
+      private
+
+      def runner_options_for_incus(config_data)
+        opts = instance.transport.connection_options(config_data)
+        {
+          "backend" => "incus",
+          "logger" => logger,
+          "host" => opts[:instance_name],
+          "remote" => opts[:remote],
+          "project" => opts[:project],
+          "incus_binary" => opts[:incus_binary],
+          "incus_user" => opts[:user],
+        }.compact
+      end
+    end
+  end
+end

data/lib/kitchen/incus/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Incus
+    VERSION = "0.1.0"
+  end
+end

data/lib/kitchen/transport/incus.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require "kitchen"
+require "kitchen/transport/base"
+require_relative "../incus/cli"
+require_relative "../incus/version"
+
+module Kitchen
+  module Transport
+    # Test Kitchen transport that talks to Incus instances through the
+    # `incus` CLI (`incus exec`), so no SSH or network reachability to the
+    # instance is required.
+    class Incus < Kitchen::Transport::Base
+      kitchen_transport_api_version 1
+
+      plugin_version Kitchen::Incus::VERSION
+
+      default_config :incus_binary, "incus"
+      # uid to run commands as inside the instance (nil = root).
+      default_config :user, nil
+      # Extra environment variables for every command.
+      default_config :env, {}
+      # Command used for `kitchen login`.
+      default_config :login_command, ["su", "-l"]
+      # Seconds to wait for the instance agent to accept commands.
+      default_config :ready_timeout, 300
+
+      def finalize_config!(instance)
+        super
+        # Teach kitchen-inspec how to reach Incus instances, if it is in use.
+        verifier = instance.verifier
+        if defined?(Kitchen::Verifier::Inspec) && verifier.is_a?(Kitchen::Verifier::Inspec)
+          require_relative "../incus/inspec_support"
+          verifier.extend(Kitchen::Incus::InspecSupport)
+        end
+        self
+      end
+
+      def connection(state, &block)
+        options = connection_options(config.to_hash.merge(state))
+        Kitchen::Transport::Incus::Connection.new(options, &block)
+      end
+
+      # Builds the options shared by the transport connection and the InSpec
+      # integration.
+      #
+      # @api private
+      def connection_options(data)
+        # These keys are written to the instance state by the incus driver.
+        name = data[:incus_instance]
+        raise ActionFailed, "No Incus instance recorded for #{instance.to_str}; run `kitchen create` first" if name.nil?
+
+        {
+          instance_name: name,
+          remote: data[:incus_remote],
+          project: data[:incus_project],
+          incus_binary: data[:incus_binary],
+          user: data[:user],
+          env: data[:env] || {},
+          login_command: Array(data[:login_command]),
+          ready_timeout: data[:ready_timeout],
+          logger:,
+        }
+      end
+
+      # Connection that executes commands with `incus exec` and moves files
+      # with tar streams.
+      class Connection < Kitchen::Transport::Base::Connection
+        def init_options(options)
+          super
+          @name = @options[:instance_name]
+          @cli = Kitchen::Incus::CLI.new(
+            binary: @options[:incus_binary],
+            remote: @options[:remote],
+            project: @options[:project],
+            logger:
+          )
+        end
+
+        # (see Base::Connection#execute)
+        def execute(command)
+          return if command.nil? || command.to_s.strip.empty?
+
+          debug("[Incus] #{@cli.target(@name)} executing: #{command}")
+          @cli.exec(@name, command, user: @options[:user], env: @options[:env], live: true)
+        rescue Kitchen::Incus::CommandFailed => e
+          raise TransportFailed.new(e.message, e.exit_code)
+        end
+
+        # (see Base::Connection#upload)
+        def upload(locals, remote)
+          @cli.exec(@name, "mkdir -p #{shell_quote(remote)}", user: @options[:user])
+          Array(locals).each do |local|
+            debug("[Incus] uploading #{local} to #{@cli.target(@name)}:#{remote}")
+            @cli.push(@name, local, remote, user: @options[:user])
+          end
+        rescue Kitchen::Incus::CommandFailed => e
+          raise TransportFailed.new(e.message, e.exit_code)
+        end
+
+        # (see Base::Connection#download)
+        def download(remotes, local)
+          FileUtils.mkdir_p(local)
+          Array(remotes).each do |remote|
+            @cli.pull(@name, remote, local)
+          end
+        rescue Kitchen::Incus::CommandFailed => e
+          raise TransportFailed.new(e.message, e.exit_code)
+        end
+
+        # (see Base::Connection#login_command)
+        def login_command
+          args = @cli.exec_args(@name, user: @options[:user], env: @options[:env], interactive: true)
+          LoginCommand.new(@cli.binary, [*args, "--", *@options[:login_command]])
+        end
+
+        # Waits until the Incus agent (VMs) or init (containers) accepts
+        # commands.
+        def wait_until_ready
+          deadline = Time.now + (@options[:ready_timeout] || 300).to_i
+          loop do
+            result = @cli.exec(@name, "true", allow_failure: true, timeout: 30)
+            return if result.success?
+            raise TransportFailed, "#{@cli.target(@name)} not ready: #{result.stderr.strip}" if Time.now > deadline
+
+            sleep 2
+          end
+        end
+
+        private
+
+        def shell_quote(str)
+          "'#{str.to_s.gsub("'", "'\\\\''")}'"
+        end
+      end
+    end
+  end
+end

data/lib/train-incus.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# Train transport plugin for Incus instances, used by InSpec / cinc-auditor.
+#
+# Commands run via `incus exec`, so the instance does not need SSH or a
+# network path from the workstation. Can also be used standalone:
+#
+#   inspec exec profile -t incus://my-instance --remote myremote --project p
+#
+require "train"
+require "train/plugins"
+require_relative "kitchen/incus/cli"
+
+module Train
+  module Transports
+    class Incus < Train.plugin(1)
+      name "incus"
+
+      option :host, required: true, desc: "Incus instance name"
+      option :remote, default: nil, desc: "Incus remote (defaults to the client's default remote)"
+      option :project, default: nil, desc: "Incus project"
+      option :incus_binary, default: "incus", desc: "Path to the incus client"
+      option :incus_user, default: nil, desc: "uid to run commands as"
+
+      def connection(_instance_opts = nil)
+        @connection ||= Connection.new(@options)
+      end
+
+      class Connection < BaseConnection
+        def initialize(options)
+          super(options)
+          @name = @options[:host]
+          @user = @options[:incus_user]
+          @cli = Kitchen::Incus::CLI.new(
+            binary: @options[:incus_binary],
+            remote: @options[:remote],
+            project: @options[:project]
+          )
+        end
+
+        def uri
+          "incus://#{@cli.target(@name)}"
+        end
+
+        def unique_identifier
+          @cli.target(@name)
+        end
+
+        def local?
+          false
+        end
+
+        private
+
+        def run_command_via_connection(cmd, &_data_handler)
+          result = @cli.exec(@name, cmd, user: @user, allow_failure: true)
+          CommandResult.new(result.stdout, result.stderr, result.exit_code)
+        end
+
+        def file_via_connection(path, *_args)
+          Train::File::Remote::Linux.new(self, path)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-incus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Brossia
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: kitchen-cinc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mixlib-shellout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Runs Test Kitchen instances as Incus containers or virtual machines,
+  using the incus CLI for exec, file transfer, login and InSpec verification.
+email:
+- abrossia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/kitchen/driver/incus.rb
+- lib/kitchen/incus/cli.rb
+- lib/kitchen/incus/inspec_support.rb
+- lib/kitchen/incus/version.rb
+- lib/kitchen/transport/incus.rb
+- lib/train-incus.rb
+homepage: https://github.com/aae42/kitchen-incus
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/aae42/kitchen-incus
+  source_code_uri: https://github.com/aae42/kitchen-incus/tree/main
+  changelog_uri: https://github.com/aae42/kitchen-incus/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/aae42/kitchen-incus/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: Test Kitchen driver and transport for Incus containers and VMs
+test_files: []