diff --git a/.gitignore b/.gitignore index 8dff817c84..2ee0fcd06a 100644 --- a/.gitignore +++ b/.gitignore @@ -9,6 +9,7 @@ /.bundle /apps/*/.bundle /apps/*/vendor/bundle/ +/*/.bundle # files used for deployment should not be versioned /apps/*/.htaccess diff --git a/ood-portal-generator/Gemfile b/ood-portal-generator/Gemfile new file mode 100644 index 0000000000..d9f8fc70f2 --- /dev/null +++ b/ood-portal-generator/Gemfile @@ -0,0 +1,10 @@ +# frozen_string_literal: true + +source "https://rubygems.org" + +git_source(:github) {|repo_name| "https://github.com/#{repo_name}" } + +group :development, :test do + gem "rake" + gem "rspec" +end diff --git a/ood-portal-generator/Gemfile.lock b/ood-portal-generator/Gemfile.lock new file mode 100644 index 0000000000..11dbb20328 --- /dev/null +++ b/ood-portal-generator/Gemfile.lock @@ -0,0 +1,28 @@ +GEM + remote: https://rubygems.org/ + specs: + diff-lcs (1.3) + rake (13.0.0) + rspec (3.9.0) + rspec-core (~> 3.9.0) + rspec-expectations (~> 3.9.0) + rspec-mocks (~> 3.9.0) + rspec-core (3.9.0) + rspec-support (~> 3.9.0) + rspec-expectations (3.9.0) + diff-lcs (>= 1.2.0, < 2.0) + rspec-support (~> 3.9.0) + rspec-mocks (3.9.0) + diff-lcs (>= 1.2.0, < 2.0) + rspec-support (~> 3.9.0) + rspec-support (3.9.0) + +PLATFORMS + ruby + +DEPENDENCIES + rake + rspec + +BUNDLED WITH + 1.16.1 diff --git a/ood-portal-generator/Rakefile b/ood-portal-generator/Rakefile index a34e2b1605..d466baba3f 100644 --- a/ood-portal-generator/Rakefile +++ b/ood-portal-generator/Rakefile @@ -15,6 +15,11 @@ CNFFILE = ENV['CNFFILE'] || 'config.yml' # # Tasks # +begin + require "rspec/core/rake_task" + RSpec::Core::RakeTask.new(:spec) +rescue LoadError +end task :default => "#{OBJDIR}/#{OBJFILE}" diff --git a/ood-portal-generator/bin/generate b/ood-portal-generator/bin/generate index eac6d21d66..2c12a9f0f0 100755 --- a/ood-portal-generator/bin/generate +++ b/ood-portal-generator/bin/generate @@ -4,10 +4,11 @@ SCL_SOURCE=$(command -v scl_source) [[ "${SCL_SOURCE}" ]] && source "${SCL_SOURCE}" enable ondemand &> /dev/null ROOT_DIR="$(dirname "$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")")" +NAME=`basename "$0"` exec \ /usr/bin/env ruby \ -I"${ROOT_DIR}/lib" \ -rood_portal_generator \ - -e "OodPortalGenerator::Application.start" \ + -e "OodPortalGenerator::Application.start($NAME)" \ -- "${@}" diff --git a/ood-portal-generator/lib/ood_portal_generator/application.rb b/ood-portal-generator/lib/ood_portal_generator/application.rb index 016f6465c8..b6eaf4348f 100644 --- a/ood-portal-generator/lib/ood_portal_generator/application.rb +++ b/ood-portal-generator/lib/ood_portal_generator/application.rb @@ -31,20 +31,22 @@ def context # Starts the OodPortalGenerator CLI # @return [void] - def start + def start(mode) # Set a cleaner process title - Process.setproctitle("generate #{ARGV.join(" ")}") + Process.setproctitle("#{mode} #{ARGV.join(" ")}") # Parse CLI arguments parser.parse! # Render Apache portal config - view = View.new(context) - rendered_template = view.render(template.read) - output.write(rendered_template) + if mode == 'generate' + view = View.new(context) + rendered_template = view.render(template.read) + output.write(rendered_template) + end rescue $stderr.puts "#{$!.to_s}" - $stderr.puts "Run 'generate --help' to see a full list of available options." + $stderr.puts "Run '#{mode} --help' to see a full list of available options." exit(false) end diff --git a/ood-portal-generator/spec/application_spec.rb b/ood-portal-generator/spec/application_spec.rb new file mode 100644 index 0000000000..9da8de4b34 --- /dev/null +++ b/ood-portal-generator/spec/application_spec.rb @@ -0,0 +1,16 @@ +require 'spec_helper' +require File.expand_path '../../lib/ood_portal_generator', __FILE__ + +describe OodPortalGenerator::Application do + let(:argv) do + %W() + end + + before(:each) do + stub_const('ARGV', argv) + end + + it 'runs generate' do + expect { described_class.start('generate') }.to output(/VirtualHost/).to_stdout + end +end diff --git a/ood-portal-generator/spec/spec_helper.rb b/ood-portal-generator/spec/spec_helper.rb new file mode 100644 index 0000000000..251aa51060 --- /dev/null +++ b/ood-portal-generator/spec/spec_helper.rb @@ -0,0 +1,100 @@ +# This file was generated by the `rspec --init` command. Conventionally, all +# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`. +# The generated `.rspec` file contains `--require spec_helper` which will cause +# this file to always be loaded, without a need to explicitly require it in any +# files. +# +# Given that it is always loaded, you are encouraged to keep this file as +# light-weight as possible. Requiring heavyweight dependencies from this file +# will add to the boot time of your test suite on EVERY test run, even for an +# individual file that may not need all of that loaded. Instead, consider making +# a separate helper file that requires the additional dependencies and performs +# the additional setup, and require it from the spec files that actually need +# it. +# +# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration +RSpec.configure do |config| + # rspec-expectations config goes here. You can use an alternate + # assertion/expectation library such as wrong or the stdlib/minitest + # assertions if you prefer. + config.expect_with :rspec do |expectations| + # This option will default to `true` in RSpec 4. It makes the `description` + # and `failure_message` of custom matchers include text for helper methods + # defined using `chain`, e.g.: + # be_bigger_than(2).and_smaller_than(4).description + # # => "be bigger than 2 and smaller than 4" + # ...rather than: + # # => "be bigger than 2" + expectations.include_chain_clauses_in_custom_matcher_descriptions = true + end + + # rspec-mocks config goes here. You can use an alternate test double + # library (such as bogus or mocha) by changing the `mock_with` option here. + config.mock_with :rspec do |mocks| + # Prevents you from mocking or stubbing a method that does not exist on + # a real object. This is generally recommended, and will default to + # `true` in RSpec 4. + mocks.verify_partial_doubles = true + end + + # This option will default to `:apply_to_host_groups` in RSpec 4 (and will + # have no way to turn it off -- the option exists only for backwards + # compatibility in RSpec 3). It causes shared context metadata to be + # inherited by the metadata hash of host groups and examples, rather than + # triggering implicit auto-inclusion in groups with matching metadata. + config.shared_context_metadata_behavior = :apply_to_host_groups + +# The settings below are suggested to provide a good initial experience +# with RSpec, but feel free to customize to your heart's content. +=begin + # This allows you to limit a spec run to individual examples or groups + # you care about by tagging them with `:focus` metadata. When nothing + # is tagged with `:focus`, all examples get run. RSpec also provides + # aliases for `it`, `describe`, and `context` that include `:focus` + # metadata: `fit`, `fdescribe` and `fcontext`, respectively. + config.filter_run_when_matching :focus + + # Allows RSpec to persist some state between runs in order to support + # the `--only-failures` and `--next-failure` CLI options. We recommend + # you configure your source control system to ignore this file. + config.example_status_persistence_file_path = "spec/examples.txt" + + # Limits the available syntax to the non-monkey patched syntax that is + # recommended. For more details, see: + # - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/ + # - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/ + # - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode + config.disable_monkey_patching! + + # This setting enables warnings. It's recommended, but in some cases may + # be too noisy due to issues in dependencies. + config.warnings = true + + # Many RSpec users commonly either run the entire suite or an individual + # file, and it's useful to allow more verbose output when running an + # individual spec file. + if config.files_to_run.one? + # Use the documentation formatter for detailed output, + # unless a formatter has already been configured + # (e.g. via a command-line flag). + config.default_formatter = "doc" + end + + # Print the 10 slowest examples and example groups at the + # end of the spec run, to help surface which specs are running + # particularly slow. + config.profile_examples = 10 + + # Run specs in random order to surface order dependencies. If you find an + # order dependency and want to debug it, you can fix the order by providing + # the seed, which is printed after each run. + # --seed 1234 + config.order = :random + + # Seed global randomization in this process using the `--seed` CLI option. + # Setting this allows you to use `--seed` to deterministically reproduce + # test failures related to randomization by passing the same `--seed` value + # as the one that triggered the failure. + Kernel.srand config.seed +=end +end