confctl 2.2.3 → 3.0.0

data/lib/confctl/nix_legacy.rb

@@ -0,0 +1,467 @@
+require 'confctl/utils/file'
+require 'digest'
+require 'etc'
+require 'json'
+require 'securerandom'
+require 'shellwords'
+require 'tempfile'
+
+module ConfCtl
+  class NixLegacy
+    # Create a new instance without access to {ConfCtl::Settings}, i.e. when
+    # called outside of cluster configuration directory.
+    # @return [Nix]
+    def self.stateless(show_trace: false, max_jobs: 'auto')
+      new(show_trace:, max_jobs:)
+    end
+
+    include Utils::File
+
+    def initialize(conf_dir: nil, show_trace: false, max_jobs: nil, cores: nil)
+      @conf_dir = conf_dir || ConfDir.path
+      @show_trace = show_trace
+      @max_jobs = max_jobs || Settings.instance.max_jobs
+      @cores = cores
+      @cmd = SystemCommand.new
+    end
+
+    def confctl_settings
+      out_link = File.join(
+        cache_dir,
+        'build',
+        'settings.json'
+      )
+
+      with_cache(out_link) do
+        with_argument({
+          confDir: conf_dir,
+          build: :confctl
+        }) do |arg|
+          cmd_args = [
+            'nix-build',
+            '--arg', 'jsonArg', arg,
+            '--out-link', out_link,
+            (show_trace ? '--show-trace' : nil),
+            (max_jobs ? ['--max-jobs', max_jobs.to_s] : nil),
+            (cores ? ['--cores', cores.to_s] : nil),
+            ConfCtl.nix_asset('evaluator.nix')
+          ].flatten.compact
+
+          cmd.run(*cmd_args)
+        end
+      end
+
+      demodulify(JSON.parse(File.read(out_link))['confctl'])
+    end
+
+    # Returns an array with options from all confctl modules
+    # @return [Array]
+    def module_options
+      options = nix_instantiate({
+        confDir: conf_dir,
+        build: :moduleOptions
+      })
+    end
+
+    # Returns an array with machine fqdns
+    # @return [Array<String>]
+    def list_machine_fqdns
+      nix_instantiate({
+        confDir: conf_dir,
+        build: :list
+      })['machines']
+    end
+
+    # Return machines and their config in a hash
+    # @return [Hash]
+    def list_machines
+      out_link = File.join(
+        cache_dir,
+        'build',
+        'machine-list.json'
+      )
+
+      with_cache(out_link) do
+        with_argument({
+          confDir: conf_dir,
+          build: :info
+        }, core_swpins: true) do |arg|
+          cmd_args = [
+            'nix-build',
+            '--arg', 'jsonArg', arg,
+            '--out-link', out_link,
+            (show_trace ? '--show-trace' : nil),
+            (max_jobs ? ['--max-jobs', max_jobs.to_s] : nil),
+            (cores ? ['--cores', cores.to_s] : nil),
+            ConfCtl.nix_asset('evaluator.nix')
+          ].flatten.compact
+
+          cmd.run(*cmd_args)
+        end
+      end
+
+      demodulify(JSON.parse(File.read(out_link)))
+    end
+
+    def list_swpins_channels
+      nix_instantiate({
+        confDir: conf_dir,
+        build: :listSwpinsChannels
+      })
+    end
+
+    # Evaluate swpins for host
+    # @return [Hash]
+    def eval_core_swpins
+      with_argument({
+        confDir: conf_dir,
+        build: :evalCoreSwpins
+      }) do |arg|
+        out_link = File.join(
+          cache_dir,
+          'build',
+          'core.swpins'
+        )
+
+        cmd_args = [
+          'nix-build',
+          '--arg', 'jsonArg', arg,
+          '--out-link', out_link,
+          (show_trace ? '--show-trace' : nil),
+          (max_jobs ? ['--max-jobs', max_jobs.to_s] : nil),
+          (cores ? ['--cores', cores.to_s] : nil),
+          ConfCtl.nix_asset('evaluator.nix')
+        ].flatten.compact
+
+        out, = cmd.run(*cmd_args).stdout
+
+        JSON.parse(File.read(out.strip))
+      end
+    end
+
+    # Evaluate swpins for hosts
+    # @param hosts [Array<String>]
+    # @return [Hash] host => swpins
+    def eval_host_swpins(hosts)
+      with_argument({
+        confDir: conf_dir,
+        build: :evalHostSwpins,
+        machines: hosts
+      }, core_swpins: true) do |arg|
+        out_link = File.join(
+          cache_dir,
+          'build',
+          "#{Digest::SHA256.hexdigest(hosts.join(','))[0..11]}.swpins"
+        )
+
+        cmd_args = [
+          'nix-build',
+          '--arg', 'jsonArg', arg,
+          '--out-link', out_link,
+          (show_trace ? '--show-trace' : nil),
+          (max_jobs ? ['--max-jobs', max_jobs.to_s] : nil),
+          (cores ? ['--cores', cores.to_s] : nil),
+          ConfCtl.nix_asset('evaluator.nix')
+        ].flatten.compact
+
+        out, = cmd.run(*cmd_args)
+
+        JSON.parse(File.read(out.strip))
+      end
+    end
+
+    def eval_inputs_info(_host)
+      raise Error, 'inputs info is available only in flake configs'
+    end
+
+    def eval_inputs(_host)
+      raise Error, 'inputs are available only in flake configs'
+    end
+
+    def eval_json(_installable)
+      raise Error, 'nix eval is available only in flake configs'
+    end
+
+    # Build config.system.build.toplevel for selected hosts
+    #
+    # @param hosts [Array<Machine>]
+    # @param swpin_paths [Hash]
+    # @param host_swpin_specs [Hash]
+    # @param time [Time]
+    #
+    # @yieldparam type [:build, :fetch]
+    # @yieldparam progress [Integer]
+    # @yieldparam total [Integer]
+    # @yieldparam path [String]
+    #
+    # @return [Hash<String, Generation::Build>]
+    def build_attributes(hosts: [], swpin_paths: {}, host_swpin_specs: {}, time: nil, &block)
+      with_argument({
+        confDir: conf_dir,
+        build: :toplevel,
+        machines: hosts
+      }) do |arg|
+        time ||= Time.now
+        ret_generations = {}
+        out_link = File.join(cache_dir, 'build', "#{SecureRandom.hex(4)}.build")
+
+        cmd_args = [
+          '--arg', 'jsonArg', arg,
+          '--out-link', out_link,
+          (show_trace ? '--show-trace' : nil),
+          (max_jobs ? ['--max-jobs', max_jobs.to_s] : nil),
+          (cores ? ['--cores', cores.to_s] : nil),
+          ConfCtl.nix_asset('evaluator.nix')
+        ].flatten.compact
+
+        nb = NixBuild.new(cmd_args, swpin_paths)
+        nb.run(&block)
+
+        begin
+          host_results = JSON.parse(File.read(out_link))
+          host_results.each do |host, result|
+            host_generations = Generation::BuildList.new(host)
+            generation = host_generations.find(result['attribute'], swpin_paths)
+
+            if generation.nil?
+              generation = Generation::Build.new(host)
+              generation.create(
+                result['attribute'],
+                result['autoRollback'],
+                swpin_paths,
+                host_swpin_specs[host],
+                date: time
+              )
+              generation.save
+            end
+
+            host_generations.current = generation
+            ret_generations[host] = generation
+          end
+        ensure
+          unlink_if_exists(out_link)
+        end
+
+        ret_generations
+      end
+    end
+
+    # @param machine [Machine]
+    # @param paths [Array<String>]
+    #
+    # @yieldparam progress [Integer]
+    # @yieldparam total [Integer]
+    # @yieldparam path [String]
+    #
+    # @return [Boolean]
+    def copy(machine, paths, &)
+      if machine.localhost?
+        true
+      elsif machine.carried?
+        carrier = machine.carrier_machine
+        cp = NixCopy.new(carrier.target_host, paths, port: carrier.target_port)
+        cp.run!(&).success?
+      else
+        cp = NixCopy.new(machine.target_host, paths, port: machine.target_port)
+        cp.run!(&).success?
+      end
+    end
+
+    # @param machine [Machine]
+    # @param generation [Generation::Build]
+    # @param action [String]
+    # @return [Boolean]
+    def activate(machine, generation, action)
+      args = [File.join(generation.toplevel, 'bin/switch-to-configuration'), action]
+
+      MachineControl.new(machine).execute!(*args).success?
+    end
+
+    # @param machine [Machine]
+    # @param generation [Generation::Build]
+    # @param action [String]
+    # @return [Boolean]
+    def activate_with_rollback(machine, generation, action)
+      check_file = File.join('/run', "confctl-confirm-#{SecureRandom.hex(3)}")
+      timeout = machine['autoRollback']['timeout']
+      logger = NullLogger.new
+
+      args = [
+        generation.auto_rollback,
+        '-t', timeout,
+        generation.toplevel,
+        action,
+        check_file
+      ]
+
+      activation_success = nil
+
+      activation_thread = Thread.new do
+        activation_success = MachineControl.new(machine).execute!(*args).success?
+      end
+
+      # Wait for the configuration to be switched
+      t = Time.now
+      mc = MachineControl.new(machine, logger:)
+
+      loop do
+        out, = mc.execute!('sh', '-c', "cat #{Shellwords.escape(check_file)} 2>/dev/null")
+        stripped = out.strip
+        break if stripped == 'switched' || ((t + timeout + 10) < Time.now && stripped != 'switching')
+
+        sleep(1)
+      end
+
+      # Confirm it
+      confirm_cmd = ['sh', '-c', "echo confirmed > #{Shellwords.escape(check_file)}"]
+
+      10.times do
+        break if mc.execute!(*confirm_cmd).success?
+      end
+
+      activation_thread.join
+      activation_success
+    end
+
+    # @param machine [Machine]
+    # @param toplevel [String]
+    # @return [Boolean]
+    def set_profile(machine, toplevel)
+      args = [
+        'nix-env',
+        '-p', machine.profile,
+        '--set', toplevel
+      ]
+
+      MachineControl.new(machine).execute!(*args).success?
+    end
+
+    # @param machine [Machine]
+    # @param toplevel [String]
+    # @return [Boolean]
+    def set_carried_profile(machine, toplevel)
+      args = [
+        'carrier-env',
+        '-p', machine.profile,
+        '--set', toplevel
+      ]
+
+      MachineControl.new(machine.carrier_machine).execute!(*args).success?
+    end
+
+    # @param packages [Array<String>]
+    # @param command [String]
+    # @return [Boolean]
+    def run_command_in_shell(packages: [], command: nil)
+      args = ['nix-shell']
+
+      if packages.any?
+        args << '-p'
+        args.concat(packages)
+      end
+
+      args << '--command'
+      args << command
+
+      cmd.run!(*args, env: { 'shellHook' => nil }).success?
+    end
+
+    # @param machine [Machine]
+    # @yieldparam progress [NixCollectGarbage::Progress]
+    # @return [Boolean]
+    def collect_garbage(machine, &)
+      gc = NixCollectGarbage.new(machine)
+      gc.run!(&).success?
+    end
+
+    protected
+
+    attr_reader :conf_dir, :show_trace, :max_jobs, :cores, :cmd
+
+    # Execute block only if `out_link` does not exist or conf dir has changed
+    # @param out_link [String] out link path
+    def with_cache(out_link)
+      unchanged = false
+
+      if File.exist?(out_link)
+        unchanged = ConfDir.unchanged?
+
+        if unchanged
+          cache_mtime = ConfDir.state_mtime
+
+          if cache_mtime
+            begin
+              st = File.lstat(out_link)
+            rescue Errno::ENOENT
+              # pass
+            else
+              if st.mtime > cache_mtime
+                Logger.instance << "Using #{out_link}\n"
+                return
+              end
+            end
+          end
+        end
+      end
+
+      Logger.instance << "Building #{out_link}\n"
+
+      unless unchanged
+        Logger.instance << "Updating configuration cache\n"
+        ConfDir.update_state
+      end
+      yield
+    end
+
+    # @param hash [Hash]
+    # @param core_swpins [Boolean]
+    # @yieldparam file [String]
+    def with_argument(hash, core_swpins: false)
+      if core_swpins
+        paths = Swpins::Core.get.pre_evaluated_store_paths
+        hash[:coreSwpins] = paths if paths
+      end
+
+      f = Tempfile.new('confctl')
+      f.puts(hash.to_json)
+      f.close
+      yield(f.path)
+    ensure
+      f.unlink
+    end
+
+    def nix_instantiate(hash, **opts)
+      with_argument(hash, **opts) do |arg|
+        cmd_args = [
+          'nix-instantiate',
+          '--eval',
+          '--json',
+          '--strict',
+          '--read-write-mode',
+          '--arg', 'jsonArg', arg,
+          (show_trace ? '--show-trace' : nil),
+          (max_jobs ? ['--max-jobs', max_jobs.to_s] : nil),
+          (cores ? ['--cores', cores.to_s] : nil),
+          ConfCtl.nix_asset('evaluator.nix')
+        ].flatten.compact
+
+        out, = cmd.run(*cmd_args).stdout
+
+        demodulify(JSON.parse(out))
+      end
+    end
+
+    def demodulify(value)
+      if value.is_a?(Array)
+        value.each { |item| demodulify(item) }
+      elsif value.is_a?(Hash)
+        value.delete('_module')
+        value.each_value { |v| demodulify(v) }
+      end
+    end
+
+    def cache_dir
+      ConfDir.cache_dir
+    end
+  end
+end

