kanrisuru-nginx 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25af3e0b62199606e8d1bbaddd43c4b92f8029957ea3c45b98c93e85aa2ff6c4
-  data.tar.gz: 52cfa335a7440f3849572ec1bfab5789cd0f12ab3a815aa7b8fcb70002862a96
+  metadata.gz: bba2b97f8861c1068bca148978a979b97f402f7720acf882c1669cd98a5df176
+  data.tar.gz: 7846c49f88a0693ec738f7c4e04227e5c980f3c9cfa04003f012f331380d1f22
 SHA512:
-  metadata.gz: ee9b03d5a717b10f4c82f4e8b8ab1a29687945a8583560b3e90051a0fe9321f79301d87699fcac07fa91eb62b521279dc2e7079bce2c41e25fb90b85f7e377ba
-  data.tar.gz: 45b2046ece2cdd916e833914b8997f2ae6b448f12afa9ff8bfcf23411f5181a605b5ca25c9dfe920c74b073106ed0be3022d603805bd10412b78d1203f711c76
+  metadata.gz: a74bcd06e769edfc2d7825ca623308a8723dd7687afbcd12be1f1414ac64e167d2c937400fa38602120de9d92729f4c1f43e7b8cd65fb345e83b105135d9e62d
+  data.tar.gz: 5b0101ab11d8c725eb7f83274f9f8c7f85de6c481caace11228f40092d9949ef230abbd0faf24c4241414a389714fd79dbc97666d296234567a430a6e737d74f

data/.rubocop.yml

@@ -1,13 +1,68 @@
+require: rubocop-rspec
+
 AllCops:
-  TargetRubyVersion: 2.4
+  NewCops: enable
+  SuggestExtensions: false
 
 Style/StringLiterals:
   Enabled: true
-  EnforcedStyle: double_quotes
+  EnforcedStyle: single_quotes 
 
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
+Style/Documentation:
+  Enabled: false
+
+Style/WordArray:
+  Exclude:
+    - lib/kanrisuru/util/dmi_type.rb
+
+Lint/SymbolConversion:
+  Exclude:
+    - lib/kanrisuru/util/dmi_type.rb
+
+Naming/InclusiveLanguage:
+  Exclude:
+    - lib/kanrisuru/core/dmi.rb
+    - spec/unit/core/dmi_spec.rb
+
+Naming/MethodParameterName:
+  Exclude:
+    - spec/functional/os_package_spec.rb
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
+
+RSpec/FilePath:
+  SpecSuffixOnly: true
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations: 
+  Enabled: false
+
+RSpec/BeforeAfterAll:
+  Enabled: false
 
-Layout/LineLength:
-  Max: 120
+RSpec/LeakyConstantDeclaration:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,5 @@
-## [Unreleased]
+## 0.2.0 (August 09, 2021) ##
+* Create working version of kanrisuru-nginx, publish to rubygems.org
 
-## [0.1.0] - 2021-08-08
-
-- Initial release
+## 0.1.0 (August 08, 2021) ##
+* Initialize repository, start working on project.

data/Gemfile

@@ -1,12 +1,4 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in kanrisuru-nginx.gemspec
+source 'https://rubygems.org'
 gemspec
-
-gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.7"

data/README.md

