RubyGems - systemd_service_check - Versions diffs - 1.0.0 → 1.1.0 - Mend

systemd_service_check 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (14) hide show

checksums.yaml +4 -4
data/.rubocop.yml +1 -0
data/.travis.yml +3 -0
data/{lib/systemd_service_check/CHANGELOG.md → CHANGELOG.md} +11 -3
data/README.md +164 -84
data/lib/systemd_service_check.rb +50 -4
data/lib/systemd_service_check/cli.rb +31 -20
data/lib/systemd_service_check/ssh.rb +44 -0
data/lib/systemd_service_check/utils.rb +56 -0
data/lib/systemd_service_check/version.rb +1 -1
data/systemd_service_check.gemspec +6 -6
data/systemd_service_check.sample.yml +43 -7
metadata +38 -10
data/lib/systemd_service_check/base.rb +0 -110

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14d00810a361024a249ae6211e3805e1383badf662431804174abfc4b86e842e
-  data.tar.gz: d68c217324a1a19a507e97cfa1c790f3e2ad18981d2496dba23a4be437220f30
+  metadata.gz: bcc52f7b0040ae6d343dc5f258d468e2b9a105352d44a73406f2615d3325eff3
+  data.tar.gz: a1e5b4b490e994a11f03707f5ebda9bf17cb5895f49c9d9808e5b9358168c6a8
 SHA512:
-  metadata.gz: 5c0f87e7ee79969bad99bf4f77f8be010217b0e75c9fc6b7a93541eaec69b6ed1bd5de78d9ebfc0c248add2f421151730fee9519c83b15869679733cef730995
-  data.tar.gz: c215f24bb497793765217e66e58df8c711d7218a40584ebce380cf0983f43289b3b36a5cb75b2b44d893feefc906a9cfedd576d295dee4c468f405e0dcea6fd4
+  metadata.gz: f576d59a803b1a3875f83dd018752dab4911b2dec4ba04a470374338e8f42513de9a06171bd990605c30a0bbde791c9705bafe6fad1fa2bf4773f46cb66ff14b
+  data.tar.gz: bece1d59dc14f99ab8ce9c1fada8e7a9b2daf605b35816a5d8af264c60c5d595e474a6c988fa259f2f79fd953ba34c74e01ec25854d46f5434bb31526941ffa8

data/.rubocop.yml CHANGED

@@ -3,6 +3,7 @@ inherit_from: .rubocop_todo.yml
 AllCops:
   TargetRubyVersion: 2.5
   Exclude:
