nginx_stage 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9b3919f81c64e84a2280becde57f2d6aac9a346
-  data.tar.gz: 8f7677d4b45de1c348c3e03d7d0cf537415be9f7
+  metadata.gz: 119f019f0d50000e6eca41b3464f2971345be084
+  data.tar.gz: a19e78dbfdc7dbb2af510cfa3117b8b74e00f795
 SHA512:
-  metadata.gz: 2746bb855832210d40d2d62bc22a31b4270d8b535c54c168a7bfcfec0ec4b5bce1042edec794d8b54d9ded05d5cb56d7993b58be3901c2db000cc96ac3621d4c
-  data.tar.gz: c294a4171c99ef1b5acb3abf726fa9df3488b6d06faa6db286346675a2861799b1773c15dbd3d8f5c52936343a9ce01c0dc0afaf5cb37172fff94fc7d4475545
+  metadata.gz: e79f39728628cec8cbc7936adeab22fa00912ce665a51a45e33607be053eaa84a13cefcf05537c80b6ff80d25918dae448bd2ad850345dad48db378f637a342e
+  data.tar.gz: c103c842dbb5e79e735cac641d229e1f3e36be42820cc51907cef7e46110d61d2bb3cc4854c713bb0e1c738c923b1220d5b70b45fce783cae5b08fbe8f57ba98

data/CHANGELOG.md

