procsd 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb2d76f653bcd73538afe6175c6e910bf77bbe86930238bfd7ec53f2bef8e939
-  data.tar.gz: 805808a883ea1f4c8ae03a01a390dda70729dea2a948e16e24c2b392791fa7cb
+  metadata.gz: 2c4a1dba4f8d57cec70cebb0cffd95d3f6e51ab256f534790bac042ec11078e2
+  data.tar.gz: 40ca2c7432f1ab690c61b073d305245a2b74e957627cd286907ee0e5c1ca3c61
 SHA512:
-  metadata.gz: 4e8e6057f5bc9d8a3d466a7f57fb958f0335812a11412ab1b71ef4fa4ea3a77afe37b4d49725f2c144014afcd1ede0f218fc1c3165dbf10df7608c6763848543
-  data.tar.gz: 32559bb91e97ed3cc238849b5bbc55609cafb27bd0ae25414cdf9fcf91e6205a35b0b6cec65fd9b6339fb153bc5eb8e5a8cfdc3851296bb8df9dad7ae00e6cb1
+  metadata.gz: ecbf43025ab6387543cec6775655575af81cb12f590828f4f00fbf5261444d3e06427c252f095fd943493963822f703f87532fe4c8ff7afb6b8c2c8c139cf8e8
+  data.tar.gz: 01c8d0561473679da4dcae1203fccf4f8168b72c9e298719459eba1ca4774e934b2c32db3e3536ed6a1d4a40361d264019042f5e73a7f93656da9b5cbb5f6c23

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# CHANGELOG
+## 0.2.0
+* Allow to use erb inside .procsd.yml
+* Add dotenv support
+* Add VERBOSE option to print commands before execution
+* Implement option to provide restart/stop commands in the Procfile (extended syntax)
+* Add list command
+*  Add sudo to `status` and `logs` commands to show system messages as well
+* Add --short option to the `status` command

data/README.md

@@ -28,9 +28,9 @@ environment:
 ```
 > The only required option in `.procsd.yml` is `app` (application's name). Also you can provide custom Systemd directory path (`systemd_dir` option, default is _/etc/systemd/system_)
 
+Configuration is done.
 
-
-Configuration is done. Now it's time to **create** an application (export it to Systemd):
+### Create an application (export to Systemd)
 > To disable and remove application from Systemd there is command `$ procsd destroy`.
 
 > Note: `create` command needs to provide a few arguments: _--user_ (name of the current user), _--dir_ (application's working directory) and `--path` (user's $PATH). Usually it's fine to provide them like on example below:
@@ -49,8 +49,7 @@ Reloaded configuraion (daemon-reload)
 App services were created and enabled. Run `start` to start them
 ```
 
-
-**Start** application services:
+### Start application
 > Other control commands: `stop` and `restart`
 
 ```
@@ -60,7 +59,7 @@ Started app services (sample_app.target)
 ```
 
 
-Check the **status**:
+### Check the status
 > You can filter processes, like `$ procsd status worker` (show status only for worker processes) or `$ procsd status worker.2` (show status only for worker.2 process)
 
 > To show status of the main application target: `$ procsd status --target`
@@ -121,8 +120,18 @@ deploy@server:~/sample_app$ procsd status
 2018-11-04T01:54:17+0400 sample_app-worker.2[8827]: 2018-11-03T21:54:17.716Z 8827 TID-gniahzm1r INFO: Starting processing, hit Ctrl-C to stop
 ```
 
+Also you can see status in a short format:
 
-Now the interesting part, **logs**:
+```
+deploy@server:~/sample_app$ procsd status --short
+
+sample_app-web.1.service    loaded active running sample_app-web.1.service
+sample_app-worker.1.service loaded active running sample_app-worker.1.service
+sample_app-worker.2.service loaded active running sample_app-worker.2.service
+```
+
+
+### Check the logs
 > Like with command `status`, you can filter logs by passing the name of process as an argument: `$ procsd logs web` (show logs only for web processes, if any)
 
 ```
@@ -172,6 +181,7 @@ Commands:
   procsd disable                                               # Disable app target
   procsd enable                                                # Enable app target
   procsd help [COMMAND]                                        # Describe available commands or one specific command
+  procsd list                                                  # List all app services
   procsd logs                                                  # Show app services logs
   procsd restart                                               # Restart app services
   procsd start                                                 # Start app services