+    - systemd_service_check.gemspec
     - Vagrantfile
     - vendor/**/*
     - lib/table_print-patch-pr70/*

data/.travis.yml CHANGED

@@ -2,4 +2,7 @@ sudo: false
 language: ruby
 rvm:
   - 2.5.0
+  - 2.4.3
+  - 2.3.6
+cache: bundler
 before_install: gem install bundler -v 1.16.1

data/{lib/systemd_service_check/CHANGELOG.md → CHANGELOG.md} RENAMED

@@ -4,9 +4,17 @@ Please confirm details from the following.
 https://github.com/k-ta-yamada/systemd_service_check/releases
+## v1.1.0
+2018-02-08 +0900
+- issues: https://github.com/k-ta-yamada/systemd_service_check/milestone/2?closed=1
+- release: https://github.com/k-ta-yamada/systemd_service_check/releases/tag/v1.1.0
+- commits: https://github.com/k-ta-yamada/systemd_service_check/compare/v1.0.0...v1.1.0
 ## v1.0.0
-2018-01-28 JST
+2018-01-28 +0900
 - issues: https://github.com/k-ta-yamada/systemd_service_check/milestone/1?closed=1
 - release: https://github.com/k-ta-yamada/systemd_service_check/releases/tag/v1.0.0
@@ -14,14 +22,14 @@ https://github.com/k-ta-yamada/systemd_service_check/releases
 ## v0.0.0
-2018-01-25 JST
+2018-01-25 +0900
 - release: https://github.com/k-ta-yamada/systemd_service_check/releases/tag/v0.0.0
 - commits: https://github.com/k-ta-yamada/systemd_service_check/compare/v0.0.0-alpha...v0.0.0
 ## v0.0.0-alpha
-2018-01-23 JST
+2018-01-23 +0900
 - release: https://github.com/k-ta-yamada/systemd_service_check/releases/tag/v0.0.0-alpha
 - commits: https://github.com/k-ta-yamada/systemd_service_check/compare/4e4adbd...v0.0.0-alpha

data/README.md CHANGED

@@ -2,6 +2,7 @@
 [![Gem Version](https://badge.fury.io/rb/systemd_service_check.svg)](https://badge.fury.io/rb/systemd_service_check)
 [![Build Status](https://travis-ci.org/k-ta-yamada/systemd_service_check.svg?branch=master)](https://travis-ci.org/k-ta-yamada/systemd_service_check)
+[![Inline docs](http://inch-ci.org/github/k-ta-yamada/systemd_service_check.svg?branch=master&style=shields)](http://inch-ci.org/github/k-ta-yamada/systemd_service_check)
 This gem provide `ssc` command to check multiple `systemd service`
 etc on multiple remote servers using net-ssh.
@@ -41,7 +42,10 @@ usage as CLI: `ssc check -y ./path/to/setting.yml`
 ```rb
 require 'systemd_service_check'
-ssc = SystemdServiceCheck::Base.new
+envs = ['dev', 'stg']
+yaml = './your_settings.yml'
+role = 'app'
+ssc = SystemdServiceCheck::Base.new(envs, yaml, role)
 puts ssc.to_json
 ```
@@ -51,43 +55,100 @@ puts ssc.to_json
 ```sh
 $ ssc help
 Commands:
-  ssc check ENV [ENV...] options  # check target ENV Servers.
-  ssc help [COMMAND]              # Describe available commands or one specific command
-  ssc version                     # return SystemdServiceCheck::VERSION
+  ssc check ENV [ENV...] [options]  # check target ENV Servers.
+  ssc help [COMMAND]                # Describe available commands or one specific command
+  ssc version                       # return SystemdServiceCheck::VERSION
 ```
 ```sh
 $ ssc help check
 Usage:
-  ssc check ENV [ENV...] options
+  ssc check [ENV [ENV...]] [options]
 Options:
-  -f, [--format=table]                             # [t]able, [j]son, [a]wesome_print
-                                                   # Default: table
-  -y, [--yaml=./systemd_service_check.sample.yml]  # setting yaml file
-                                                   # Default: ./systemd_service_check.sample.yml
+  -y, [--yaml=YAML]      # setting yaml file
+                         # Default: ./systemd_service_check.sample.yml
+  -r, [--role=ROLE]      # Target the specified role
+  -f, [--format=FORMAT]  # [t]able, [j]son, [a]wesome_print
+                         # Default: table
 check target ENV Servers.
+If `ENV` is omitted, the value of the first env of servers described in yaml is used.
+If `all` is specified for `ENV`, all ENVs are targeted.
 ```
 ```sh
 $ ssc check
-ENV | IP            | HOSTNAME | USER | SERVICE_NAME                   | LOAD_STATE | ACTIVE_STATE | SUB_STATE | UNIT_FILE_STATE | TYPE
-----|---------------|----------|------|--------------------------------|------------|--------------|-----------|-----------------|--------
-dev | 192.168.1.101 | centos7  | root | sshd.service                   | loaded     | active       | running   | enabled         | notify
-dev | 192.168.1.101 | centos7  | root | firewalld.service              | loaded     | inactive     | dead      | disabled        | dbus
-dev | 192.168.1.101 | centos7  | root | rsyslog.service                | loaded     | active       | running   | enabled         | notify
-dev | 192.168.1.101 | centos7  | root | network.service                | loaded     | active       | exited    | bad             | forking
-dev | 192.168.1.101 | centos7  | root | systemd-tmpfiles-clean.timer   | loaded     | active       | waiting   | static          | n/a
-dev | 192.168.1.101 | centos7  | root | dummy_long_name_size_30_______ | not-found  | inactive     | dead      | n/a             | n/a
+ENV | ROLE | IP            | HOSTNAME | USER | SERVICE_NAME                   | LOAD_STATE | ACTIVE_STATE | SUB_STATE | UNIT_FILE_STATE | TYPE
+----|------|---------------|----------|------|--------------------------------|------------|--------------|-----------|-----------------|--------
+dev |      | 192.168.1.101 | centos7  | root | sshd.service                   | loaded     | active       | running   | enabled         | notify
+dev |      | 192.168.1.101 | centos7  | root | firewalld.service              | loaded     | inactive     | dead      | disabled        | dbus
+dev |      | 192.168.1.101 | centos7  | root | rsyslog.service                | loaded     | active       | running   | enabled         | notify
+dev |      | 192.168.1.101 | centos7  | root | network.service                | loaded     | active       | exited    | bad             | forking
+dev |      | 192.168.1.101 | centos7  | root | systemd-tmpfiles-clean.timer   | loaded     | active       | waiting   | static          |
+dev |      | 192.168.1.101 | centos7  | root | dummy_long_name_size_30_______ | not-found  | inactive     | dead      |                 |
+ENV | ROLE | IP            | HOSTNAME | USER | SERVICE_NAME  | LOAD_STATE | ACTIVE_STATE | SUB_STATE | UNIT_FILE_STATE | TYPE
+----|------|---------------|----------|------|---------------|------------|--------------|-----------|-----------------|-------
+dev | ap   | 192.168.1.101 | centos7  | root | sshd.service  | loaded     | active       | running   | enabled         | notify
+dev | ap   | 192.168.1.101 | centos7  | root | nginx.service | not-found  | inactive     | dead      |                 |
+ENV | ROLE | IP            | HOSTNAME | USER | SERVICE_NAME       | LOAD_STATE | ACTIVE_STATE | SUB_STATE | UNIT_FILE_STATE | TYPE
+----|------|---------------|----------|------|--------------------|------------|--------------|-----------|-----------------|-------
+dev | db   | 192.168.1.101 | centos7  | root | sshd.service       | loaded     | active       | running   | enabled         | notify
+dev | db   | 192.168.1.101 | centos7  | root | postgresql.service | not-found  | inactive     | dead      |                 |
+dev | db   | 192.168.1.101 | centos7  | root | pgpool.service     | not-found  | inactive     | dead      |                 |
+```
+#### role
+```sh
+$ ssc check --role ap
+ENV | ROLE | IP            | HOSTNAME | USER | SERVICE_NAME  | LOAD_STATE | ACTIVE_STATE | SUB_STATE | UNIT_FILE_STATE | TYPE
+----|------|---------------|----------|------|---------------|------------|--------------|-----------|-----------------|-------
+dev | ap   | 192.168.1.101 | centos7  | root | sshd.service  | loaded     | active       | running   | enabled         | notify
+dev | ap   | 192.168.1.101 | centos7  | root | nginx.service | not-found  | inactive     | dead      |                 |
+```
+```sh
+$ ssc check --role db
+ENV | ROLE | IP            | HOSTNAME | USER | SERVICE_NAME       | LOAD_STATE | ACTIVE_STATE | SUB_STATE | UNIT_FILE_STATE | TYPE
+----|------|---------------|----------|------|--------------------|------------|--------------|-----------|-----------------|-------
+dev | db   | 192.168.1.101 | centos7  | root | sshd.service       | loaded     | active       | running   | enabled         | notify
+dev | db   | 192.168.1.101 | centos7  | root | postgresql.service | not-found  | inactive     | dead      |                 |
+dev | db   | 192.168.1.101 | centos7  | root | pgpool.service     | not-found  | inactive     | dead      |                 |
 ```
+```sh
+$ ssc check all --role db
+ENV | ROLE | IP            | HOSTNAME | USER | SERVICE_NAME       | LOAD_STATE | ACTIVE_STATE | SUB_STATE | UNIT_FILE_STATE | TYPE
+----|------|---------------|----------|------|--------------------|------------|--------------|-----------|-----------------|-------
+dev | db   | 192.168.1.101 | centos7  | root | sshd.service       | loaded     | active       | running   | enabled         | notify
+dev | db   | 192.168.1.101 | centos7  | root | postgresql.service | not-found  | inactive     | dead      |                 |
+dev | db   | 192.168.1.101 | centos7  | root | pgpool.service     | not-found  | inactive     | dead      |                 |
+ENV | ROLE | IP            | HOSTNAME | USER | SERVICE_NAME       | LOAD_STATE | ACTIVE_STATE | SUB_STATE | UNIT_FILE_STATE | TYPE
+----|------|---------------|----------|------|--------------------|------------|--------------|-----------|-----------------|-------
+stg | db   | 192.168.1.101 | centos7  | root | sshd.service       | loaded     | active       | running   | enabled         | notify
+stg | db   | 192.168.1.101 | centos7  | root | postgresql.service | not-found  | inactive     | dead      |                 |
+stg | db   | 192.168.1.101 | centos7  | root | pgpool.service     | not-found  | inactive     | dead      |                 |
+ENV | ROLE | IP            | HOSTNAME | USER | SERVICE_NAME       | LOAD_STATE | ACTIVE_STATE | SUB_STATE | UNIT_FILE_STATE | TYPE
+----|------|---------------|----------|------|--------------------|------------|--------------|-----------|-----------------|-------
+prd | db   | 192.168.1.101 | centos7  | root | sshd.service       | loaded     | active       | running   | enabled         | notify
+prd | db   | 192.168.1.101 | centos7  | root | postgresql.service | not-found  | inactive     | dead      |                 |
+prd | db   | 192.168.1.101 | centos7  | root | pgpool.service     | not-found  | inactive     | dead      |                 |
+```
+#### formatting sample
 ```sh
 $ ssc check --format=json | jq
 [
   {
     "server": {
       "env": "dev",
+      "role": null,
       "ip": "192.168.1.101",
       "user": "root",
       "options": {
@@ -95,16 +156,13 @@ $ ssc check --format=json | jq
         "keys": [
           ""
         ],
-        "logger": "#<Logger:0x00007fa52293b0b0>",
-        "password_prompt": "#<Net::SSH::Prompt:0x00007fa52293aa70>",
+        "logger": "#<Logger:0x00007fba5bb2d730>",
+        "password_prompt": "#<Net::SSH::Prompt:0x00007fba5bb2d5a0>",
         "user": "root"
       },
       "services": [
         "sshd.service",
-        "firewalld.service",
-        "rsyslog.service",
-        "network.service",
-        "systemd-tmpfiles-clean.timer",
+        ...,
         "dummy_long_name_size_30_______"
       ],
       "hostname": "centos7"
@@ -118,45 +176,57 @@ $ ssc check --format=json | jq
         "unit_file_state": "enabled",
         "type": "notify"
       },
+      ...,
       {
-        "service_name": "firewalld.service",
-        "load_state": "loaded",
+        "service_name": "dummy_long_name_size_30_______",
+        "load_state": "not-found",
         "active_state": "inactive",
         "sub_state": "dead",
-        "unit_file_state": "disabled",
-        "type": "dbus"
+        "unit_file_state": null,
+        "type": null
+      }
+    ]
+  },
+  ...,
+  {
+    "server": {
+      "env": "dev",
+      "role": "db",
+      "ip": "192.168.1.101",
+      "user": "root",
+      "options": {
+        "password": "vagrant",
+        "keys": [
+          ""
+        ],
+        "logger": "#<Logger:0x00007fba5bad2c90>",
+        "password_prompt": "#<Net::SSH::Prompt:0x00007fba5bb2d5a0>",
+        "user": "root"
       },
+      "services": [
+        "sshd.service",
+        "postgresql.service",
+        "pgpool.service"
+      ],
+      "hostname": "centos7"
+    },
+    "services": [
       {
-        "service_name": "rsyslog.service",
+        "service_name": "sshd.service",
         "load_state": "loaded",
         "active_state": "active",
         "sub_state": "running",
         "unit_file_state": "enabled",
         "type": "notify"
       },
+      ...,
       {
-        "service_name": "network.service",
-        "load_state": "loaded",
-        "active_state": "active",
-        "sub_state": "exited",
-        "unit_file_state": "bad",
-        "type": "forking"
-      },
-      {
-        "service_name": "systemd-tmpfiles-clean.timer",
-        "load_state": "loaded",
-        "active_state": "active",
-        "sub_state": "waiting",
-        "unit_file_state": "static",
-        "type": "n/a"
-      },
-      {
-        "service_name": "dummy_long_name_size_30_______",
+        "service_name": "pgpool.service",
         "load_state": "not-found",
         "active_state": "inactive",
         "sub_state": "dead",
-        "unit_file_state": "n/a",
-        "type": "n/a"
+        "unit_file_state": null,
+        "type": null
       }
     ]
   }
@@ -166,8 +236,8 @@ $ ssc check --format=json | jq
 ```sh
 $ ssc check --format=awesome_print
 [
-    [0] #<Struct:SystemdServiceCheck::Base::Result:0x7fabeca9ad40
-        server = #<Struct:SystemdServiceCheck::Base::Server:0x7fabec9c6ea0
+    [0] #<Struct:SystemdServiceCheck::SSH::Result:0x7fb39db78678
+        server = #<Struct:SystemdServiceCheck::Base::Server:0x7fb39dac6ec8
             env = "dev",
             hostname = "centos7",
             ip = "192.168.1.101",
@@ -176,22 +246,20 @@ $ ssc check --format=awesome_print
                            :keys => [
                     [0] ""
                 ],
-                         :logger => #<Logger:0x00007fabec9c6478 @level=4, @progname=nil, @default_formatter=#<Logger::Formatter:0x00007fabec9c63d8 @datetime_format=nil>, @formatter=nil, @logdev=#<Logger::LogDevice:0x00007fabec9c6360 @shift_period_suffix=nil, @shift_size=nil, @shift_age=nil, @filename=nil, @dev=#<IO:<STDERR>>, @mon_owner=nil, @mon_count=0, @mon_mutex=#<Thread::Mutex:0x00007fabec9c6248>>>,
-                :password_prompt => #<Net::SSH::Prompt:0x00007fabec9c61d0>,
+                         :logger => #<Logger:0x00007fb39dac5d98 @level=4, @progname=nil, @default_formatter=#<Logger::Formatter:0x00007fb39dac5cf8 @datetime_format=nil>, @formatter=nil, @logdev=#<Logger::LogDevice:0x00007fb39dac5ca8 @shift_period_suffix=nil, @shift_size=nil, @shift_age=nil, @filename=nil, @dev=#<IO:<STDERR>>, @mon_owner=nil, @mon_count=0, @mon_mutex=#<Thread::Mutex:0x00007fb39dac5c30>>>,
+                :password_prompt => #<Net::SSH::Prompt:0x00007fb39dac5bb8>,
                            :user => "root"
             },
+            role = nil,
             services = [
                 [0] "sshd.service",
-                [1] "firewalld.service",
-                [2] "rsyslog.service",
-                [3] "network.service",
-                [4] "systemd-tmpfiles-clean.timer",
+                ...,
                 [5] "dummy_long_name_size_30_______"
             ],
             user = "root"
         >,
         services = [
-            [0] #<Struct:SystemdServiceCheck::Base::Service:0x7fabed259798
+            [0] #<Struct:SystemdServiceCheck::SSH::Service:0x7fb39da6bc08
                 active_state = "active",
                 load_state = "loaded",
                 service_name = "sshd.service",
@@ -199,45 +267,57 @@ $ ssc check --format=awesome_print
                 type = "notify",
                 unit_file_state = "enabled"
             >,
-            [1] #<Struct:SystemdServiceCheck::Base::Service:0x7fabecabaeb0
+            ...,
+            [5] #<Struct:SystemdServiceCheck::SSH::Service:0x7fb39db78bc8
                 active_state = "inactive",
-                load_state = "loaded",
-                service_name = "firewalld.service",
+                load_state = "not-found",
+                service_name = "dummy_long_name_size_30_______",
                 sub_state = "dead",
-                type = "dbus",
-                unit_file_state = "disabled"
-            >,
-            [2] #<Struct:SystemdServiceCheck::Base::Service:0x7fabecab7648
+                type = nil,
+                unit_file_state = nil
+            >
+        ]
+    >,
+    ...,
+    [2] #<Struct:SystemdServiceCheck::SSH::Result:0x7fb39e044cd8
+        server = #<Struct:SystemdServiceCheck::Base::Server:0x7fb39dac6888
+            env = "dev",
+            hostname = "centos7",
+            ip = "192.168.1.101",
+            options = {
+                       :password => "vagrant",
+                           :keys => [
+                    [0] ""
+                ],
+                         :logger => #<Logger:0x00007fb39e9c9858 @level=4, @progname=nil, @default_formatter=#<Logger::Formatter:0x00007fb39e9c9808 @datetime_format=nil>, @formatter=nil, @logdev=#<Logger::LogDevice:0x00007fb39e9c9790 @shift_period_suffix=nil, @shift_size=nil, @shift_age=nil, @filename=nil, @dev=#<IO:<STDERR>>, @mon_owner=nil, @mon_count=0, @mon_mutex=#<Thread::Mutex:0x00007fb39e9c96f0>>>,
+                :password_prompt => #<Net::SSH::Prompt:0x00007fb39dac5bb8>,
+                           :user => "root"
+            },
+            role = "db",
+            services = [
+                [0] "sshd.service",
+                [1] "postgresql.service",
+                [2] "pgpool.service"
+            ],
+            user = "root"
+        >,
+        services = [
+            [0] #<Struct:SystemdServiceCheck::SSH::Service:0x7fb39dbd5b98
                 active_state = "active",
                 load_state = "loaded",
-                service_name = "rsyslog.service",
+                service_name = "sshd.service",
                 sub_state = "running",
                 type = "notify",
                 unit_file_state = "enabled"
             >,
-            [3] #<Struct:SystemdServiceCheck::Base::Service:0x7fabeca9e3f0
-                active_state = "active",
-                load_state = "loaded",
-                service_name = "network.service",
-                sub_state = "exited",
-                type = "forking",
-                unit_file_state = "bad"
-            >,
-            [4] #<Struct:SystemdServiceCheck::Base::Service:0x7fabed8c6db0
-                active_state = "active",
-                load_state = "loaded",
-                service_name = "systemd-tmpfiles-clean.timer",
-                sub_state = "waiting",
-                type = "n/a",
-                unit_file_state = "static"
-            >,
-            [5] #<Struct:SystemdServiceCheck::Base::Service:0x7fabeca9b1f0
+            ...,
+            [2] #<Struct:SystemdServiceCheck::SSH::Service:0x7fb39e045048
                 active_state = "inactive",
                 load_state = "not-found",
-                service_name = "dummy_long_name_size_30_______",
+                service_name = "pgpool.service",
                 sub_state = "dead",
-                type = "n/a",
-                unit_file_state = "n/a"
+                type = nil,
+                unit_file_state = nil
             >
         ]
     >

data/lib/systemd_service_check.rb CHANGED

@@ -1,6 +1,52 @@
+require 'net/ssh'
+require 'thor'
+require 'awesome_print'
+require 'table_print'
+require 'yaml'
+require 'json'
+require 'pry' # forDebug
 require "systemd_service_check/version"
-require "systemd_service_check/base"
+require 'systemd_service_check/utils'
+require 'systemd_service_check/ssh'
+module SystemdServiceCheck
+  # Base
+  class Base
+    include Utils
+    include SSH
+    attr_reader :envs, :role, :servers, :target_envs, :target_servers, :results
+    # @param envs [Arrat<String>]
+    # @param yaml [String]
+    # @param role [String]
+    def initialize(envs, yaml, role = nil)
+      raise Utils::InvalidOptionError, "Argument `yaml` must not be blank." if blank? yaml
+      @envs           = envs || []
+      @role           = role.nil? || role.empty? ? nil : role
+      @servers        = servers_from(yaml)
+      @target_envs    = configure_target_envs(envs, @servers)
+      @target_servers = configure_target_servers(@servers, @target_envs, @role)
+      @results        = []
+    end
+    def run
+      @results = @target_servers.map { |server| ssh(server) }
+    end
+    def to_json
+      @results.map do |result|
+        { server:   result.server.to_h,
+          services: result.services.map(&:to_h) }
+      end.to_json
+    end
+    private
-# module SystemdServiceCheck
-# #   # Your code goes here...
-# end
+    def blank?(yaml)
+      yaml.nil? || yaml.empty?
+    end
+  end
+end

data/lib/systemd_service_check/cli.rb CHANGED

@@ -1,8 +1,4 @@
 require 'systemd_service_check'
-require 'thor'
-require 'awesome_print'
-require 'table_print'
-require 'pry' # forDebug
 # ###############################################################################
 # MEMO: This patch is a copy of https://github.com/arches/table_print/pull/70
@@ -13,33 +9,43 @@ require 'table_print-patch-pr70/formatter'
 module SystemdServiceCheck
   # CLI
   class CLI < Thor
-    class InvalidFormatOption < StandardError; end
+    class InvalidFormatOptionError < StandardError; end
-    option :format,
-           type:    :string,
-           aliases: '-f',
-           desc:    "[t]able, [j]son, [a]wesome_print",
-           banner:  'table',
-           default: 'table'
     option :yaml,
            type:    :string,
            aliases: '-y',
            desc:    'setting yaml file',
-           banner:  './systemd_service_check.sample.yml',
            default: './systemd_service_check.sample.yml'
+    option :role,
+           type:    :string,
+           aliases: '-r',
+           desc:    'Target the specified role'
+    option :format,
+           type:    :string,
+           aliases: '-f',
+           desc:    '[t]able, [j]son, [a]wesome_print',
+           default: 'table'
-    desc "check ENV [ENV...] options", "check target ENV Servers."
-    def check(*env)
-      raise InvalidFormatOption unless format_option_validate
-      @ssc = Base.new(env, options[:yaml])
+    description = <<~DESCRIPTION
+      check target ENV Servers.
+      If `ENV` is omitted, the value of the first env of servers described in yaml is used.
+      If `all` is specified for `ENV`, all ENVs are targeted.
+    DESCRIPTION
+    desc 'check [ENV [ENV...]] [options]', description
+    def check(*envs) # rubocop:disable Metrics/AbcSize:
+      raise InvalidFormatOptionError unless format_option_validate
+      @ssc = Base.new(envs, options[:yaml], options[:role])
+      @ssc.run
       disp
-    rescue InvalidFormatOption => e
+    rescue InvalidFormatOptionError => e
       puts "<#{e}>",
            "  [#{options[:format]}] is invalid value."
       puts "  #{e.backtrace_locations.first}"
     end
-    desc "version", "return SystemdServiceCheck::VERSION"
+    desc 'version',
+         'return SystemdServiceCheck::VERSION'
     def version
       puts VERSION
     end
@@ -66,8 +72,11 @@ module SystemdServiceCheck
       ap @ssc.results
     end
-    COLS = %i[env ip hostname user service_name load_state active_state sub_state unit_file_state type].freeze
-    def disp_table # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/LineLength
+    COLS = %i[env role ip hostname user service_name].concat(Utils::PROPERTY_TO_SNAKE_SYM).freeze
+    # rubocop:enable Metrics/LineLength
+    def disp_table # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       service_name_width =
         @ssc.results.map(&:services).flatten.map(&:service_name).map(&:size).max
@@ -80,10 +89,12 @@ module SystemdServiceCheck
       end
       # ref: https://github.com/erikhuda/thor/blob/master/lib/thor/shell.rb#L14
+      # rubocop:disable Style/GuardClause
       if RbConfig::CONFIG["host_os"] =~ /mswin|mingw/ && !ENV["ANSICON"]
         puts "-- For colors on windows, please setup `ANSICON`.",
              "-- ANSICON: https://github.com/adoxa/ansicon"
       end
+      # rubocop:enable Style/GuardClause
     end
     def decorate_ansi_color(services)

data/lib/systemd_service_check/ssh.rb ADDED

@@ -0,0 +1,44 @@
+# SystemdServiceCheck
+module SystemdServiceCheck
+  # SSH
+  module SSH
+    # @param server [Utils::Server]
+    # @return [Utils::Result]
+    def ssh(server)
+      services = []
+      Net::SSH.start(*server.conn_info) do |ssh|
+        server[:hostname] = hostname(ssh)
+        services =
+          server[:services].map { |service_name| systemctl_show(ssh, service_name) }
+        # TODO: store in Result object
+        # puts ssh.exec!("systemctl list-timers")
+      end
+      Utils::Result.new(server, services)
+    end
+    # @param ssh [Net::SSH::Connection::Session]
+    # @return [String]
+    def hostname(ssh)
+      ssh.exec!('hostname').chomp
+    end
+    # @param ssh [Net::SSH::Connection::Session]
+    # @param service_name [String]
+    # @return [Utils::Service]
+    def systemctl_show(ssh, service_name)
+      prop = ssh.exec!("systemctl show #{service_name} -p #{Utils::PROPERTY.join(",")}")
+      Utils::Service.new(service_name, *split_property(prop))
+    end
+    private
+    def split_property(property)
+      ret = property.split("\n")
+                    .map { |v| v.split("=") }
+                    .map { |(v1, v2)| [Thor::Util.snake_case(v1).to_sym, v2] }
+                    .each_with_object({}) { |(k, v), memo| memo[k] = v }
+      Utils::PROPERTY_TO_SNAKE_SYM.map { |k| ret[k] }
+    end
+  end
+end

data/lib/systemd_service_check/utils.rb ADDED

@@ -0,0 +1,56 @@
+module SystemdServiceCheck
+  # Included in: SystemdServiceCheck::Base
+  module Utils
+    # TODO: systemctl show -p
+    PROPERTY = %w[LoadState ActiveState SubState UnitFileState Type].freeze
+    PROPERTY_TO_SNAKE_SYM = PROPERTY.map { |v| Thor::Util.snake_case(v).to_sym }
+    class InvalidOptionError < StandardError; end
+    Server = Struct.new(:env, :role, :ip, :user, :options, :services, :hostname) do
+      # @return [Array<String, String, Hash>] for Net::SSH.start(*conn_info)
+      # @see SSH
+      # @see Net::SSH
+      def conn_info
+        [ip, user, options]
+      end
+    end
+    Service = Struct.new(:service_name, *PROPERTY_TO_SNAKE_SYM)
+    Result  = Struct.new(:server, :services)
+    # @param yaml_filename [String] YAML filename with the description of the setting.
+    # @return [Array<Utils::Server>]
+    def servers_from(yaml_filename) # rubocop:disable Metrics/AbcSize
+      yaml = JSON.parse(YAML.load_file(yaml_filename).to_json, symbolize_names: true)
+      yaml[:servers].map do |s|
+        raise InvalidOptionError, "ENV: #{s[:env]}" if [s[:password], s[:key]].all?(&:nil?) # rubocop:disable Metrics/LineLength
+        options = { password: s[:password], keys: [s[:key] || ""] }
+        Server.new(s[:env], s[:role], s[:ip], s[:user], options, s[:services])
+      end
+    end
+    # @param argv [Array<String>] Array of ENVs specified with the `ssc check` command.
+    # @param servers [Array<Utils::Server>] Server settings.
+    # @return [Array<String>] Environment list to be processed.
+    def configure_target_envs(argv, servers)
+      all_envs = servers.map { |s| s[:env] }.uniq
+      target_envs = all_envs & argv
+      # If there is no argument.
+      target_envs = all_envs.first if target_envs.empty? && argv.empty?
+      # If there is only one argument and it is `all`.
+      target_envs = all_envs if argv.size == 1 && argv.first == 'all'
+      Array(target_envs)
+    end
+    # @param servers [Array<Utils::Server>]
+    # @param target_envs [Array<String>] Environment list to be processed.
+    # @return [Array<Utils::Server>]
+    def configure_target_servers(servers, target_envs, role)
+      servers.select { |s| target_envs.include?(s[:env]) }
+             .select { |s| role.nil? || role.empty? ? true : s[:role] == role }
+    end
+  end
+end

data/lib/systemd_service_check/version.rb CHANGED

@@ -1,3 +1,3 @@
 module SystemdServiceCheck
-  VERSION = "1.0.0".freeze
+  VERSION = "1.1.0".freeze
 end

data/systemd_service_check.gemspec CHANGED

@@ -9,12 +9,10 @@ Gem::Specification.new do |spec|
   spec.authors       = ["k-ta-yamada"]
   spec.email         = ["key.luvless@gmail.com"]
-  spec.summary       =
-    'This gem provide `ssc` command to check multiple `systemd service` \
-    etc on multiple remote servers using net-ssh.'
-  spec.description   =
-    'This gem provide `ssc` command to check multiple `systemd service` \
-    etc on multiple remote servers using net-ssh.'
+  spec.required_ruby_version = '>= 2.3.0'
+  spec.summary       = 'This gem provide `ssc` command to check multiple `systemd service` etc on multiple remote servers using net-ssh.'
+  spec.description   = 'This gem provide `ssc` command to check multiple `systemd service` etc on multiple remote servers using net-ssh.'
   spec.homepage      = "https://github.com/k-ta-yamada/systemd_service_check"
   spec.license       = "MIT"
@@ -40,6 +38,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'capture_stdout'
+  spec.add_development_dependency 'minitest-reporters'
   spec.add_development_dependency 'pry-doc'
   spec.add_development_dependency 'pry-theme'
   spec.add_development_dependency 'rubocop'

data/systemd_service_check.sample.yml CHANGED

@@ -6,27 +6,63 @@ services: &default_services
   - network.service
   - systemd-tmpfiles-clean.timer
   - dummy_long_name_size_30_______
+ap_services: &ap_services
+  - sshd.service
+  - nginx.service
+db_services: &db_services
+  - sshd.service
+  - postgresql.service
+  - pgpool.service
 # SERVERS TO BE CHECKED [Array of Hash]
 servers:
-  # only password
   - env:      dev
+    # role:     ap
     ip:       192.168.1.101
     user:     root
+    # only password
     password: vagrant
     # key:      ./.vagrant/machines/centos7/virtualbox/private_key
     services: *default_services
-  # only private key
-  - env:      stg
+  - env:      dev
+    role:     ap # This value is specified by the `--role` option
     ip:       192.168.1.101
     user:     root
+    # only private key
     # password: vagrant
     key:      ./.vagrant/machines/centos7/virtualbox/private_key
-    services: *default_services
-  # password and private key (private key will be used preferentially)
-  - env:      prd
+    services: *ap_services
+  - env:      dev
+    role:     db
     ip:       192.168.1.101
     user:     root
+    # password and private key (private key will be used preferentially)
     password: invalid-dummy-password
     key:      ./.vagrant/machines/centos7/virtualbox/private_key
-    services: *default_services
+    services: *db_services
+  - env:      stg
+    role:     ap
+    ip:       192.168.1.101
+    user:     root
+    password: vagrant
+    services: *ap_services
+  - env:      stg
+    role:     db
+    ip:       192.168.1.101
+    user:     root
+    password: vagrant
+    services: *db_services
+  - env:      prd
+    role:     ap
+    ip:       192.168.1.101
+    user:     root
+    password: vagrant
+    services: *ap_services
+  - env:      prd
+    role:     db
+    ip:       192.168.1.101
+    user:     root
+    password: vagrant
+    services: *db_services

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: systemd_service_check
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - k-ta-yamada
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-01-28 00:00:00.000000000 Z
+date: 2018-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: capture_stdout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-doc
   requirement: !ruby/object:Gem::Requirement
@@ -164,9 +192,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |-
-  This gem provide `ssc` command to check multiple `systemd service` \
-      etc on multiple remote servers using net-ssh.
+description: This gem provide `ssc` command to check multiple `systemd service` etc
+  on multiple remote servers using net-ssh.
 email:
 - key.luvless@gmail.com
 executables:
@@ -178,6 +205,7 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -188,9 +216,9 @@ files:
 - bin/setup
 - bin/ssc
 - lib/systemd_service_check.rb
-- lib/systemd_service_check/CHANGELOG.md
-- lib/systemd_service_check/base.rb
 - lib/systemd_service_check/cli.rb
+- lib/systemd_service_check/ssh.rb
+- lib/systemd_service_check/utils.rb
 - lib/systemd_service_check/version.rb
 - lib/table_print-patch-pr70/column.rb
 - lib/table_print-patch-pr70/formatter.rb
@@ -208,7 +236,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -219,6 +247,6 @@ rubyforge_project:
 rubygems_version: 2.7.3
 signing_key:
 specification_version: 4
-summary: This gem provide `ssc` command to check multiple `systemd service` \ etc
-  on multiple remote servers using net-ssh.
+summary: This gem provide `ssc` command to check multiple `systemd service` etc on
+  multiple remote servers using net-ssh.
 test_files: []

data/lib/systemd_service_check/base.rb DELETED

@@ -1,110 +0,0 @@
-require 'net/ssh'
-require 'thor'
-require 'yaml'
-require 'json'
-require 'pry' # forDebug
-# SystemdServiceCheck
-module SystemdServiceCheck
-  # Base
-  class Base
-    class InvalidOption < StandardError; end
-    Server  = Struct.new(:env, :ip, :user, :options, :services, :hostname)
-    Service = Struct.new(:service_name, :load_state, :active_state, :sub_state, :unit_file_state, :type)
-    Result  = Struct.new(:server, :services)
-    # TODO: systemctl show -p
-    STATES    = %w[LoadState ActiveState SubState UnitFileState Type].freeze
-    # TODO: setting by yaml
-    SHOW_GREP = /env/i
-    attr_reader :argv, :env_names, :servers, :target_env, :target_servers, :results
-    def initialize(argv, yaml)
-      @argv           = argv || []
-      @env_names      = []
-      @servers        = []
-      @target_env     = []
-      @target_servers = []
-      @results        = []
-      raise InvalidOption if yaml.nil? || yaml.empty?
-      load_settings(yaml)
-      configure_target_servers
-      run
-    rescue InvalidOption => e
-      puts "<#{e}>",
-           "  Argument yaml must not be nil or empty.",
-           "  yaml.class: [#{yaml.class}]"
-      puts "  #{e.backtrace_locations.first}"
-    end
-    def run
-      @results = @target_servers.map { |server| ssh(server) }
-    end
-    def to_json
-      @results.map do |result|
-        { server:   result.server.to_h,
-          services: result.services.map(&:to_h) }
-      end.to_json
-    end
-    private
-    def load_settings(file) # rubocop:disable Metrics/AbcSize
-      yaml = JSON.parse(YAML.load_file(File.expand_path(file)).to_json,
-                        symbolize_names: true)
-      @env_names = yaml[:servers].map { |s| s[:env] }.uniq
-      @servers   = yaml[:servers].map do |s|
-        raise InvalidOption, "ENV: #{s[:env]}" if [s[:password], s[:key]].all?(nil)
-        options = { password: s[:password], keys: [s[:key] || ""] }
-        Server.new(s[:env], s[:ip], s[:user], options, s[:services])
-      end
-    end
-    def configure_target_servers
-      configure_target_env
-      @target_servers = @servers.select { |s| @target_env.include?(s[:env]) }
-    end
-    def configure_target_env
-      @target_env = @env_names & @argv
-      # If there is no argument.
-      @target_env = @env_names.first if @target_env.empty? && @argv.empty?
-      # If there is only one argument and it is `all`.
-      @target_env = @env_names if @argv.size == 1 && argv.first == 'all'
-    end
-    def ssh(server)
-      services = []
-      Net::SSH.start(server[:ip], server[:user], server[:options]) do |ssh|
-        server[:hostname] = ssh.exec!('hostname').chop
-        services = server[:services].map { |service_name| systemd(ssh, service_name) }
-        # TODO: store in Result object
-        # puts ssh.exec!("systemctl list-timers")
-      end
-      Result.new(server, services)
-    end
-    def systemd(ssh, service_name)
-      states = ssh.exec!("systemctl show #{service_name} -p #{STATES.join(",")}")
-                  .split("\n")
-                  .map { |v| v.split("=") }
-                  .map { |v| [Thor::Util.snake_case(v[0]).to_sym, v[1]] }
-                  .each_with_object({}) { |(k, v), memo| memo[k] = v }
-      Service.new(
-        service_name,
-        states[:load_state],
-        states[:active_state],
-        states[:sub_state],
-        states[:unit_file_state] || "n/a",
-        states[:type] || "n/a"
-      )
-    end
-  end
-end