kozo 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6f328c53f7a4a3c079a6b01da46e6d669b7a5671b9d145dd28ac0bb9849a214
-  data.tar.gz: 7ee031a2ed77304366d4f4d6d6cbfb9ef9525018b54fc89d0109c0da358f84c9
+  metadata.gz: 4aac9ed1535bda5369fd59e0b853cdad3c4c1415b9a386950bf6814fd7ad23aa
+  data.tar.gz: 4194c01bdd53178ed6efd4dc9d707a3e5e750c448b8e28c8093f1206969535d6
 SHA512:
-  metadata.gz: 70a8837f4076eb87771371397f95ca43e73d07f7105b23095214f3f89f5ac85db234b8c4f2407e0f3d9671e2ed10d68fbb5f4cd9d27356248cfdf86fb0a693dd
-  data.tar.gz: 1b8d14f8bceaae53776d94db21e7651b5b65fe88074e0297175067c04941e2dc57618640993795945eb82235d686fe93f31ef714adc1f0fd659ee82ec612db68
+  metadata.gz: 3c41bce3880883e545ae7550cdbabdfcdff122907980afd6be61c1e951ed38e43f7414ae785f64e4d418509a92d3d6481a101c744baa13d92e6091acc9265d98
+  data.tar.gz: b671195833c085efbf3386d9a94810bb0e2360d02228586ef6c7dd27002fde12820983d635c253105e669ba45220cfd18104462184c187da41426879a3fed497

data/.gitignore

@@ -72,3 +72,5 @@ build-iPhoneSimulator/
 ### Kozo ###
 *.kz
 *.kzstate
+*.kzbackup
+cloud-init.yml

data/CHANGELOG.md

@@ -1,10 +1,22 @@
 # Changelog
 
-## Kozo v0.1.0
+All notable changes to this project will be documented in this file.
 
-Initial release
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## Kozo v0.2.0
+## [Unreleased]
+
+## [0.3.0] - 2022-02-13
+
+- Add dependencies between resources
+- Show old and new attribute values in execution plan
+
+## [0.2.0] - 2021-12-02
 
 - Add SSH Key and Server resource
 - Update only changed attributes
+
+## [0.1.0] - 2020-12-23
+
+Initial release.

data/Gemfile

@@ -4,8 +4,6 @@ source "https://rubygems.org"
 
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby "~> 3.0"
+ruby "~> 3.1"
 
 gemspec
-
-gem "hcloud", github: "floriandejonckheere/hcloud"

data/Gemfile.lock

@@ -1,36 +1,25 @@
-GIT
-  remote: https://github.com/floriandejonckheere/hcloud.git
-  revision: c2ef9116c0f696ded8a8e91aba15820481a74936
-  specs:
-    hcloud (1.0.0)
-      activemodel
-      activesupport
-      http
-      zeitwerk
-
 PATH
   remote: .
   specs:
-    kozo (0.2.0)
-      activemodel (~> 6.0)
-      activesupport (~> 6.0)
+    kozo (0.3.0)
+      activesupport (>= 6.0, < 7.1)
       colorize (~> 0.8)
       dinja (~> 2.0)
       dotenv (~> 2.7)
       git (~> 1.9)
+      hetznercloud (~> 1.3)
       zeitwerk (~> 2.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.4.1)
