kitchen-cinc 1.0.0

data/lib/kitchen/provisioner/cinc_solo.rb

@@ -0,0 +1,86 @@
+#
+# Copyright (C) 2013, Fletcher Nichol
+# Copyright (C) 2026, Oregon State University
+#
+# 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
+#
+#    https://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.
+
+require_relative "cinc_base"
+
+module Kitchen
+  module Provisioner
+    # Cinc Solo provisioner.
+    #
+    # @author Cinc Project
+    class CincSolo < CincBase
+      kitchen_provisioner_api_version 2
+
+      plugin_version Kitchen::VERSION
+
+      # CincSolo is dependent on Berkshelf, which is not thread-safe.
+      # See discussion on https://github.com/test-kitchen/test-kitchen/issues/1307
+      no_parallel_for :converge
+
+      default_config :solo_rb, {}
+
+      default_config :cinc_solo_path do |provisioner|
+        provisioner
+          .remote_path_join(%W{#{provisioner[:cinc_omnibus_root]} bin cinc-solo})
+          .tap { |path| path.concat(".bat") if provisioner.windows_os? }
+      end
+
+      default_config :ruby_bindir do |provisioner|
+        provisioner
+          .remote_path_join(%W{#{provisioner[:cinc_omnibus_root]} embedded bin})
+      end
+
+      # (see Base#config_filename)
+      def config_filename
+        "solo.rb"
+      end
+
+      # (see Base#create_sandbox)
+      def create_sandbox
+        super
+        prepare_config_rb
+      end
+
+      # (see Base#run_command)
+      def run_command
+        cmd = sudo(config[:cinc_solo_path]).dup
+          .tap { |str| str.insert(0, "& ") if powershell_shell? }
+
+        chef_cmd(cmd)
+      end
+
+      private
+
+      # Returns an Array of command line arguments for the cinc-solo client.
+      #
+      # @return [Array<String>] an array of command line arguments
+      # @api private
+      def chef_args(solo_rb_filename)
+        args = [
+          "--config #{remote_path_join(config[:root_path], solo_rb_filename)}",
+          "--log_level #{config[:log_level]}",
+          "--force-formatter",
+          "--no-color",
+          "--json-attributes #{remote_path_join(config[:root_path], "dna.json")}",
+        ]
+        args << "--logfile #{config[:log_file]}" if config[:log_file]
+        args << "--profile-ruby" if config[:profile_ruby]
+        args << "--legacy-mode" if config[:legacy_mode]
+        args
+      end
+    end
+  end
+end

data/lib/kitchen/provisioner/cinc_target.rb

@@ -0,0 +1,131 @@
+#
+# Copyright (C) 2023, Thomas Heinen
+# Copyright (C) 2026, Oregon State University
+#
+# 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
+#
+#    https://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.
+
+require_relative "cinc_infra"
+
+module Kitchen
+  module Provisioner
+    # Cinc Target Mode provisioner for remote execution.
+    #
+    # Requires Cinc Client 19.0.0+ and Train-based transport.
+    #
+    # @author Cinc Project
+    class CincTarget < CincInfra
+      MIN_VERSION_REQUIRED = "19.0.0".freeze
+      class CincVersionTooLow < UserError; end
+      class CincClientNotFound < UserError; end
+      class RequireTrainTransport < UserError; end
+
+      default_config :install_strategy, "none"
+      default_config :sudo, true
+
+      def install_command; ""; end
+      def init_command; ""; end
+      def prepare_command; ""; end
+
+      def chef_args(client_rb_filename)
+        # Dummy execution to initialize and test remote connection
+        connection = instance.remote_exec("echo Connection established")
+
+        check_transport(connection)
+        check_local_cinc_client
+
+        instance_name = instance.name
+        credentials_file = File.join(kitchen_basepath, ".kitchen", instance_name + ".ini")
+        File.write(credentials_file, connection.credentials_file)
+
+        super.push(
+          "--target #{instance_name}",
+          "--credentials #{credentials_file}"
+        )
+      end
+
+      def check_transport(connection)
+        debug("Checking for active transport")
+
+        unless connection.respond_to? "train_uri"
+          error("Cinc Target Mode provisioner requires a Train-based transport like kitchen-transport-train")
+          raise RequireTrainTransport.new("No Train transport")
+        end
+
+        debug("Kitchen transport responds to train_uri function call, as required")
+      end
+
+      def check_local_cinc_client
+        debug("Checking for cinc-client version")
+
+        begin
+          client_version = `cinc-client -v`.chop.split(":")[-1]
+        rescue Errno::ENOENT => e
+          error("Error determining Cinc Client version: #{e.exception.message}")
+          raise CincClientNotFound.new("Need cinc-client installed locally")
+        end
+
+        minimum_version = Gem::Version.new(MIN_VERSION_REQUIRED)
+        installed_version = Gem::Version.new(client_version)
+
+        if installed_version < minimum_version
+          error("Found Cinc Client version #{installed_version}, but require #{minimum_version} for Target Mode")
+          raise CincVersionTooLow.new("Need version #{MIN_VERSION_REQUIRED} or higher")
+        end
+
+        debug("Cinc Client found and version constraints match")
+      end
+
+      def kitchen_basepath
+        instance.driver.config[:kitchen_root]
+      end
+
+      def create_sandbox
+        super
+
+        # Change config.rb to point to the local sandbox path, not to /tmp/kitchen
+        config[:root_path] = sandbox_path
+        prepare_config_rb
+      end
+
+      def call(state)
+        remote_connection = instance.transport.connection(state)
+
+        config[:uploads].to_h.each do |locals, remote|
+          debug("Uploading #{Array(locals).join(", ")} to #{remote}")
+          remote_connection.upload(locals.to_s, remote)
+        end
+
+        # no installation
+        create_sandbox
+        # no prepare command
+
+        # Stream output to logger
+        require "open3"
+        Open3.popen2e(run_command) do |_stdin, output, _thread|
+          output.each { |line| logger << line }
+        end
+
+        info("Downloading files from #{instance.to_str}")
+        config[:downloads].to_h.each do |remotes, local|
+          debug("Downloading #{Array(remotes).join(", ")} to #{local}")
+          remote_connection.download(remotes, local)
+        end
+        debug("Download complete")
+      rescue Kitchen::Transport::TransportFailed => ex
+        raise ActionFailed, ex.message
+      ensure
+        cleanup_sandbox
+      end
+    end
+  end
+end

data/lib/kitchen/provisioner/cinc_version.rb

@@ -0,0 +1,5 @@
+module Kitchen
+  module Provisioner
+    CINC_VERSION = "1.0.0".freeze
+  end
+end

data/lib/kitchen/provisioner/cinc_zero.rb

@@ -0,0 +1,18 @@
+# Deprecated - use CincInfra instead
+require_relative "cinc_infra"
+
+module Kitchen
+  module Provisioner
+    # Cinc Zero provisioner (deprecated, use CincInfra instead).
+    #
+    # This provisioner is maintained for backward compatibility and delegates
+    # to CincInfra.
+    #
+    # @author Cinc Project
+    class CincZero < CincInfra
+      kitchen_provisioner_api_version 2
+
+      plugin_version Kitchen::VERSION
+    end
+  end
+end

data/support/cinc-client-fail-if-update-handler.rb

@@ -0,0 +1,15 @@
+# Handler to kill the run if any resource is updated
+class UpdatedResources < ::Chef::Handler
+  def report
+    if updated_resources.size > 0
+      puts "First cinc run should have reached a converged state."
+      puts "Resources updated in a second cinc-client run:"
+      updated_resources.each do |r|
+        puts "- #{r}"
+      end
+      # exit 203 # chef handler catch Exception instead of StandardException
+      Process.kill("KILL", Process.pid)
+    end
+  end
+end
+report_handlers << UpdatedResources.new

data/support/cinc_base_init_command.ps1

@@ -0,0 +1,18 @@
+Function Delete-AllDirs($dirs) {
+  $dirs | ForEach-Object {
+    if (Test-Path ($path = Unresolve-Path $_)) { Remove-Item $path -Recurse -Force }
+  }
+}
+
+Function Unresolve-Path($p) {
+  if ($p -eq $null) { return $null }
+  else { return $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($p) }
+}
+
+Function Make-RootPath($p) {
+  $p = Unresolve-Path $p
+  if (-Not (Test-Path $p)) { New-Item $p -ItemType directory | Out-Null }
+}
+
+Delete-AllDirs $dirs
+Make-RootPath $root_path

data/support/cinc_base_init_command.sh

@@ -0,0 +1,2 @@
+$sudo_rm -rf $dirs
+mkdir -p $root_path

data/support/cinc_base_install_command.ps1

@@ -0,0 +1,86 @@
+$ErrorActionPreference = "stop"
+
+Function Check-UpdateCinc($root, $version) {
+  if (-Not (Test-Path $root)) { return $true }
+  elseif ("$version" -eq "true") { return $false }
+  elseif ("$version" -eq "latest") { return $true }
+  Try { $cinc_version = (Get-Content $root\version-manifest.txt | select-object -first 1) }
+  Catch {
+    Try { $cinc_version = (& $root\bin\cinc-solo.bat -v) }
+    Catch { $cinc_version = " " }
+  }
+
+  if ($cinc_version.split(" ", 2)[1].StartsWith($version)) { return $false }
+  else { return $true }
+}
+
+Function Get-CincMetadata($url) {
+  Try { $response = ($c = Make-WebClient).DownloadString($url) }
+  Finally { if ($c -ne $null) { $c.Dispose() } }
+
+  $md = ConvertFrom-StringData $response.Replace("`t", "=")
+  return @($md.url, $md.md5)
+}
+
+Function Get-MD5Sum($src) {
+  Try {
+    $c = New-Object -TypeName System.Security.Cryptography.MD5CryptoServiceProvider
+    $bytes = $c.ComputeHash(($in = (Get-Item $src).OpenRead()))
+    return ([System.BitConverter]::ToString($bytes)).Replace("-", "").ToLower()
+  } Finally { if (($c -ne $null) -and ($c.GetType().GetMethod("Dispose") -ne $null)) { $c.Dispose() }; if ($in -ne $null) { $in.Dispose() } }
+}
+
+Function Download-Cinc($md_url, $dst) {
+  $url, $md5 = Get-CincMetadata $md_url
+
+  Try {
+    Log "Downloading package from $url"
+    ($c = Make-WebClient).DownloadFile($url, $dst)
+    Log "Download complete."
+  } Finally { if ($c -ne $null) { $c.Dispose() } }
+
+  if (($dmd5 = Get-MD5Sum $dst) -eq $md5) { Log "Successfully verified $dst" }
+  else { throw "MD5 for $dst $dmd5 does not match $md5" }
+}
+
+Function Install-Cinc($msi) {
+  Log "Installing Cinc Client package $msi"
+  $p = Start-Process -FilePath "msiexec.exe" -ArgumentList "/qn /i $msi" -Passthru -Wait
+
+  if ($p.ExitCode -ne 0) { throw "msiexec was not successful. Received exit code $($p.ExitCode)" }
+
+  Remove-Item $msi -Force
+  Log "Installation complete"
+}
+
+Function Log($m) { Write-Host "       $m`n" }
+
+Function Make-WebClient {
+  $proxy = New-Object -TypeName System.Net.WebProxy
+  $proxy.Address = $env:http_proxy
+  $client = New-Object -TypeName System.Net.WebClient
+  $client.Proxy = $proxy
+  return $client
+}
+
+Function Unresolve-Path($p) {
+  if ($p -eq $null) { return $null }
+  else { return $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($p) }
+}
+
+Try {
+  $chef_omnibus_root = Unresolve-Path $chef_omnibus_root
+  $msi = Unresolve-Path $msi
+
+  if (Check-UpdateCinc $chef_omnibus_root $version) {
+    Write-Host "-----> Installing Cinc Client package ($pretty_version)`n"
+    Download-Cinc "$chef_metadata_url" $msi
+    Install-Cinc $msi
+  } else {
+    Write-Host "-----> Cinc Client package installation detected ($pretty_version)`n"
+  }
+}
+Catch {
+  Write-Error ($_ | ft -Property * | out-string) -ErrorAction Continue
+  exit 1
+}

data/support/cinc_base_install_command.sh

@@ -0,0 +1,229 @@
+tmp_stderr="/tmp/stderr";
+
+# capture_tmp_stderr SOURCE
+capture_tmp_stderr() {
+  # spool up $tmp_stderr from all the commands we called
+  if test -f "$tmp_stderr"; then
+    output="`cat $tmp_stderr`";
+    stderr_results="${stderr_results}\nSTDERR from $1:\n\n${output}\n";
+    rm $tmp_stderr;
+  fi
+}
+
+# do_curl URL FILENAME
+do_curl() {
+  echo "Trying curl...";
+  curl -sL -D "$tmp_stderr" "$1" > "$2";
+  ec=$?;
+  # check for 404
+  grep "404 Not Found" "$tmp_stderr" 2>&1 >/dev/null;
+  if test $? -eq 0; then
+    http_404_error "$1";
+  fi
+
+  # check for bad return status or empty output
+  if test $ec -ne 0 || test ! -s "$2"; then
+    capture_tmp_stderr "curl";
+    return 1;
+  else
+    echo "Download complete.";
+    return 0;
+  fi
+}
+
+# do_download URL FILENAME
+do_download() {
+  echo "Downloading ${1} to file ${2}";
+
+  exists wget;
+  if test $? -eq 0; then
+    do_wget "$1" "$2" && return 0;
+  fi
+
+  exists curl;
+  if test $? -eq 0; then
+    do_curl "$1" "$2" && return 0;
+  fi
+
+  exists fetch;
+  if test $? -eq 0; then
+    do_fetch "$1" "$2" && return 0;
+  fi
+
+  exists python;
+  if test $? -eq 0; then
+    do_python "$1" "$2" && return 0;
+  fi
+
+  exists perl;
+  if test $? -eq 0; then
+    do_perl "$1" "$2" && return 0;
+  fi
+
+  unable_to_download "$1" "$2";
+}
+
+# do_fetch URL FILENAME
+do_fetch() {
+  echo "Trying fetch...";
+  fetch -o "$2" "$1" 2>"$tmp_stderr";
+  ec=$?;
+  # check for 404
+  grep "Not Found" "$tmp_stderr" 2>&1 >/dev/null;
+  if test $? -eq 0; then
+    http_404_error "$1";
+  fi
+
+  # check for bad return status or empty output
+  if test $ec -ne 0 || test ! -s "$2"; then
+    capture_tmp_stderr "fetch";
+    return 1;
+  else
+    echo "Download complete.";
+    return 0;
+  fi
+}
+
+# do_perl URL FILENAME
+do_perl() {
+  echo "Trying perl...";
+  perl -e "use LWP::Simple; getprint(\$ARGV[0]);" "$1" > "$2" 2>"$tmp_stderr";
+  ec=$?;
+  # check for 404
+  grep "404 Not Found" "$tmp_stderr" 2>&1 >/dev/null;
+  if test $? -eq 0; then
+    http_404_error "$1";
+  fi
+
+  # check for bad return status or empty output
+  if test $ec -ne 0 || test ! -s "$2"; then
+    capture_tmp_stderr "perl";
+    return 1;
+  else
+    echo "Download complete.";
+    return 0;
+  fi
+}
+
+# do_python URL FILENAME
+do_python() {
+  echo "Trying python...";
+  python -c "import sys,urllib2 ; sys.stdout.write(urllib2.urlopen(sys.argv[1]).read())" "$1" > "$2" 2>"$tmp_stderr";
+  ec=$?;
+  # check for 404
+  grep "HTTP Error 404" "$tmp_stderr" 2>&1 >/dev/null;
+  if test $? -eq 0; then
+    http_404_error "$1";
+  fi
+
+  # check for bad return status or empty output
+  if test $ec -ne 0 || test ! -s "$2"; then
+    capture_tmp_stderr "python";
+    return 1;
+  else
+    echo "Download complete.";
+    return 0;
+  fi
+}
+
+# do_wget URL FILENAME
+do_wget() {
+  echo "Trying wget...";
+  wget -O "$2" "$1" 2>"$tmp_stderr";
+  ec=$?;
+  # check for 404
+  grep "ERROR 404" "$tmp_stderr" 2>&1 >/dev/null;
+  if test $? -eq 0; then
+    http_404_error "$1";
+  fi
+
+  # check for bad return status or empty output
+  if test $ec -ne 0 || test ! -s "$2"; then
+    capture_tmp_stderr "wget";
+    return 1;
+  else
+    echo "Download complete.";
+    return 0;
+  fi
+}
+
+# exists COMMAND
+exists() {
+  if command -v "$1" >/dev/null 2>&1; then
+    return 0;
+  else
+    return 1;
+  fi
+}
+
+# http_404_error URL
+http_404_error() {
+  echo ">>>>>> Downloading ${1} resulted in an HTTP/404, aborting";
+  exit 40;
+}
+
+# should_update_cinc ROOT VERSION
+should_update_cinc() {
+  if test ! -d "$1"; then
+    return 0;
+  elif test "$2" = "true"; then
+    return 1;
+  elif test "$2" = "latest"; then
+    return 0;
+  fi
+
+  if test -f "${1}/version-manifest.txt"; then
+    cinc_version="`head -n 1 ${1}/version-manifest.txt | cut -d \" \" -f 2`";
+  else
+    cinc_version="`${1}/bin/cinc-solo -v | cut -d \" \" -f 2`";
+  fi
+
+  echo "$cinc_version" | grep "^${2}" 2>&1 >/dev/null;
+  if test $? -eq 0; then
+    return 1;
+  else
+    echo "${2}" | grep "^$cinc_version" 2>&1 >/dev/null;
+    if test $? -eq 0; then
+      return 1;
+    else
+      return 0;
+    fi
+  fi
+}
+
+# unable_to_download URL FILE
+unable_to_download() {
+  echo "Unable to download $1 to $2, aborting";
+
+  if test "x${stderr_results}" != "x"; then
+    echo "\nDEBUG OUTPUT FOLLOWS:\n${stderr_results}";
+  fi
+
+  exit 10;
+}
+
+# main
+main() {
+  should_update_cinc "$chef_omnibus_root" "$version"
+  if test $? -eq 0; then
+    echo "-----> Installing Cinc Client package (${pretty_version})";
+
+    # solaris 10 lacks recent enough credentials, so http url is used
+    platform="`/usr/bin/uname -s 2>/dev/null`";
+    platform_version="`/usr/bin/uname -r 2>/dev/null`";
+    if test "x${platform}" = "xSunOS" && test "x${platform_version}" = "x5.10"; then
+      chef_omnibus_url=`echo "$chef_omnibus_url" | sed -e "s/https/http/"`;
+    fi
+
+    do_download "$chef_omnibus_url" /tmp/install.sh;
+    $sudo_sh /tmp/install.sh $install_flags;
+  else
+    echo "-----> Cinc Client package installation detected (${pretty_version})";
+  fi
+}
+
+# augment path in an attempt to find a download program
+PATH="${PATH}:/opt/local/bin:/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin:/usr/sfw/bin";
+export PATH;
+
+main

data/support/download_helpers.sh

@@ -0,0 +1,99 @@
+# Check whether a command exists - returns 0 if it does, 1 if it does not
+exists() {
+  if command -v $1 >/dev/null 2>&1
+  then
+    return 0
+  else
+    return 1
+  fi
+}
+
+# do_wget URL FILENAME
+do_wget() {
+  echo "trying wget..."
+  wget -O "$2" "$1" 2>/tmp/stderr
+  # check for bad return status
+  test $? -ne 0 && return 1
+  # check for 404 or empty file
+  grep "ERROR 404" /tmp/stderr 2>&1 >/dev/null
+  if test $? -eq 0 || test ! -s "$2"; then
+    return 1
+  fi
+  return 0
+}
+
+# do_curl URL FILENAME
+do_curl() {
+  echo "trying curl..."
+  curl -L "$1" > "$2"
+  # check for bad return status
+  [ $? -ne 0 ] && return 1
+  # check for bad output or empty file
+  grep "The specified key does not exist." "$2" 2>&1 >/dev/null
+  if test $? -eq 0 || test ! -s "$2"; then
+    return 1
+  fi
+  return 0
+}
+
+# do_fetch URL FILENAME
+do_fetch() {
+  echo "trying fetch..."
+  fetch -o "$2" "$1" 2>/tmp/stderr
+  # check for bad return status
+  test $? -ne 0 && return 1
+  return 0
+}
+
+# do_perl URL FILENAME
+do_perl() {
+  echo "trying perl..."
+  perl -e "use LWP::Simple; getprint($ARGV[0]);" "$1" > "$2"
+  # check for bad return status
+  test $? -ne 0 && return 1
+  return 0
+}
+
+# do_python URL FILENAME
+do_python() {
+  echo "trying python..."
+  python -c "import sys,urllib2 ; sys.stdout.write(urllib2.urlopen(sys.argv[1]).read())" "$1" > "$2"
+  # check for bad return status
+  test $? -ne 0 && return 1
+  return 0
+}
+
+# do_download URL FILENAME
+do_download() {
+  PATH=/opt/local/bin:/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
+  export PATH
+
+  echo "downloading $1"
+  echo "  to file $2"
+
+  # we try all of these until we get success.
+  # perl, in particular may be present but LWP::Simple may not be installed
+
+  if exists wget; then
+    do_wget $1 $2 && return 0
+  fi
+
+  if exists curl; then
+    do_curl $1 $2 && return 0
+  fi
+
+  if exists fetch; then
+    do_fetch $1 $2 && return 0
+  fi
+
+  if exists perl; then
+    do_perl $1 $2 && return 0
+  fi
+
+  if exists python; then
+    do_python $1 $2 && return 0
+  fi
+
+  echo ">>>>>> wget, curl, fetch, perl or python not found on this instance."
+  return 16
+}