@@ -1,8 +1,6 @@
 # Kanrisuru::Nginx
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/kanrisuru/nginx`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This project helps you manage your remote Nginx webservers. Built ontop of the [Kanrisuru library](https://github.com/avamia/kanrisuru), it utilizes the core set of commands to install, service and configure the Nginx webserver.
 
 ## Installation
 
@@ -22,8 +20,168 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The nginx module is namespaced on a `host` and `cluster` instance under the `nginx` name.
+
+### Requirment
+
+To use `Kanrisuru::Nginx` in your project, make sure to include both projects to manage the infrastructure. 
+```ruby
+require 'kanrisuru'
+require 'kanrisuru-nginx'
+```
+
+Most commands with nginx need to be run as root, so don't forget to call the `su` method before running the nginx module.
+
+### Package Installation
+Installation of the nginx package is straightforward.  You can check if the package is installed directly with the `installed?` method.
+
+```ruby
+host.su('root')
+host = Kanrisuru::Remote::Host.new(host: 'centos-host', username: 'centos', keys: ['~/.ssh/id-rsa'])
+
+host.nginx.installed?
+# => false
+
+result = host.nginx.install
+result.success?
+# => true 
+
+host.nginx.installed?
+# => true
+```
+
+The installation is installed via the `apt`, `yum`, and `zypper` package managers for their respective linux distribution types, namely:
+| Package Manager | OS Distro |
+|-----------------|-----------|
+| `apt` | debian |
+| `apt` | ubuntu |
+| `yum` | centos |
+| `yum` | redhat |
+| `yum` | fedora |
+| `zypper` | opensuse |
+| `zypper` | SUSE Enterprise Linux |
+
+With Kanrisuru, the `os_include` and `os_define` takes care of figuring out which linux distro and release should be used with the corresponding install method, so you only need to call `host.nginx.install` for it to work. 
+
+### Package Removal
+To remove an installed version of Nginx, call:
+```ruby
+host.nginx.installed?
+# => true
+
+host.nginx.remove
+
+host.nginx.installed?
+# => false
+``` 
+
+Note that if Nginx is running while calling remove, it will automatically stop any master / worker processes that are running before removing the package.
+
+### Service Methods
+To service the nginx webserver, the following commands help you easily start, stop, and restart the webserver
+```ruby
+host.nginx.running?
+# => false
 