-      activesupport (= 6.1.4.1)
-    activesupport (6.1.4.1)
+    activemodel (7.0.2.2)
+      activesupport (= 7.0.2.2)
+    activesupport (7.0.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
@@ -44,7 +33,7 @@ GEM
     concurrent-ruby (1.1.9)
     crack (0.4.5)
       rexml
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
     dinja (2.0.0)
       zeitwerk
     docile (1.4.0)
@@ -57,16 +46,21 @@ GEM
     eventmachine (1.2.7)
     factory_bot (6.2.0)
       activesupport (>= 5.0.0)
-    fakefs (1.4.0)
+    fakefs (1.4.1)
     ffaker (2.20.0)
-    ffi (1.15.4)
+    ffi (1.15.5)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
     forwardable-extended (2.6.0)
-    git (1.9.1)
+    git (1.10.2)
       rchardet (~> 1.8)
     hashdiff (1.0.1)
+    hetznercloud (1.3.1)
+      activemodel
+      activesupport
+      http
+      zeitwerk
     http (5.0.4)
       addressable (~> 2.8)
       http-cookie (~> 1.0)
@@ -76,7 +70,7 @@ GEM
       domain_name (~> 0.5)
     http-form_data (2.3.0)
     http_parser.rb (0.8.0)
-    i18n (1.8.11)
+    i18n (1.9.1)
       concurrent-ruby (~> 1.0)
     iniparse (1.5.0)
     jekyll (4.2.1)
@@ -103,7 +97,7 @@ GEM
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     liquid (4.0.3)
-    listen (3.7.0)
+    listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     llhttp-ffi (0.4.0)
@@ -111,14 +105,14 @@ GEM
       rake (~> 13.0)
     mercenary (0.4.0)
     method_source (1.0.0)
-    minitest (5.14.4)
+    minitest (5.15.0)
     optimist (3.0.1)
     overcommit (0.58.0)
       childprocess (>= 0.6.3, < 5)
       iniparse (~> 1.4)
       rexml (~> 3.2)
     parallel (1.21.0)
-    parser (3.0.3.0)
+    parser (3.1.0.0)
       ast (~> 2.4.1)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
@@ -131,51 +125,51 @@ GEM
       byebug (~> 11.0)
       pry (~> 0.13.0)
     public_suffix (4.0.6)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
-    rb-fsevent (0.11.0)
+    rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rchardet (1.8.0)
-    regexp_parser (2.1.1)
+    regexp_parser (2.2.1)
     rexml (3.2.5)
-    rouge (3.26.1)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rouge (3.28.0)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    rubocop (1.23.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.25.1)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.13.0)
+    rubocop-ast (1.15.2)
       parser (>= 3.0.1.1)
-    rubocop-performance (1.12.0)
+    rubocop-performance (1.13.2)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.6.0)
+    rubocop-rspec (2.8.0)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     safe_yaml (1.0.5)
     sassc (2.4.0)
       ffi (~> 1.9)
-    shoulda-matchers (5.0.0)
+    shoulda-matchers (5.1.0)
       activesupport (>= 5.2.0)
     simplecov (0.21.2)
       docile (~> 1.1)
@@ -200,7 +194,7 @@ GEM
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.5.1)
+    zeitwerk (2.5.4)
 
 PLATFORMS
   ruby
@@ -210,7 +204,6 @@ DEPENDENCIES
   factory_bot
   fakefs
   ffaker
-  hcloud!
   jekyll
   kozo!
   overcommit
@@ -228,7 +221,7 @@ DEPENDENCIES
   webmock
 
 RUBY VERSION
-   ruby 3.0.0p0
+   ruby 3.1.0p0
 
 BUNDLED WITH
-   2.2.22
+   2.3.6

data/README.md

