nginx_stage 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa24a601f96e88b6ce80144643c1050d40610662
-  data.tar.gz: c57cffe3cdd786e2871920b6867e0707e7a25864
+  metadata.gz: c9b3919f81c64e84a2280becde57f2d6aac9a346
+  data.tar.gz: 8f7677d4b45de1c348c3e03d7d0cf537415be9f7
 SHA512:
-  metadata.gz: e139fd36c641d1a715afab850616b5aeb69d5a4241c06eb095317ee6007da4b5b2ed823a7637c2117b629be2ce7b7c007543b577813881e26931f5ff32bcf017
-  data.tar.gz: 9e102f6f33a6b43bfb5bb5d5b354061e415cae2074472ae375fa78ec2e2dbd9ca9a9a57fb2d3a43fec6a6028df729c6428d789b7d51282a633703cb0cfc56cdb
+  metadata.gz: 2746bb855832210d40d2d62bc22a31b4270d8b535c54c168a7bfcfec0ec4b5bce1042edec794d8b54d9ded05d5cb56d7993b58be3901c2db000cc96ac3621d4c
+  data.tar.gz: c294a4171c99ef1b5acb3abf726fa9df3488b6d06faa6db286346675a2861799b1773c15dbd3d8f5c52936343a9ce01c0dc0afaf5cb37172fff94fc7d4475545

data/CHANGELOG.md

