serverkit 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a765aaea4621162401ba0a04b6105893f183ba02
-  data.tar.gz: a736aa5d90464963deeb5061ccc8d85fb37685ca
+  metadata.gz: c63fd1655ae7424f508d32cdaefa5c0e83090117
+  data.tar.gz: b4c5a55c88bb2e2031dd3321f26443c32bdf79a6
 SHA512:
-  metadata.gz: a685ca9be3c3727eb55ae13fa912fcdf518386c7abcd5da0973076fb0dd1f20aecce0c1e1177b46f8dafdf21f4d0906fab0396bd047b8e4e81f6648299d74659
-  data.tar.gz: 59f7e1872c093a64c71be1246c1c383e20130f90106379c1da15de6e5422cc3acac2f4042f2570d40d6a5b84e3641af7972a64fcafc06392830286d28083bcdc
+  metadata.gz: 66c44fa0c113ccbde06013a4eab9d63ec42175572e8c6dd3848e764531d404d665f8668a5367df74d8186a80522e7dac8a13e3072a36cb0d633947ac8e55f6c1
+  data.tar.gz: 28ae2520dc1e0805e070cff7cc4ebb7d5f4e5725d5ec27f7e4948314a38ead1442a16f7079ff0f4758296c7a5d14a129e5203815c3e963c53c0f5ef2c2ee8fc4

data/.rubocop.yml

@@ -28,6 +28,9 @@ Metrics/MethodLength:
 Metrics/PerceivedComplexity:
   Enabled: false
 
+Style/AccessorMethodName:
+  Enabled: false
+
 Style/AndOr:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.4.3
+- Add directory resource
+- Add file resource
+- Rename the previous file resource with remote_file
+- Support shell attribute on user resource
+- Change some attribue names on user resource
+
 ## 0.4.2
 - Fix bug on apply action exit code
 - Support case-insensitive or number log-level

data/README.md

@@ -25,12 +25,12 @@ Write a recipe, then run `serverkit` executable to validate, inspect, check, and
 
 ### serverkit validate
 Validates recipe schema, resources, and attributes.
-For instance, it shows validation error if `source` attributes is missing in `file` resource.
+For instance, it shows validation error if `source` attributes is missing in `remote_file` resource.
 If any validation error is detected, it returns exit status 1.
 
 ```
 $ serverkit validate recipe.yml
-Error: source attribute is required in file resource
+Error: source attribute is required in remote_file resource
 Error: path attribute can't be unreadable path in recipe resource
 ```
 
@@ -192,14 +192,16 @@ By default, all types of resource can or must have the following attributes:
 - notify - specify an Array of handler ids that should be applied after changed
 
 ### Type
-A resource must have a type attribute. Currently the following types are available:
+A resource must have a valid type attribute like:
 
 - command
+- directory
 - file
 - git
 - nothing
 - package
 - recipe
+- remote_file
 - service
 - symlink
 - user

data/example/recipe.yml

@@ -1,7 +1,15 @@
 resources:
+  - type: remote_file
+    source: README.md
+    destination: /tmp/README.md
+  - type: file
+    path: /tmp/README.md
+    content: foo
   - type: user
     name: test
     password: test
-handlers:
-  - id: handler_test
-    type: nothing
+    home: /Users/test
+    shell: /bin/bash
+  - type: directory
+    path: /Users/test
+    owner: test

data/lib/serverkit/backends/base_backend.rb

@@ -57,6 +57,11 @@ module Serverkit
         run_command(get_command_from_identifier(*args))
       end
 
+      def send_file(from, to)
+        logger.debug("Sending file #{from} to #{to}")
+        specinfra_backend.send_file(from, to)
+      end
+
       private
 
       # @note Override me

data/lib/serverkit/resource_builder.rb

@@ -1,11 +1,13 @@
 require "active_support/core_ext/string/inflections"
 require "serverkit/resources/command"
+require "serverkit/resources/directory"
 require "serverkit/resources/file"
 require "serverkit/resources/git"
 require "serverkit/resources/missing"
 require "serverkit/resources/nothing"
 require "serverkit/resources/package"
 require "serverkit/resources/recipe"