@@ -194,11 +204,37 @@ Procsd following one rule: simplicity. For export it uses static service files (
 ## Notes
 
 * If you want to set environment variables per process, [use format](https://github.com/ddollar/foreman/wiki/Per-Process-Environment-Variables) like Foreman recommends.
+* To print commands before execution, provide env variable `VERBOSE=true` before procsd command. Example:
+
+```
+deploy@server:~/sample_app$ VERBOSE=true procsd logs -n 3
+
+> Executing command: journalctl --no-pager --all --no-hostname --output short-iso -n 3 --unit sample_app-web.1.service --unit sample_app-worker.1.service --unit sample_app-worker.2.service
+
+-- Logs begin at Sun 2018-10-21 00:38:42 +04, end at Sun 2018-11-04 19:17:01 +04. --
+2018-11-04T19:11:59+0400 sample_app-worker.2[29907]: 2018-11-04T15:11:59.597Z 29907 TID-gne5aeyuz INFO: Upgrade to Sidekiq Pro for more features and support: http://sidekiq.org
+2018-11-04T19:11:59+0400 sample_app-worker.2[29907]: 2018-11-04T15:11:59.597Z 29907 TID-gne5aeyuz INFO: Booting Sidekiq 5.2.2 with redis options {:id=>"Sidekiq-server-PID-29907", :url=>nil}
+2018-11-04T19:11:59+0400 sample_app-worker.2[29907]: 2018-11-04T15:11:59.601Z 29907 TID-gne5aeyuz INFO: Starting processing, hit Ctrl-C to stop
+```
+* You can use extended format of a Procfile to provide additional restart/stop commands for a process:
+> Keep in mind that syntax below is not supported by Foreman or Heroku
+
+> All possible options: `start`, `restart` and `stop`
+
+```yml
+web:
+  start: bundle exec rails server -p $PORT
+  restart: bundle exec pumactl phased-restart
+worker: bundle exec sidekiq -e production
+```
+
+Why? For example default Ruby on Rails application server [Puma](http://puma.io/) supports [Phased or Rolling restart](https://github.com/puma/puma/blob/master/docs/restart.md#normal-vs-hot-vs-phased-restart) feature. If you provide separate `restart`command for a process, then this command will be called (`$ procsd restart`) by Systemd instead of just killing and starting process again.
+
 
 ## ToDo
 * Add Capistrano integration examples
 * Optional possibility to generate Ngnix config (with out-of-box SSL using [Certbot](https://certbot.eff.org/lets-encrypt/ubuntubionic-nginx)) for an application to use Ngnix as a proxy and serve static files
-* Add integration with [Inspeqtor](https://github.com/mperham/inspeqtor) to monitor application services and get alert notifications if someting happened
+* Add integration with [Inspeqtor](https://github.com/mperham/inspeqtor) to monitor application services and get alert notifications if something happened
 
 
 ## License

data/lib/procsd.rb

@@ -1,3 +1,4 @@
+require 'dotenv/load'
 require 'thor'
 require 'procsd/version'
 

data/lib/procsd/cli.rb

@@ -1,4 +1,5 @@
 require 'yaml'
+require 'erb'
 require_relative 'generator'
 
 module Procsd
@@ -18,7 +19,7 @@ module Procsd
         gen.export!(services, procsd: @procsd, options: options)
 
         enable
-        if system "sudo", "systemctl", "daemon-reload"
+        if execute %w(sudo systemctl daemon-reload)
           say("Reloaded configuraion (daemon-reload)", :green)
         end
 
@@ -39,12 +40,12 @@ module Procsd
         services.keys.push(target_name).each do |filename|
           path = File.join(systemd_dir, filename)
           if File.exist? path
-            system "sudo", "rm", path
+            execute %W(sudo rm #{path})
             say "Deleted #{path}"
           end
         end
 
-        if system "sudo", "systemctl", "daemon-reload"
+        if execute %w(sudo systemctl daemon-reload)
           say("Reloaded configuraion (daemon-reload)", :green)
         end
 
@@ -62,7 +63,7 @@ module Procsd
       if target_enabled?
         say "App target #{target_name} already enabled"
       else
-        if system "sudo", "systemctl", "enable", target_name
+        if execute %W(sudo systemctl enable #{target_name})
           say("Enabled app target #{target_name}", :green)
         end
       end
@@ -76,7 +77,7 @@ module Procsd
       if !target_enabled?
         say "App target #{target_name} already disabled"
       else
-        if system "sudo", "systemctl", "disable", target_name
+        if execute %W(sudo systemctl disable #{target_name})
           say("Disabled app target #{target_name}", :green)
         end
       end
@@ -90,7 +91,7 @@ module Procsd
       if target_active?
         say "Already started/active (#{target_name})"
       else
-        if system "sudo", "systemctl", "start", target_name
+        if execute %W(sudo systemctl start #{target_name})
           say("Started app services (#{target_name})", :green)
         end
       end
@@ -104,7 +105,7 @@ module Procsd
       if !target_active?
         say "Already stopped/inactive (#{target_name})"
       else
-        if system "sudo", "systemctl", "stop", target_name
+        if execute %W(sudo systemctl stop #{target_name})
           say("Stopped app services (#{target_name})", :green)
         end
       end
@@ -115,18 +116,34 @@ module Procsd
       preload!
       say_target_not_exists and return unless target_exist?
 
-      if system "sudo", "systemctl", "restart", target_name
+      # If one of the child services of a target has `ExecReload` and `ReloadPropagatedFrom`
+      # options defined, then use `reload-or-restart` to call all services (not the main target)
+      # because https://github.com/systemd/systemd/issues/10638
+      success =
+        if services.any? { |_, command| command["restart"] }
+          execute %w(sudo systemctl reload-or-restart) + services.keys
+        else
+          execute %W(sudo systemctl restart #{target_name})
+        end
+
+      if success
         say("Restarted app services (#{target_name})", :green)
       end
     end
 
     desc "status", "Show app services status"
-    option :target, type: :string, banner: "Show main target status"
+    option :target, type: :boolean, banner: "Show main target status"
+    option :short,  type: :boolean, banner: "Show services three and their status shortly"
     def status(service_name = nil)
       preload!
       say_target_not_exists and return unless target_exist?
 
-      command = %w(systemctl status --no-pager --output short-iso)
+      if options["short"]
+        command = %w(sudo systemctl list-units --no-pager --no-legend --all)
+      else
+        command = %w(sudo systemctl status --no-pager --output short-iso)
+      end
+
       if options["target"]
         command << target_name
       else
@@ -135,7 +152,7 @@ module Procsd
         command += filtered
       end
 
-      system *command
+      execute command
     end
 
     desc "logs", "Show app services logs"
@@ -147,7 +164,7 @@ module Procsd
     def logs(service_name = nil)
       preload!
 
-      command = %w(journalctl --no-pager --all --no-hostname --output short-iso)
+      command = %w(sudo journalctl --no-pager --all --no-hostname --output short-iso)
       command.push("-n", options.fetch("num", "100"))
       command.push("-f") if options["tail"]
       command.push("--system") if options["system"]
@@ -158,7 +175,15 @@ module Procsd
       say("Can't find any services matching given name: #{service_name}", :red) and return if filtered.empty?
 
       filtered.each { |service| command.push("--unit", service) }
-      system *command
+      execute command
+    end
+
+    desc "list", "List all app services"
+    def list
+      preload!
+      say_target_not_exists and return unless target_exist?
+
+      execute %W(sudo systemctl list-dependencies #{target_name})
     end
 
     desc "--version, -v", "Print the version"
@@ -168,6 +193,11 @@ module Procsd
 
     private
 
+    def execute(command)
+      say("> Executing command: `#{command.join(' ')}`", :yellow) if ENV["VERBOSE"] == "true"
+      system *command
+    end
+
     def say_target_not_exists
       say("App target #{target_name} is not exists", :red)
     end
@@ -221,9 +251,19 @@ module Procsd
       raise ConfigurationError, ".procsd.yml config file doesn't exists" unless File.exist? ".procsd.yml"
 
       @procfile = YAML.load_file("Procfile")
-      @procsd = YAML.load_file(".procsd.yml")
+      @procsd = YAML.load(ERB.new(File.read ".procsd.yml").result)
       raise ConfigurationError, "Missing app name in the .procsd.yml file" unless @procsd["app"]
 
+      @procfile.each do |process_name, process_command|
+        if process_command.kind_of?(Hash)
+          unless process_command["start"]
+            raise ConfigurationError, "Missing start command for #{process_name} process in the Procfile"
+          end
+        else
+          @procfile[process_name] = { "start" => process_command }
+        end
+      end
+
       if formation = @procsd["formation"]
         @procsd["formation"] = formation.split(",").map { |f| f.split("=") }.to_h
         @procsd["formation"].each { |k, v| @procsd["formation"][k] = v.to_i }

data/lib/procsd/templates/service.erb

@@ -1,12 +1,22 @@
 [Unit]
 Requires=network.target
 PartOf=<%= config["target_name"] %>
+<% if config["command"]["restart"] -%>
+ReloadPropagatedFrom=<%= config["target_name"] %>
+<% end -%>
 
 [Service]
 Type=simple
 User=<%= config["user"] %>
 WorkingDirectory=<%= config["dir"] %>
-ExecStart=/bin/bash -lc '<%= config["command"] %>'
+
+ExecStart=/bin/bash -lc '<%= config["command"]["start"] %>'
+<% if stop = config["command"]["stop"] -%>
+ExecStop=/bin/bash -lc '<%= stop %>'
+<% end -%>
+<% if config["command"]["restart"] -%>
+ExecReload=/bin/bash -lc '<%= config["command"]["restart"] %>'
+<% end -%>
 
 Restart=always
 RestartSec=1

data/lib/procsd/version.rb

@@ -1,3 +1,3 @@
 module Procsd
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/procsd.gemspec

@@ -25,6 +25,8 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.3.0"
 
   spec.add_dependency "thor"
+  spec.add_dependency "dotenv"
+
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: procsd
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Victor Afanasev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-04 00:00:00.000000000 Z
+date: 2018-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +89,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md