+## Start the webserver
+result = host.nginx.start
+result.success?
+# => true
+
+host.nginx.running?
+# => true
+
+host.nginx.master_pid
+# => 1337
+
+result = host.nginx.restart
+result.success?
+# => true
+
+host.nginx.master_pid
+# => 4343
+
+result = host.nginx.stop
+result.success?
+# => true
+
+host.nginx.running?
+# => false
+```
+
+You can test to see if the current configuration files are properly formatted
+```ruby
+result = host.nginx.test
+result.success?
+# => true
+
+result = host.nginx.test(config: '~/test.conf')
+result.success?
+# => true
+```
+
+To reload the nginx workers with updated configuration files, but not a full restart
+```ruby
+host.nginx.master_pid
+# => 4343
+
+result = host.nginx.reload
+result.success?
+# => true
+
+host.nginx.master_pid
+# => 4343
+``` 
+
+### Configuration Management
+This is currently in development and is the focus of the next release for this module.
+
+### Utilities
+You can fetch the master and worker process information
+```ruby
+host.nginx.master_process
+#<Struct:Kanrisuru::Core::System::ProcessInfo:0x000005f0
+  ppid = 1,
+  command = "nginx: master process nginx",
+  cpu_time = "00:00:00",
+  cpu_usage = 0.0,
+  flags = 1,
+  gid = 0,
+  group = "root",
+  memory_usage = 0.0,
+  pid = 20484,
+  policy = "SCHED_OTHER",
+  policy_abbr = "TS",
+  priority = 19,
+  stat = "Ss",
+  uid = 0,
+  user = "root"
+>
+
+host.nginx.master_pid
+# => 20484
+
+host.nginx.worker_processess
+[
+  #<Struct:Kanrisuru::Core::System::ProcessInfo:0x0000f4d8
+    ppid = 20484,
+    command = "nginx: worker process",
+    cpu_time = "00:00:00",
+    cpu_usage = 0.0,
+    flags = 5,
+    gid = 994,
+    group = "nginx",
+    memory_usage = 0.0,
+    pid = 20485,
+    policy = "SCHED_OTHER",
+    policy_abbr = "TS",
+    priority = 19,
+    stat = "S",
+    uid = 997,
+    user = "nginx"
+  >
+]
+```
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -32,7 +190,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/kanrisuru-nginx. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/kanrisuru-nginx/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/avamia/kanrisuru-nginx. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/avamia/kanrisuru-nginx/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -40,4 +198,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Kanrisuru::Nginx project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/kanrisuru-nginx/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Kanrisuru::Nginx project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/avamia/kanrisuru-nginx/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "bundler/setup"
-require "kanrisuru/nginx"
+require 'bundler/setup'
+require 'kanrisuru/nginx'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -11,5 +11,5 @@ require "kanrisuru/nginx"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/kanrisuru-nginx.gemspec

@@ -8,20 +8,20 @@ Gem::Specification.new do |gem|
   gem.author      = 'Ryan Mammina'
   gem.email       = 'ryan@avamia.com'
   gem.license     = 'MIT'
-  gem.summary     = 'Manage nginx webservers with kanrisuru.'
-  gem.description = 'Manage nginx webservers with kanrisuru.'
+  gem.summary     = 'Manage remote nginx webservers with kanrisuru.'
+  gem.description = 'Manage remote nginx webservers with kanrisuru.'
   gem.homepage    = 'https://github.com/avamia/kanrisuru-nginx'
 
-  gem.required_ruby_version = ">= 2.5.0"
+  gem.required_ruby_version = '>= 2.5.0'
 
   gem.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
 
   gem.executables   = gem.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
 
-  gem.add_dependency "kanrisuru", "~> 0.6"
+  gem.add_dependency 'kanrisuru', '~> 0.7.3'
 
   gem.add_development_dependency 'rspec', '~> 3.10'
   gem.add_development_dependency 'rubocop', '~> 1.12'
@@ -33,5 +33,4 @@ Gem::Specification.new do |gem|
     'changelog_uri' => 'https://github.com/avamia/kanrisuru-nginx/blob/master/CHANGELOG.md',
     'homepage_uri' => gem.homepage
   }
-
 end

data/lib/kanrisuru/nginx.rb

@@ -1,10 +1,23 @@
 # frozen_string_literal: true
 
-require_relative "nginx/version"
+require_relative 'nginx/version'
+require_relative 'nginx/signal'
+require_relative 'nginx/package'
+require_relative 'nginx/service'
 
 module Kanrisuru
   module Nginx
-    class Error < StandardError; end
-    # Your code goes here...
+  end
+
+  module Remote
+    class Host
+      os_include Kanrisuru::Nginx::Package, namespace: :nginx
+      os_include Kanrisuru::Nginx::Service, namespace: :nginx
+    end
+
+    class Cluster
+      os_collection Kanrisuru::Nginx::Package, namespace: :nginx
+      os_collection Kanrisuru::Nginx::Service, namespace: :nginx
+    end
   end
 end

data/lib/kanrisuru/nginx/package.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Nginx
+    module Package
+      extend OsPackage::Define
+
+      os_define :linux, :version
+
+      os_define :debian, :apt_installed?,    alias: :installed?
+      os_define :fedora, :yum_installed?,    alias: :installed?
+      os_define :sles,   :zypper_installed?, alias: :installed?
+
+      os_define :debian, :apt_install,    alias: :install
+      os_define :fedora, :yum_install,    alias: :install
+      os_define :sles,   :zypper_install, alias: :install
+
+      os_define :debian, :apt_update,    alias: :update
+      os_define :fedora, :yum_update,    alias: :update
+      os_define :sles,   :zypper_update, alias: :update
+
+      os_define :debian, :apt_remove,    alias: :remove
+      os_define :fedora, :yum_remove,    alias: :remove
+      os_define :sles,   :zypper_remove, alias: :remove
+
+      def apt_installed?
+        result = @host.apt('list', installed: true, packages: ['nginx'])
+        return false if result.failure?
+
+        package = result.find { |item| item.package == 'nginx' }
+        Kanrisuru::Util.present?(package) && package.installed == true
+      end
+
+      def yum_installed?
+        result = @host.yum('list', installed: true, query: 'nginx')
+        return false if result.failure?
+
+        package = result.find { |item| item.package == 'nginx' }
+        Kanrisuru::Util.present?(package)
+      end
+
+      def zypper_installed?
+        result = @host.zypper('info', packages: ['nginx'])
+        return false if result.failure?
+
+        package = result.find { |item| item.package == 'nginx' }
+        Kanrisuru::Util.present?(package) && package.installed == true
+      end
+
+      def version
+        command = Kanrisuru::Command.new('nginx -v')
+
+        @host.execute_shell(command)
+
+        Kanrisuru::Result.new(command) do |cmd|
+          values = cmd.to_s.split('/')
+          values[1].to_f
+        end
+      end
+
+      def apt_install
+        @host.apt('install', packages: ['nginx'])
+      end
+
+      def yum_install
+        @host.yum('install', packages: ['nginx'])
+      end
+
+      def zypper_install
+        @host.zypper('install', packages: ['nginx'])
+      end
+
+      def apt_update
+        @host.apt('update')
+      end
+
+      def yum_update
+        @host.yum('update')
+      end
+
+      def zypper_update
+        @host.zypper('update')
+      end
+
+      def apt_remove
+        if @host.nginx.running?
+          result = @host.nginx.stop
+          return result unless result.success?
+        end
+
+        @host.apt('purge', packages: %w[nginx nginx-common])
+      end
+
+      def yum_remove
+        if @host.nginx.running?
+          result = @host.nginx.stop
+          return result unless result.success?
+        end
+
+        @host.yum('remove', packages: ['nginx'])
+      end
+
+      def zypper_remove
+        if @host.nginx.running?
+          result = @host.nginx.stop
+          return result unless result.success?
+        end
+
+        @host.zypper('remove', packages: ['nginx'])
+      end
+    end
+  end
+end

data/lib/kanrisuru/nginx/service.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Nginx
+    module Service
+      extend OsPackage::Define
+
+      os_define :linux, :start
+      os_define :linux, :stop
+      os_define :linux, :quit
+      os_define :linux, :restart
+      os_define :linux, :reload
+      os_define :linux, :test
+
+      os_define :linux, :running?
+      os_define :linux, :master_process
+      os_define :linux, :master_pid
+      os_define :linux, :worker_processess
+
+      def start(opts = {})
+        command = Kanrisuru::Command.new('nginx')
+        command.append_arg('-c', opts[:config])
+
+        @host.execute_shell(command)
+
+        Kanrisuru::Result.new(command)
+      end
+
+      def test(opts = {})
+        command = Kanrisuru::Command.new('nginx')
+        command.append_arg('-c', opts[:config])
+        command.append_flag('-t')
+
+        @host.execute_shell(command)
+
+        Kanrisuru::Result.new(command)
+      end
+
+      def stop
+        command = Kanrisuru::Command.new('nginx')
+        command.append_arg('-s', 'stop')
+
+        @host.execute_shell(command)
+
+        Kanrisuru::Result.new(command)
+      end
+
+      def restart(opts = {})
+        return false unless running?
+
+        result = stop
+        return false unless result.success?
+
+        start(opts)
+      end
+
+      def reload(opts = {})
+        command = Kanrisuru::Command.new('nginx')
+        command.append_arg('-c', opts[:config])
+        command.append_arg('-s', 'reload')
+
+        @host.execute_shell(command)
+
+        Kanrisuru::Result.new(command)
+      end
+
+      def running?
+        process = master_process
+        return false if !process || process.instance_of?(Kanrisuru::Result)
+
+        process.respond_to?(:pid) &&
+          process.pid >= 0
+      end
+
+      def master_process
+        result = @host.ps
+        return result if result.failure?
+
+        result.find { |process| process.command.include?('nginx: master') }
+      end
+
+      def master_pid
+        process = master_process
+        return unless process.instance_of?(Kanrisuru::Core::System::ProcessInfo)
+
+        process.pid
+      end
+
+      def worker_processess
+        result = @host.ps
+        return result if result.failure?
+
+        result.select { |process| process.command.include?('nginx: worker') }
+      end
+    end
+  end
+end

data/lib/kanrisuru/nginx/signal.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Nginx
+    module Signal
+      SIGHUP = 'reload'
+      SIGQUIT = 'quit'
+      SIGTERM = 'stop'
+      SIGUSR1 = 'reopen'
+      SIGUSR2 = 'upgrade'
+    end
+  end
+end

data/lib/kanrisuru/nginx/version.rb

@@ -2,6 +2,6 @@
 
 module Kanrisuru
   module Nginx
-    VERSION = "0.1.0"
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanrisuru-nginx
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ryan Mammina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-08 00:00:00.000000000 Z
+date: 2021-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kanrisuru
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.7.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.7.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.21'
-description: Manage nginx webservers with kanrisuru.
+description: Manage remote nginx webservers with kanrisuru.
 email: ryan@avamia.com
 executables: []
 extensions: []
@@ -99,6 +99,9 @@ files:
 - bin/setup
 - kanrisuru-nginx.gemspec
 - lib/kanrisuru/nginx.rb
+- lib/kanrisuru/nginx/package.rb
+- lib/kanrisuru/nginx/service.rb
+- lib/kanrisuru/nginx/signal.rb
 - lib/kanrisuru/nginx/version.rb
 homepage: https://github.com/avamia/kanrisuru-nginx
 licenses:
@@ -125,5 +128,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Manage nginx webservers with kanrisuru.
+summary: Manage remote nginx webservers with kanrisuru.
 test_files: []