@@ -6,6 +6,28 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [0.4.0] - 2018-02-09
+### Added
+- Added helpful utility for performing the necessary operations when updating
+  NGINX configs.
+
+### Changed
+- Updated date in `LICENSE.txt`.
+
+## [0.3.2] - 2017-12-07
+### Changed
+- Combined the Ruby wrapper script with the `nginx_stage` executable script.
+  [#27](https://github.com/OSC/nginx_stage/issues/27)
+
+### Fixed
+- Display error if the user's home directory does not exist.
+  [#25](https://github.com/OSC/nginx_stage/issues/25)
+
+## [0.3.1] - 2017-11-27
+### Changed
+- Replaced all occurrences of `Fixnum` with `Integer` to better support Ruby
+  2.4+. [#29](https://github.com/OSC/nginx_stage/issues/29)
+
 ## [0.3.0] - 2017-10-30
 ### Added
 - Added a confirmation page when attempting to restart PUN due to discovery of
@@ -180,7 +202,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - Initial release
 
-[Unreleased]: https://github.com/OSC/nginx_stage/compare/v0.3.0...HEAD
+[Unreleased]: https://github.com/OSC/nginx_stage/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/OSC/nginx_stage/compare/v0.3.2...v0.4.0
+[0.3.2]: https://github.com/OSC/nginx_stage/compare/v0.3.1...v0.3.2
+[0.3.1]: https://github.com/OSC/nginx_stage/compare/v0.3.0...v0.3.1
 [0.3.0]: https://github.com/OSC/nginx_stage/compare/v0.2.1...v0.3.0
 [0.2.1]: https://github.com/OSC/nginx_stage/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/OSC/nginx_stage/compare/v0.1.0...v0.2.0

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016-2017 Ohio Supercomputer Center
+Copyright (c) 2016-2018 Ohio Supercomputer Center
 
 MIT License
 

data/Rakefile

@@ -26,7 +26,7 @@ task :install => [:required_files] do
 end
 
 # Dynamically generate tasks for copying required files
-FileList['sbin/nginx_stage', 'bin/*', 'share/*', 'templates/*.erb', 'lib/**/*.rb'].each do |source|
+FileList['sbin/*', 'bin/*', 'share/*', 'templates/*.erb', 'lib/**/*.rb'].each do |source|
   target = "#{PREFIX}/#{source}"
   file target => [source] do
     mkdir_p File.dirname(target) unless File.directory? File.dirname(target)

data/lib/nginx_stage/generator.rb

@@ -114,7 +114,7 @@ module NginxStage
 
     # Create an empty directory if it doesn't already exist
     # @param destination [String] the directory path
-    # @param mode [Fixnum] the mode to set the directory as
+    # @param mode [Integer] the mode to set the directory as
     # @return [void]
     def empty_directory(destination, mode: 0755)
       FileUtils.mkdir_p destination, mode: mode

data/lib/nginx_stage/generator_helpers.rb

@@ -2,9 +2,8 @@ module NginxStage
   # Module that adds common options to generators.
   module GeneratorHelpers
     # Add support for accepting USER as an option
-    # @param required [Boolean] whether user option is required
     # @return [void]
-    def add_user_support(required: true)
+    def add_user_support
       # @!method user
       #   The user that the per-user NGINX will run as
       #   @return [User] the user of the nginx process
@@ -12,7 +11,7 @@ module NginxStage
       self.add_option :user do
         {
           opt_args: ["-u", "--user=USER", "# The USER of the per-user nginx process"],
-          required: required,
+          required: true,
           before_init: -> (user) do
             raise InvalidUser, "invalid user name syntax: #{user}" unless user =~ NginxStage.user_regex
             user ? User.new(user) : nil
@@ -20,13 +19,18 @@ module NginxStage
         }
       end
 
-      if required
-        # Validate that the user isn't a special user (i.e., `root`)
-        self.add_hook :validate_user_not_special do
-          min_uid = NginxStage.min_uid
-          if user.uid < min_uid
-            raise InvalidUser, "user is special: #{user} (#{user.uid} < #{min_uid})"
-          end
+      # Validate that the user isn't a special user (i.e., `root`)
+      self.add_hook :validate_user_not_special do
+        min_uid = NginxStage.min_uid
+        if user.uid < min_uid
+          raise InvalidUser, "user is special: #{user} (#{user.uid} < #{min_uid})"
+        end
+      end
+
+      # Validate that the user's home directory exists
+      self.add_hook :validate_user_has_home_dir do
+        unless Dir.exist?(user.dir)
+          raise InvalidUser, "home directory '#{user.dir}' does not exist for user: #{user}"
         end
       end
     end

data/lib/nginx_stage/pid_file.rb

@@ -6,10 +6,10 @@ module NginxStage
     attr_reader :pid_path
 
     # Process id that describes this object
-    # @return [Fixnum] the pid object was initialized with
+    # @return [Integer] the pid object was initialized with
     attr_reader :pid
 
-    # @param pid [Fixnum] the pid describing a process
+    # @param pid [Integer] the pid describing a process
     # @raise [MissingPidFile] if pid file doesn't exist in file system
     # @raise [InvalidPidFile] if it is an invalid pid file
     def initialize(pid_path)

data/lib/nginx_stage/socket_file.rb

@@ -16,7 +16,7 @@ module NginxStage
     end
 
     # The number of active sessions connected to this socket
-    # @return [Fixnum] number of active connections
+    # @return [Integer] number of active connections
     def sessions
       # generate array of inodes
       ary_inodes = @processes.map{|h| h[:inode]}.reduce([], :+)

data/lib/nginx_stage/version.rb

@@ -1,4 +1,4 @@
 module NginxStage
   # The current version of NginxStage
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/nginx_stage.rb

@@ -110,7 +110,7 @@ module NginxStage
 
   # Run Ruby block as a different user if possible
   # NB: Will forego user switching if current process is not root-owned
-  # @param user [String, Fixnum, nil] the user or user id to switch to
+  # @param user [String, Integer, nil] the user or user id to switch to
   # @yield [] Block to run as given user
   def self.as_user(user, &block)
     (Process.uid == 0) && user ? sudo(user, &block) : block.call
@@ -119,7 +119,7 @@ module NginxStage
   private
     # Switch user/group effective id's as well as secondary groups
     def self.sudo(user, &block)
-      passwd = (user.is_a? Fixnum) ? Etc.getpwuid(user) : Etc.getpwnam(user)
+      passwd = (user.is_a? Integer) ? Etc.getpwuid(user) : Etc.getpwnam(user)
       name, uid, gid = passwd.name, passwd.uid, passwd.gid
       Process.initgroups(name, gid)
       Process::GID.grant_privilege(gid)

data/sbin/nginx_stage

@@ -1,7 +1,45 @@
-#!/opt/ood/nginx_stage/bin/ood_ruby
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+#!/usr/bin/env bash
 
-require 'nginx_stage'
+# The purpose of this script is to wrap up the necessary environment for the
+# per-user NGINX (PUN) processes to run under. The PUN requires the following
+# software in its environment:
+#
+# - nginx 1.6
+# - passenger 4.0
+# - ruby 2.2
+# - node.js 0.10
+# - git 1.9
+#
 
-# Start up the nginx_stage application
-NginxStage::Application.start
+# Allow admin to override the environment the PUN runs in
+#
+NGINX_PROFILE=${NGINX_PROFILE:-/etc/ood/profile}
+if [[ -f "${NGINX_PROFILE}" ]]; then
+  # Source in the custom environment
+  source "${NGINX_PROFILE}"
+else
+  # For Software Collections 2.0
+  #
+  # 1. Read in environment variable SCL_PKGS which may be set in `sudo` call
+  #    otherwise fallback to default software collection packages.
+  #
+  # 2. Check if Software Collections is installed, then source the defined
+  #    package scripts.
+  #
+  SCL_PKGS=${SCL_PKGS:-"nginx16 rh-passenger40 rh-ruby22 nodejs010 git19"}
+  SCL_SOURCE="$(command -v scl_source)"
+  [[ "${SCL_SOURCE}" ]] && source "${SCL_SOURCE}" enable ${SCL_PKGS}
+fi
+
+# Root directory for this library
+#
+ROOT_DIR="$(dirname "$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")")"
+
+# Environment is set, so call Ruby now
+#
+exec \
+  /usr/bin/env ruby \
+    -I"${ROOT_DIR}/lib" \
+    -rnginx_stage \
+    -e "NginxStage::Application.start" \
+    -- "${@}"

data/sbin/update_nginx_stage

@@ -0,0 +1,36 @@
+#!/usr/bin/env bash
+
+ROOT="$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")"
+
+CONFIG="${CONFIG:-/etc/ood/config/nginx_stage.yml}"
+BIN="${BIN:-${ROOT}/nginx_stage}"
+
+set -e
+
+OPTS=$(getopt -o q --long quiet -n 'update_nginx_stage' -- "${@}")
+eval set -- "${OPTS}"
+while true; do
+  case "${1}" in
+    -q | --quiet ) QUIET=true; shift ;;
+    -- ) shift; break ;;
+    * ) break ;;
+  esac
+done
+
+if [[ "${QUIET}" == "true" ]]; then
+  exec > /dev/null
+fi
+
+echo "Updating NGINX configs using YAML config: '${CONFIG}'"
+
+export NGINX_STAGE_CONFIG_FILE="${CONFIG}"
+if [[ "${QUIET}" != "true" ]]; then
+  set -x
+fi
+"${BIN}" app_clean
+"${BIN}" app_reset --sub-uri=/pun
+"${BIN}" nginx_clean
+{ set +x; } 2>/dev/null
+
+echo "Completed successfully!"
+echo ""

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nginx_stage
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jeremy Nicklas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-30 00:00:00.000000000 Z
+date: 2018-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,7 +58,6 @@ email:
 - jnicklas@osc.edu
 executables:
 - node