@@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [0.5.0] - 2018-04-30
+### Added
+- Made currently installed version number of OnDemand available to all PUNs if
+  the OnDemand version file exists.
+  [#36](https://github.com/OSC/nginx_stage/issues/36)
+- Can specify portal name to namespace multiple OnDemand hosted portals.
+  [#33](https://github.com/OSC/nginx_stage/issues/33)
+- Can specify portal title for apps to use in their views.
+  [#33](https://github.com/OSC/nginx_stage/issues/33)
+
 ## [0.4.0] - 2018-02-09
 ### Added
 - Added helpful utility for performing the necessary operations when updating
@@ -202,7 +212,8 @@ 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.4.0...HEAD
+[Unreleased]: https://github.com/OSC/nginx_stage/compare/v0.5.0...HEAD
+[0.5.0]: https://github.com/OSC/nginx_stage/compare/v0.4.0...v0.5.0
 [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

data/lib/nginx_stage.rb

@@ -36,6 +36,50 @@ module NginxStage
 
   extend Configuration
 
+  # The current version of OnDemand installed
+  # @example Get version of OnDemand for version file that exists
+  #   ondemand_version #=> "1.3.0"
+  # @example No version file exists
+  #   ondemand_version #=> nil
+  # @return [String, nil] current version of installed OnDemand if exists
+  def self.ondemand_version
+    version = File.read(ondemand_version_path).strip
+    version.empty? ? nil : version
+  rescue
+    nil
+  end
+
+  # The unique name of the hosted OnDemand portal used to namespace apps, their
+  # data, and logging information
+  # @example No OnDemand Portal name specified
+  #   portal #=> "ondemand"
+  # @example The AweSim portal is specified
+  #   portal #=> "awesim"
+  # @return [String] unique portal name
+  def self.portal
+    portal = ondemand_portal.to_s.strip
+    if portal.empty?
+      "ondemand"
+    else
+      portal.downcase.gsub(/\s+/, "_")
+    end
+  end
+
+  # The title of the hosted OnDemand portal
+  # @example No title supplied
+  #   title #=> "Open OnDemand"
+  # @example The OSC OnDemand portal
+  #   title #=> "OSC OnDemand"
+  # @return [String] portal title
+  def self.title
+    title = ondemand_title.to_s.strip
+    if title.empty?
+      "Open OnDemand"
+    else
+      title
+    end
+  end
+
   # Regex used to parse an app request
   # @example Dev app request
   #   parse_app_request(request: '/dev/rails1/structure/1')
@@ -59,6 +103,24 @@ module NginxStage
     app_info
   end
 
+  # Environment used during execution of nginx binary
+  # @example Start the per-user NGINX for user Bob
+  #   nginx_env(user: 'bob')
+  #   #=> { "USER" => "bob", ... }
+  # @param user [String] the owner of the nginx process
+  # @return [Hash{String=>String}] the environment used to execute the nginx process
+  def self.nginx_env(user:)
+    {
+      "USER" => user,
+      "ONDEMAND_VERSION" => ondemand_version,
+      "ONDEMAND_PORTAL" => portal,
+      "ONDEMAND_TITLE" => title,
+      # backwards compatibility
+      "OOD_PORTAL" => ondemand_portal,
+      "OOD_DASHBOARD_TITLE" => ondemand_title,
+    }
+  end
+
   # Arguments used during execution of nginx binary
   # @example Start the per-user NGINX for user Bob
   #   nginx_args(user: 'bob')

data/lib/nginx_stage/configuration.rb

@@ -8,6 +8,19 @@ module NginxStage
     # Global
     #
 
+    # Path to the OnDemand version file that contains version of OnDemand
+    # installed
+    # @return [String] the ondemand version file
+    attr_accessor :ondemand_version_path
+
+    # Unique name of OnDemand portal for namespacing multiple portals
+    # @return [String, nil] the name of OnDemand portal if defined
+    attr_accessor :ondemand_portal
+
+    # Title of the OnDemand portal that apps *should* display in their navbar
+    # @return [String, nil] the title of the Dashboard if defined
+    attr_accessor :ondemand_title
+
     # Location of ERB templates used as NGINX configs
     # @return [String] the ERB templates root path
     attr_accessor :template_root
@@ -202,7 +215,7 @@ module NginxStage
       File.expand_path(
         @app_root.fetch(env) do
           raise InvalidRequest, "invalid request environment: #{env}"
-        end % {env: env, owner: owner, name: name}
+        end % {env: env, owner: owner, name: name, portal: portal}
       )
     end
 
@@ -330,7 +343,10 @@ module NginxStage
     # Sets the default configuration options
     # @return [void]
     def set_default_configuration
-      self.template_root  = "#{root}/templates"
+      self.ondemand_version_path = "/opt/ood/VERSION"
+      self.ondemand_portal       = nil
+      self.ondemand_title        = nil
+      self.template_root         = "#{root}/templates"
 
       self.proxy_user       = 'apache'
       self.nginx_bin        = '/opt/rh/nginx16/root/usr/sbin/nginx'
@@ -361,7 +377,7 @@ module NginxStage
         sys: '/var/lib/nginx/config/apps/sys/%{name}.conf'
       }
       self.app_root          = {
-        dev: '~%{owner}/ondemand/dev/%{name}',
+        dev: '~%{owner}/%{portal}/dev/%{name}',
         usr: '/var/www/ood/apps/usr/%{owner}/gateway/%{name}',
         sys: '/var/www/ood/apps/sys/%{name}'
       }

data/lib/nginx_stage/generators/app_config_generator.rb

@@ -79,10 +79,24 @@ module NginxStage
     add_hook :exec_nginx do
       if !skip_nginx
         if File.file? NginxStage.pun_pid_path(user: user)
-          o, s = Open3.capture2e([NginxStage.nginx_bin, "(#{user})"], *NginxStage.nginx_args(user: user, signal: :stop))
+          o, s = Open3.capture2e(
+            NginxStage.nginx_env(user: user),
+            [
+              NginxStage.nginx_bin,
+              "(#{user})"
+            ],
+            *NginxStage.nginx_args(user: user, signal: :stop)
+          )
           abort(o) unless s.success?
         end
-        o, s = Open3.capture2e([NginxStage.nginx_bin, "(#{user})"], *NginxStage.nginx_args(user: user))
+        o, s = Open3.capture2e(
+          NginxStage.nginx_env(user: user),
+          [
+            NginxStage.nginx_bin,
+            "(#{user})"
+          ],
+          *NginxStage.nginx_args(user: user)
+        )
         s.success? ? exit : abort(o)
       end
     end

data/lib/nginx_stage/generators/nginx_clean_generator.rb

@@ -48,7 +48,11 @@ module NginxStage
           if socket.sessions.zero? || force
             puts u
             if !skip_nginx
-              o, s = Open3.capture2e(NginxStage.nginx_bin, *NginxStage.nginx_args(user: u, signal: :stop))
+              o, s = Open3.capture2e(
+                NginxStage.nginx_env(user: u),
+                NginxStage.nginx_bin,
+                *NginxStage.nginx_args(user: u, signal: :stop)
+              )
               $stderr.puts o unless s.success?
             end
           end

data/lib/nginx_stage/generators/nginx_process_generator.rb

@@ -34,7 +34,14 @@ module NginxStage
     # Run the per-user NGINX process (exit quietly on success)
     add_hook :exec_nginx do
       if !skip_nginx
-        o, s = Open3.capture2e([NginxStage.nginx_bin, "(#{user})"], *NginxStage.nginx_args(user: user, signal: signal))
+        o, s = Open3.capture2e(
+          NginxStage.nginx_env(user: user),
+          [
+            NginxStage.nginx_bin,
+            "(#{user})"
+          ],
+          *NginxStage.nginx_args(user: user, signal: signal)
+        )
         s.success? ? exit : abort(o)
       end
     end

data/lib/nginx_stage/generators/pun_config_generator.rb

@@ -82,7 +82,14 @@ module NginxStage
     # Run the per-user NGINX process (exit quietly on success)
     add_hook :exec_nginx do
       if !skip_nginx
-        o, s = Open3.capture2e([NginxStage.nginx_bin, "(#{user})"], *NginxStage.nginx_args(user: user))
+        o, s = Open3.capture2e(
+          NginxStage.nginx_env(user: user),
+          [
+            NginxStage.nginx_bin,
+            "(#{user})"
+          ],
+          *NginxStage.nginx_args(user: user)
+        )
         s.success? ? exit : abort(o)
       end
     end

data/lib/nginx_stage/version.rb

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

data/share/nginx_stage_example.yml

@@ -14,6 +14,20 @@
 
 ---
 
+# Path to the OnDemand version file
+#
+#ondemand_version_path: '/opt/ood/VERSION'
+
+# Unique name of this OnDemand portal used to namespace multiple hosted portals
+# NB: If this is not set then most apps will use default namespace "ondemand"
+#
+#ondemand_portal: null
+#
+# Title of this OnDemand portal that apps *should* display in their navbar
+# NB: If this is not set then most apps will use default title "Open OnDemand"
+#
+#ondemand_title: null
+
 # Location of the ERB templates used in the generation of the NGINX configs
 #
 #template_root: '/opt/ood/nginx_stage/templates'
@@ -115,7 +129,7 @@
 # corresponding environment
 #
 #app_root:
-#  dev: '~%{owner}/ondemand/dev/%{name}'
+#  dev: '~%{owner}/%{portal}/dev/%{name}'
 #  usr: '/var/www/ood/apps/usr/%{owner}/gateway/%{name}'
 #  sys: '/var/www/ood/apps/sys/%{name}'
 

data/templates/pun.conf.erb

@@ -1,6 +1,3 @@
-# Setup environment
-env USER=<%= user %>;
-
 user        <%= user %> <%= group %>;  ## Default: nobody
 error_log   <%= error_log_path %>;
 pid         <%= pid_path %>;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nginx_stage
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jeremy Nicklas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-09 00:00:00.000000000 Z
+date: 2018-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.4
 signing_key: 
 specification_version: 4
 summary: Stage and control per-user NGINX processes.