+require "serverkit/resources/remote_file"
 require "serverkit/resources/service"
 require "serverkit/resources/symlink"
 require "serverkit/resources/unknown"

data/lib/serverkit/resources/directory.rb

@@ -0,0 +1,69 @@
+require "serverkit/resources/base"
+
+module Serverkit
+  module Resources
+    class Directory < Base
+      attribute :group, type: String
+      attribute :mode, type: [Integer, String]
+      attribute :owner, type: String
+      attribute :path, required: true, type: String
+
+      # @note Override
+      def apply
+        create_directory unless has_correct_directory?
+        update_group unless has_correct_group?
+        update_mode unless has_correct_mode?
+        update_owner unless has_correct_owner?
+      end
+
+      # @note Override
+      def check
+        has_correct_directory? && has_correct_group? && has_correct_mode? && has_correct_owner?
+      end
+
+      private
+
+      def create_directory
+        run_command_from_identifier(:create_file_as_directory, path)
+      end
+
+      def has_correct_directory?
+        check_command_from_identifier(:check_file_is_directory, path)
+      end
+
+      def has_correct_group?
+        group.nil? || check_command_from_identifier(:check_file_is_grouped, path, group)
+      end
+
+      def has_correct_mode?
+        mode.nil? || check_command_from_identifier(:check_file_has_mode, path, mode_in_octal_notation)
+      end
+
+      def has_correct_owner?
+        owner.nil? || check_command_from_identifier(:check_file_is_owned_by, path, owner)
+      end
+
+      # @return [String]
+      # @example "755" # for 0755
+      def mode_in_octal_notation
+        if mode.is_a?(Integer)
+          mode.to_s(8)
+        else
+          mode
+        end
+      end
+
+      def update_group
+        run_command_from_identifier(:change_file_group, path, group)
+      end
+
+      def update_mode
+        run_command_from_identifier(:change_file_mode, path, mode_in_octal_notation)
+      end
+
+      def update_owner
+        run_command_from_identifier(:change_file_owner, path, owner)
+      end
+    end
+  end
+end

data/lib/serverkit/resources/file.rb

@@ -1,68 +1,93 @@
 require "digest"
 require "serverkit/resources/base"
+require "tempfile"
 
 module Serverkit
   module Resources
     class File < Base
-      attribute :destination, required: true, type: String
+      attribute :content, type: String
       attribute :group, type: String
+      attribute :mode, type: [Integer, String]
       attribute :owner, type: String
-      attribute :source, readable: true, required: true, type: String
+      attribute :path, required: true, type: String
 
       # @note Override
       def apply
-        send_file if file_sendable?
-        change_group unless has_valid_group?
-        change_owner unless has_valid_owner?
+        update_file unless has_correct_file?
+        update_group unless has_correct_group?
+        update_mode unless has_correct_mode?
+        update_owner unless has_correct_owner?
       end
 
       # @note Override
       def check
-        has_file? && has_same_content? && has_valid_group? && has_valid_owner?
+        has_correct_file? && has_correct_group? && has_correct_mode? && has_correct_owner?
       end
 
       private
 
-      def change_group
-        run_command_from_identifier(:change_file_group, destination, group)
+      # @return [String]
+      def content_sha256sum
+        ::Digest::SHA256.hexdigest(content)
       end
 
-      def change_owner
-        run_command_from_identifier(:change_file_owner, destination, owner)
+      # @return [String]
+      def file_sha256sum
+        run_command_from_identifier(:get_file_sha256sum, path).stdout.rstrip
       end
 
-      def file_sendable?
-        !has_file? || !has_same_content?
+      def has_file?
+        check_command_from_identifier(:check_file_is_file, path)
       end
 
-      def has_file?
-        check_command_from_identifier(:check_file_is_file, destination)
+      def has_correct_content?
+        content.nil? || file_sha256sum == content_sha256sum
       end
 
-      def has_same_content?
-        remote_file_sha256sum == local_file_sha256sum
+      def has_correct_file?
+        has_file? && has_correct_content?
       end
 