data/lib/confctl/swpins/change_set.rb

@@ -1,10 +1,12 @@
+require 'pathname'
+
 module ConfCtl
   class Swpins::ChangeSet
     class SpecOwner
       attr_reader :name, :path
     end
 
-    SpecSet = Struct.new(:spec, :original_version, :original_info, keyword_init: true) do
+    SpecSet = Struct.new(:spec, :original_version, :original_info) do
       def name
         spec.name
       end
@@ -52,6 +54,16 @@ module ConfCtl
     def commit(type: :upgrade, changelog: false, editor: true)
       return if @owners.empty?
 
+      git_add = [
+        'git',
+        'add',
+        *changed_files
+      ]
+
+      unless Kernel.system(*git_add)
+        raise 'git add exited with non-zero status code'
+      end
+
       git_commit = [
         'git',
         'commit',
@@ -135,7 +147,17 @@ module ConfCtl
     end
 
     def changed_files
-      @owners.each_key.map(&:path)
+      root_path = Pathname.new(ConfCtl::ConfDir.path)
+
+      @owners.each_key.map do |owner|
+        owner_path = Pathname.new(owner.path)
+
+        if owner_path.absolute?
+          owner_path.relative_path_from(root_path).to_s
+        else
+          owner.path
+        end
+      end
     end
 
     def same_changes?

data/lib/confctl/swpins/specs/base.rb

@@ -129,8 +129,8 @@ module ConfCtl
       ret
     end
 
-    def to_json(*args)
-      as_json.to_json(*args)
+    def to_json(*)
+      as_json.to_json(*)
     end
 
     protected

data/lib/confctl/ui.rb

@@ -0,0 +1,19 @@
+module ConfCtl
+  module Ui
+    module_function
+
+    # Return true when interactive TTY UI features should be enabled.
+    #
+    # Set CONFCTL_TTY=0 to force non-interactive output.
+    def tty?
+      return false if ENV['CONFCTL_TTY'] == '0'
+
+      $stdout.tty? && $stderr.tty?
+    end
+
+    def no_color?
+      v = ENV.fetch('NO_COLOR', nil)
+      !v.nil? && !v.strip.empty?
+    end
+  end
+end

data/lib/confctl/version.rb

@@ -1,3 +1,3 @@
 module ConfCtl
-  VERSION = '2.2.3'.freeze
+  VERSION = '3.0.0'.freeze
 end

data/man/index.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8" />
+  <meta name="generator" content="md2man 5.1.2 https://github.com/sunaku/md2man" />
+  <title>man/index &mdash; release-source</title>
+  <link rel="stylesheet" href="style.css"/>
+  <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
+</head>
+<body><div class="container-fluid"><h2 id="man8">man8</h2><dl class="dl-horizontal"><dt><a href="man8/confctl.8.html">confctl(8)</a></dt><dd>Nix deployment management tool</dd></dl><dl class="dl-horizontal"><dt><a href="man8/confctl-options.nix.8.html">confctl-options(nix.8)</a></dt><dd>confctl configuration documentation</dd></dl></div></body>
+</html>