-- ood_ruby
 - python
 - ruby
 extensions: []
@@ -72,7 +71,6 @@ files:
 - README.md
 - Rakefile
 - bin/node
-- bin/ood_ruby
 - bin/python
 - bin/ruby
 - lib/nginx_stage.rb
@@ -98,6 +96,7 @@ files:
 - lib/nginx_stage/views/pun_config_view.rb
 - nginx_stage.gemspec
 - sbin/nginx_stage
+- sbin/update_nginx_stage
 - share/nginx_stage_example.yml
 - templates/app.conf.erb
 - templates/pun.conf.erb

data/bin/ood_ruby

@@ -1,38 +0,0 @@
-#!/usr/bin/env bash
-
-# Open OnDemand Ruby wrapper script
-#
-# The purpose of this script is to wrap up the necessary environment for the
-# per-user NGINX (PUN) processes to run under. The PUN requires the following
-# software in its environment:
-#
-# - nginx 1.6
-# - passenger 4.0
-# - ruby 2.2
-# - node.js 0.10
-# - git 1.9
-#
-
-# Allow admin to override the environment the PUN runs in
-#
-NGINX_PROFILE=${NGINX_PROFILE:-/etc/ood/profile}
-if [[ -f "${NGINX_PROFILE}" ]]; then
-  # Source in the custom environment
-  source "${NGINX_PROFILE}"
-else
-  # For Software Collections 2.0
-  #
-  # 1. Read in environment variable SCL_PKGS which may be set in `sudo` call
-  #    otherwise fallback to default software collection packages.
-  #
-  # 2. Check if Software Collections is installed, then source the defined
-  #    package scripts.
-  #
-  SCL_PKGS=${SCL_PKGS:-"nginx16 rh-passenger40 rh-ruby22 nodejs010 git19"}
-  SCL_SOURCE="$(command -v scl_source)"
-  [[ ${SCL_SOURCE} ]] && source "${SCL_SOURCE}" enable ${SCL_PKGS}
-fi
-
-# Environment is set, so call Ruby now
-#
-exec /usr/bin/env ruby "$@"