-      def has_valid_group?
-        group.nil? || check_command_from_identifier(:check_file_is_grouped, destination, group)
+      def has_correct_group?
+        group.nil? || check_command_from_identifier(:check_file_is_grouped, path, group)
       end
 
-      def has_valid_owner?
-        owner.nil? || check_command_from_identifier(:check_file_is_owned_by, destination, owner)
+      def has_correct_mode?
+        mode.nil? || check_command_from_identifier(:check_file_has_mode, path, mode_in_octal_notation)
       end
 
-      # @return [String]
-      def local_file_sha256sum
-        ::Digest::SHA256.hexdigest(::File.read(source))
+      def has_correct_owner?
+        owner.nil? || check_command_from_identifier(:check_file_is_owned_by, path, owner)
       end
 
       # @return [String]
-      def remote_file_sha256sum
-        run_command_from_identifier(:get_file_sha256sum, destination).stdout.rstrip
+      # @example "755" # for 0755
+      def mode_in_octal_notation
+        if mode.is_a?(Integer)
+          mode.to_s(8)
+        else
+          mode
+        end
+      end
+
+      def update_file
+        ::Tempfile.open("") do |file|
+          file.write(content || "")
+          file.close
+          backend.send_file(file.path, path)
+        end
+      end
+
+      def update_group
+        run_command_from_identifier(:change_file_group, path, group)
+      end
+
+      def update_mode
+        run_command_from_identifier(:change_file_mode, path, mode_in_octal_notation)
       end
 
-      def send_file
-        run_command_from_identifier(:send_file, source, destination)
+      def update_owner
+        run_command_from_identifier(:change_file_owner, path, owner)
       end
     end
   end

data/lib/serverkit/resources/remote_file.rb

@@ -0,0 +1,69 @@
+require "digest"
+require "serverkit/resources/base"
+
+module Serverkit
+  module Resources
+    class RemoteFile < Base
+      attribute :destination, required: true, type: String
+      attribute :group, type: String
+      attribute :owner, type: String
+      attribute :source, readable: true, required: true, type: String
+
+      # @note Override
+      def apply
+        send_file_from_source_to_destination if file_sendable?
+        change_group unless has_valid_group?
+        change_owner unless has_valid_owner?
+      end
+
+      # @note Override
+      def check
+        has_file? && has_same_content? && has_valid_group? && has_valid_owner?
+      end
+
+      private
+
+      def change_group
+        run_command_from_identifier(:change_file_group, destination, group)
+      end
+
+      def change_owner
+        run_command_from_identifier(:change_file_owner, destination, owner)
+      end
+
+      def file_sendable?
+        !has_file? || !has_same_content?
+      end
+
+      def has_file?
+        check_command_from_identifier(:check_file_is_file, destination)
+      end
+
+      def has_same_content?
+        remote_file_sha256sum == local_file_sha256sum
+      end
+
+      def has_valid_group?
+        group.nil? || check_command_from_identifier(:check_file_is_grouped, destination, group)
+      end
+
+      def has_valid_owner?
+        owner.nil? || check_command_from_identifier(:check_file_is_owned_by, destination, owner)
+      end
+
+      # @return [String]
+      def local_file_sha256sum
+        ::Digest::SHA256.hexdigest(::File.read(source))
+      end
+
+      # @return [String]
+      def remote_file_sha256sum
+        run_command_from_identifier(:get_file_sha256sum, destination).stdout.rstrip
+      end
+
+      def send_file_from_source_to_destination
+        send_file(source, destination)
+      end
+    end
+  end
+end

data/lib/serverkit/resources/user.rb

@@ -5,10 +5,11 @@ module Serverkit
   module Resources
     class User < Base
       attribute :gid, type: [Integer, String]
-      attribute :home_directory, type: String
+      attribute :home, type: String
       attribute :name, type: String, required: true
       attribute :password, type: String
-      attribute :system_user, type: [FalseClass, TrueClass]
+      attribute :shell, type: String
+      attribute :system, type: [FalseClass, TrueClass]
       attribute :uid, type: Integer
 
       # @note Override
