serverkit 0.4.9 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b8c984c3c718fe947082f6f4d09ae7a22ff289e
-  data.tar.gz: a3e1fdf09683e2a563be79a689558245de424532
+  metadata.gz: 8a305e729177502f64c869b2629dd30acfad21ae
+  data.tar.gz: 712936e178cf102fd9725046027f9cb7e96d7fca
 SHA512:
-  metadata.gz: 9ec23d869a2e19605833366e7fb211f5aeb1d60342350e8173c5160a9055329e2f8437d1ea334902a9bef239ebf7cd02a3466543e688b37de4f32b42b796494a
-  data.tar.gz: 2e8a2d2e52e428de9cab8071e3aa74a7be137bac4216559b3faff5156328f862cba039c295cda6d0e037a68f0aee0caf64895d0604414b4b9d1dca578c41a803
+  metadata.gz: c1618d46d882bec5251d762b954341f326fb94aaba997bff66e3358306b5da5392c7a4d9714bd45d6a4bd93bf7fbc3b255a132995822954b2cbb5e7d40f2a1d2
+  data.tar.gz: b27a2c2ee0062256bcfea32e61658e0a5a8eb912e01d30bb0573165f0ef69afdc76c58ffd7192a51c9c3d6617b2eb5fca1518ec964c3b35684fa9baf9c5c9d56

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.5.0
+- Add validation_script attribute on line resource
+
 ## 0.4.9
 - Add insert_after, insert_before, and pattern attributes on line resource
 - Rescue YAML parse error on recipe loading phase

data/example/recipe.yml

@@ -14,4 +14,8 @@ resources:
     mode: 0700
   - type: line
     path: /etc/sudoers
-    line: "#includedir /etc/sudoers.d"
+    pattern: '%wheel +ALL=\(ALL\) ALL'
+    line: "%wheel ALL=(ALL) ALL"
+    insert_before: "^#includedir"
+    validation_script: visudo -cf %{path}
+    state: absent

data/lib/regexp_validator.rb

@@ -0,0 +1,11 @@
+require "active_model"
+
+class RegexpValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    unless value.nil?
+      Regexp.new(value)
+    end
+  rescue RegexpError
+    record.errors.add(attribute, "is invalid regexp expression #{value.inspect}")
+  end
+end

data/lib/serverkit/resources/base.rb

@@ -2,6 +2,7 @@ require "active_model"
 require "active_model/errors"
 require "active_support/core_ext/module/delegation"
 require "readable_validator"
+require "regexp_validator"
 require "required_validator"
 require "serverkit/errors/attribute_validation_error"
 require "type_validator"
@@ -145,12 +146,40 @@ module Serverkit
         end
       end
 
+      # Create temp file on remote side with given content
+      # @param [String] content
+      # @return [String] Path to remote temp file
+      def create_remote_temp_file(content)
+        make_remote_temp_path.tap do |path|
+          update_remote_file_content(content: content, path: path)
+        end
+      end
+
       # @note For override
       # @return [String]
       def default_id
         required_values.join(" ")
       end
 
+      # @note GNU mktemp doesn't require -t option, but BSD mktemp does
+      # @return [String]
+      def make_remote_temp_path
+        run_command("mktemp -u 2>/dev/null || mktemp -u -t tmp").stdout.rstrip
+      end
+
+      # @note "metadata" meens a set of group, mode, and owner
+      # @param [String] destination
+      # @param [String] source
+      def move_remote_file_keeping_destination_metadata(source, destination)
+        group = run_command_from_identifier(:get_file_owner_group, destination).stdout.rstrip
+        mode = run_command_from_identifier(:get_file_mode, destination).stdout.rstrip
+        owner = run_command_from_identifier(:get_file_owner_user, destination).stdout.rstrip
+        run_command_from_identifier(:change_file_group, source, group) unless group.empty?
+        run_command_from_identifier(:change_file_mode, source, mode) unless mode.empty?
+        run_command_from_identifier(:change_file_owner, source, owner) unless owner.empty?
+        run_command_from_identifier(:move_file, source, destination)
+      end
+
       # @note For override
       # @return [true, false]
       def recheck