@@ -6,6 +6,8 @@
 _Kōzō_ (構造) is an open-source tool to manage your cloud resources based on the [infrastructure as code](https://en.wikipedia.org/wiki/Infrastructure_as_code) principle.
 It leverages the power of [Ruby](https://www.ruby-lang.org/en/) to allow you to declare your infrastructure in your favourite language.
 
+Read more about the project on [kozo.dev](https://kozo.dev).
+
 ## Installation
 
 Install the gem using your operating system's package manager, or using RubyGems:

data/kozo.gemspec

@@ -29,12 +29,12 @@ Gem::Specification.new do |spec|
     "rubygems_mfa_required" => "true",
   }
 
-  spec.add_runtime_dependency "activemodel", "~> 6.0"
-  spec.add_runtime_dependency "activesupport", "~> 6.0"
+  spec.add_runtime_dependency "activesupport", ">= 6.0", "< 7.1"
   spec.add_runtime_dependency "colorize", "~> 0.8"
   spec.add_runtime_dependency "dinja", "~> 2.0"
   spec.add_runtime_dependency "dotenv", "~> 2.7"
   spec.add_runtime_dependency "git", "~> 1.9"
+  spec.add_runtime_dependency "hetznercloud", "~> 1.3"
   spec.add_runtime_dependency "zeitwerk", "~> 2.4"
 
   spec.add_development_dependency "rubocop"

data/lib/core_ext/boolean.rb

@@ -5,6 +5,14 @@ module CoreExt
     def to_b
       self
     end
+
+    def as_h
+      self
+    end
+
+    def as_s
+      to_s
+    end
   end
 end
 

data/lib/core_ext/date.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CoreExt
+  module Date
+    def as_h
+      iso8601
+    end
+
+    def as_s
+      iso8601
+    end
+  end
+end
+
+Date.prepend CoreExt::Date

data/lib/core_ext/enumerable.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CoreExt
+  module Enumerable
+    def intersperse(value)
+      flat_map { |h| [h, value] }.tap(&:pop)
+    end
+
+    def as_h
+      map(&:as_h)
+    end
+
+    def as_s
+      return "[]" if empty?
+
+      map { |k| "  #{k.as_s}" }
+        .intersperse(",")
+        .each_slice(2)
+        .map(&:join)
+        .prepend("[")
+        .append("]")
+        .join("\n")
+    end
+  end
+end
+
+Enumerable.prepend CoreExt::Enumerable

data/lib/core_ext/float.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CoreExt
+  module Float
+    def as_h
+      self
+    end
+
+    def as_s
+      to_s
+    end
+  end
+end
+
+Float.prepend CoreExt::Float

data/lib/core_ext/hash.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CoreExt
+  module Hash
+    def as_h
+      transform_values(&:as_h)
+    end
+
+    def as_s
+      return "{}" if empty?
+
+      map { |k, v| "  #{k} = #{v.as_s}" }
+        .intersperse(",")
+        .each_slice(2)
+        .map(&:join)
+        .prepend("{")
+        .append("}")
+        .join("\n")
+    end
+  end
+end
+
+Hash.prepend CoreExt::Hash

data/lib/core_ext/integer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CoreExt
+  module Integer
+    def as_h
+      self
+    end
+
+    def as_s
+      to_s
+    end
+  end
+end
+
+Integer.prepend CoreExt::Integer

data/lib/core_ext/nil_class.rb

@@ -5,6 +5,14 @@ module CoreExt
     def to_b
       self
     end
+
+    def as_h
+      self
+    end
+
+    def as_s
+      "nil"
+    end
   end
 end
 

data/lib/core_ext/string.rb

@@ -16,9 +16,20 @@ module CoreExt
     ].freeze
     # rubocop:enable Lint/BooleanSymbol
 
+    # Maximum number of characters displayed
+    LENGTH = 75
+
     def to_b
       self == "" ? nil : FALSE_VALUES.exclude?(self)
     end
+
+    def as_h
+      self
+    end
+
+    def as_s
+      "\"#{chomp.tr("\n", ' ').truncate(LENGTH)}\""
+    end
   end
 end
 

data/lib/core_ext/symbol.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CoreExt
+  module Symbol
+    delegate :as_h,
+             :as_s,
+             to: :to_s
+  end
+end
+
+Symbol.prepend CoreExt::Symbol

data/lib/core_ext/time.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module CoreExt
+  module Time
+    def as_h
+      iso8601
+    end
+
+    def as_s
+      iso8601
+    end
+  end
+end
+
+Time.prepend CoreExt::Time
+ActiveSupport::TimeWithZone.prepend CoreExt::Time

data/lib/kozo/backend.rb

@@ -9,9 +9,9 @@ module Kozo
       @directory = directory
     end
 
-    def state
+    def state(verify: true)
       @state ||= State
-        .new(resources)
+        .new(resources, data[:version], verify: verify)
     end
 
     def state=(value)
@@ -20,17 +20,6 @@ module Kozo
       self.data = value.to_h
     end
 
-    def validate!
-      state_version = data.fetch(:version)
-      kozo_version = data.fetch(:kozo_version)
-
-      raise StateError, "invalid version in state: got #{state_version}, expected #{State::VERSION}" unless state_version == State::VERSION
-
-      return if kozo_version == Kozo::VERSION
-
-      raise StateError, "invalid kozo version in state: got #{kozo_version}, expected #{Kozo::VERSION}"
-    end
-
     ##
     # Create necessary backend files/structures if they do not exist
     #

data/lib/kozo/backends/git.rb

@@ -21,7 +21,7 @@ module Kozo
       end
 
       def data=(value)
-        super
+        return unless super
 
         git.add(file)
         git.commit("Update Kozo resource state")

data/lib/kozo/backends/local.rb

@@ -8,6 +8,7 @@ module Kozo
     class Local < Kozo::Backend
       attr_writer :file
       attr_accessor :backups
+      attr_reader :fingerprint
 
       def initialize(configuration, directory)
         super
@@ -28,7 +29,7 @@ module Kozo
         Kozo.logger.debug "Reading local state in #{path}"
 
         YAML
-          .safe_load(File.read(path), [Time, Date])
+          .safe_load(File.read(path), permitted_classes: [Time, Date])
           .deep_symbolize_keys
       rescue Errno::ENOENT, Errno::ENOTDIR
         raise StateError, "local state at #{path} not initialized"
@@ -39,13 +40,20 @@ module Kozo
       def data=(value)
         Kozo.logger.debug "Writing local state in #{path}"
 
+        return if @data.hash == value.hash
+
         @data = value
 
+        return if Kozo.options.dry_run?
+
+        # Write local state to temporary file
+        File.write("#{path}.tmp", value.deep_stringify_keys.to_yaml)
+
         # Write backup state file
-        FileUtils.mv(path, "#{path}.#{DateTime.current.to_i}.kzbackup") if backups
+        FileUtils.mv(path, "#{path}.#{DateTime.current.to_i}.kzbackup") if backups && File.exist?(path)
 
-        # Write local state file
-        File.write(path, value.deep_stringify_keys.to_yaml)
+        # Move temporary file to local state file
+        FileUtils.mv("#{path}.tmp", path)
       end
 
       def file

data/lib/kozo/cli.rb

@@ -12,6 +12,8 @@ module Kozo
         o.on("Global options:")
         o.on("-d", "--directory=DIRECTORY", "Set working directory")
         o.on("-v", "--verbose", "Turn on verbose logging")
+        o.on("-D", "--debug", "Turn on debug logging")
+        o.on("-n", "--dry_run", "Dry run all operations")
         o.on("-h", "--help", "Display this message") { usage }
         o.separator("\n")
         o.on("Commands:")
@@ -51,8 +53,14 @@ module Kozo
 
       raise UsageError, "unknown command: #{command}" unless klass
 
+      configuration = Parser
+        .new(Kozo.options.directory)
+        .call
+
+      Kozo.logger.info "Dry running all operations" if Kozo.options.dry_run?
+
       klass
-        .new(*command_args)
+        .new(configuration, *command_args)
         .start
     rescue UsageError => e
       # Don't print tail if no message was passed
@@ -73,11 +81,11 @@ module Kozo
     end
 
     def commands
-      Command.subclasses.sort_by(&:name).map do |k|
+      Command.descendants.select { |d| d.module_parent == Commands }.sort_by(&:name).map do |k|
         [
           k.name.demodulize.underscore,
           k.description,
-          k.descendants.sort_by(&:name).map { |s| [s.name.demodulize.underscore, s.description] },
+          k.constants.sort_by(&:name).map { |s| [s.to_s.underscore, k.const_get(s).description] },
         ]
       end
     end

data/lib/kozo/command.rb

@@ -5,9 +5,10 @@ module Kozo
     class_attribute :description
 
     attr_reader :args
-    attr_writer :state, :configuration
+    attr_accessor :configuration
 
-    def initialize(*args)
+    def initialize(configuration, *args)
+      @configuration = configuration
       @args = args
     end
 
@@ -15,18 +16,8 @@ module Kozo
       raise NotImplementedError
     end
 
-    protected
-
-    def configuration
-      @configuration ||= Parser
-        .new(Kozo.options.directory)
-        .call
-    end
-
-    def state
-      @state ||= configuration
-        .backend
-        .state
-    end
+    delegate :state,
+             :changes,
+             to: :configuration
   end
 end

data/lib/kozo/commands/apply.rb

@@ -7,8 +7,8 @@ module Kozo
 
       attr_reader :parser, :options
 
-      def initialize(*args)
-        super()
+      def initialize(configuration, *args)
+        super(configuration)
 
         @options = {
           yes: false,

data/lib/kozo/commands/import.rb

@@ -7,7 +7,9 @@ module Kozo
 
       attr_reader :address, :id
 
-      def initialize(*args)
+      def initialize(configuration, *args)
+        super(configuration)
+
         address = args.shift
 
         raise UsageError, "address not specified" unless address
@@ -30,7 +32,7 @@ module Kozo
 
         # Set ID and fetch attributes
         resource
-          .tap { |r| r.id = id }
+          .tap { |r| r.send(:id=, id) }
           .refresh!
 
         # Add or replace resource to in-memory state