@@ -17,6 +18,7 @@ module Serverkit
           update_user_encrypted_password unless has_correct_password?
           update_user_gid unless has_correct_gid?
           update_user_home_directory unless has_correct_home_directory?
+          update_user_login_shell unless has_correct_login_shell?
           update_user_uid unless has_correct_uid?
         else
           add_user
@@ -28,13 +30,15 @@ module Serverkit
         case
         when !has_correct_user?
           false
-        when gid && !has_correct_gid?
+        when !has_correct_gid?
           false
-        when home_directory && !has_correct_home_directory?
+        when !has_correct_home_directory?
           false
-        when password && !has_correct_password?
+        when !has_correct_password?
           false
-        when uid && !has_correct_uid?
+        when !has_correct_login_shell?
+          false
+        when !has_correct_uid?
           false
         else
           true
@@ -48,9 +52,10 @@ module Serverkit
           :add_user,
           name,
           gid: gid,
-          home_directory: home_directory,
+          home_directory: home,
           password: encrypted_password,
-          system_user: system_user,
+          shell: shell,
+          system_user: system,
           uid: uid,
         )
       end
@@ -64,19 +69,23 @@ module Serverkit
       end
 
       def has_correct_gid?
-        check_command_from_identifier(:check_user_belongs_to_group, name, gid)
+        gid.nil? || check_command_from_identifier(:check_user_belongs_to_group, name, gid)
       end
 
       def has_correct_home_directory?
-        check_command_from_identifier(:check_user_has_home_directory, name, home_directory)
+        home.nil? || check_command_from_identifier(:check_user_has_home_directory, name, home)
+      end
+
+      def has_correct_login_shell?
+        shell.nil? || check_command_from_identifier(:check_user_has_login_shell, name, shell)
       end
 
       def has_correct_password?
-        ::UnixCrypt.valid?(password, get_remote_encrypted_password)
+        password.nil? || ::UnixCrypt.valid?(password, get_remote_encrypted_password)
       end
 
       def has_correct_uid?
-        check_command_from_identifier(:check_user_has_uid, name, uid)
+        uid.nil? || check_command_from_identifier(:check_user_has_uid, name, uid)
       end
 
       def has_correct_user?
@@ -92,7 +101,11 @@ module Serverkit
       end
 
       def update_user_home_directory
-        run_command_from_identifier(:update_user_home_directory, name, home_directory)
+        run_command_from_identifier(:update_user_home_directory, name, home)
+      end
+
+      def update_user_login_shell
+        run_command_from_identifier(:update_user_login_shell, name, shell)
       end
 
       def update_user_uid

data/lib/serverkit/version.rb

@@ -1,3 +1,3 @@
 module Serverkit
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

data/serverkit.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "highline"
   spec.add_runtime_dependency "rainbow"
   spec.add_runtime_dependency "slop", "~> 3.4"
-  spec.add_runtime_dependency "specinfra"
+  spec.add_runtime_dependency "specinfra", ">= 2.29.0"
   spec.add_runtime_dependency "unix-crypt"
   spec.add_development_dependency "pry", "0.10.1"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: serverkit
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.29.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.29.0
 - !ruby/object:Gem::Dependency
   name: unix-crypt
   requirement: !ruby/object:Gem::Requirement
@@ -242,12 +242,14 @@ files:
 - lib/serverkit/resource_builder.rb
 - lib/serverkit/resources/base.rb
 - lib/serverkit/resources/command.rb
+- lib/serverkit/resources/directory.rb
 - lib/serverkit/resources/file.rb
 - lib/serverkit/resources/git.rb
 - lib/serverkit/resources/missing.rb
 - lib/serverkit/resources/nothing.rb
 - lib/serverkit/resources/package.rb
 - lib/serverkit/resources/recipe.rb
+- lib/serverkit/resources/remote_file.rb
 - lib/serverkit/resources/service.rb
 - lib/serverkit/resources/symlink.rb
 - lib/serverkit/resources/unknown.rb