@@ -188,9 +217,9 @@ module Serverkit
         mode = run_command_from_identifier(:get_file_mode, path).stdout.rstrip
         owner = run_command_from_identifier(:get_file_owner_user, path).stdout.rstrip
         create_remote_file(content: content, path: path)
-        run_command_from_identifier(:change_file_group, path, group)
-        run_command_from_identifier(:change_file_mode, path, mode)
-        run_command_from_identifier(:change_file_owner, path, owner)
+        run_command_from_identifier(:change_file_group, path, group) unless group.empty?
+        run_command_from_identifier(:change_file_mode, path, mode) unless mode.empty?
+        run_command_from_identifier(:change_file_owner, path, owner) unless owner.empty?
       end
     end
   end

data/lib/serverkit/resources/line.rb

@@ -14,16 +14,18 @@ module Serverkit
       attribute :insert_after, type: String
       attribute :insert_before, type: String
       attribute :line, required: true, type: String
-      attribute :pattern, type: String
+      attribute :pattern, regexp: true, type: String
       attribute :state, default: DEFAULT_STATE, inclusion: %w[absent present], type: String
+      attribute :validation_script, type: String
 
       # @note Override
       def apply
         if has_correct_file?
-          update_remote_file_content(
-            content: applied_remote_file_content,
-            path: path,
-          )
+          if validation_script
+            update_remote_file_content_with_validation
+          else
+            update_remote_file_content_without_validation
+          end
         end
       end
 
@@ -89,6 +91,22 @@ module Serverkit
         state == "present"
       end
 
+      # Create a new temp file on remote side, then validate it with given script,
+      # and move it to right file path if it succeeded. Note that `%{path}` in validation
+      # script will be replaced with the path to temp file.
+      def update_remote_file_content_with_validation
+        temp_path = create_remote_temp_file(applied_remote_file_content)
+        if check_command(format(validation_script, path: temp_path))
+          move_remote_file_keeping_destination_metadata(temp_path, path)
+        end
+        run_command_from_identifier(:remove_file, temp_path)
+      end
+
+      # Create or update remote file
+      def update_remote_file_content_without_validation
+        update_remote_file_content(content: applied_remote_file_content, path: path)
+      end
+
       # Wrapper class to easily manage lines in remote file content.
       class Content
         # @param [String] raw
@@ -105,7 +123,7 @@ module Serverkit
         # @param [String] line
         # @return [Serverkit::Resources::Line::Content]
         def delete(line)
-          self.class.new(@raw.gsub(/^#{line}$/, ""))
+          self.class.new(@raw.gsub(/^#{Regexp.escape(line)}[\n$]/, ""))
         end
 
         # Insert the line after the last matched line or EOF
@@ -145,13 +163,6 @@ module Serverkit
 
         private
 
-        # @return [Array<String>]
-        def lines
-          @lines ||= @raw.each_line.map do |line|
-            line.gsub(/\n$/, "")
-          end
-        end
-
         # @param [Integer] index
         # @param [String] line
         # @return [Serverkit::Resources::Line::Content]
@@ -159,6 +170,13 @@ module Serverkit
           self.class.new([*lines.dup.insert(index, line), ""].join("\n"))
         end
 
+        # @return [Array<String>]
+        def lines
+          @lines ||= @raw.each_line.map do |line|
+            line.gsub(/\n$/, "")
+          end
+        end
+
         # @param [String] line
         # @return [Serverkit::Resources::Line::Content]
         def prepend(line)

data/lib/serverkit/version.rb

@@ -1,3 +1,3 @@
 module Serverkit
-  VERSION = "0.4.9"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serverkit
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.5.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-22 00:00:00.000000000 Z
+date: 2015-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -215,6 +215,7 @@ files:
 - example/template.erb
 - example/variables.yml
 - lib/readable_validator.rb
+- lib/regexp_validator.rb
 - lib/required_validator.rb
 - lib/serverkit.rb
 - lib/serverkit/actions/apply.rb