diff --git a/.rspec b/.rspec new file mode 100644 index 0000000..c99d2e7 --- /dev/null +++ b/.rspec @@ -0,0 +1 @@ +--require spec_helper diff --git a/Gemfile b/Gemfile index a926918..5b7f5a7 100644 --- a/Gemfile +++ b/Gemfile @@ -5,3 +5,7 @@ gem 'aws-sdk-lambda', '~> 1.123' gem 'aws-sdk-dynamodb', '~> 1.115' gem 'slack-ruby-client', '~> 2.3.0' gem "activesupport", ">= 7.1.3.4" + +group :test do + gem 'rspec' +end diff --git a/concierge_handler.rb b/concierge_handler.rb index 40eb5e5..d9ebfea 100644 --- a/concierge_handler.rb +++ b/concierge_handler.rb @@ -88,6 +88,9 @@ def help_me_obi_wan // Reserve starting at 1pm with a specific end time (and no comment) `@reservebot #{env_list.sample} 13:00 16:45` + // Optionally specify a repo to reserve (arbitrary string) + `@reservebot #{env_list.sample} now 1h Just Testing --repo my-app` + // Release an environment again `@reservebot #{env_list.sample} free` diff --git a/lib/concierge.rb b/lib/concierge.rb index 9bfa64c..ca61fe4 100644 --- a/lib/concierge.rb +++ b/lib/concierge.rb @@ -26,6 +26,7 @@ def reservations Reservation.new( user: user, environment: item['environment'], + repo: item['repo'], start_time: try_date_parse(item['start_time']), end_time: try_date_parse(item['end_time']), comment: item['comment'] @@ -40,6 +41,7 @@ def reservations def make_reservation(reservation) item = { environment: empty_check(reservation.environment), + repo: empty_check(reservation.repo), start_time: empty_check(reservation.start_time&.rfc3339), end_time: empty_check(reservation.end_time&.rfc3339), user_name: empty_check(reservation.user_name), diff --git a/lib/reservation.rb b/lib/reservation.rb index a41f4bc..b8be79a 100644 --- a/lib/reservation.rb +++ b/lib/reservation.rb @@ -5,7 +5,7 @@ require 'active_support/core_ext/numeric/time' class Reservation - attr_reader :environment, :start_time, :end_time, :user_name, :timezone, :comment + attr_reader :environment, :start_time, :end_time, :user_name, :timezone, :comment, :repo def self.from_message(message:, user:) reservation = Reservation.new(user: user) @@ -13,13 +13,14 @@ def self.from_message(message:, user:) reservation end - def initialize(user:, environment: nil, start_time: nil, end_time: nil, comment: nil) + def initialize(user:, environment: nil, start_time: nil, end_time: nil, comment: nil, repo: nil) @user_name = user.name @timezone = user.timezone @environment = environment @start_time = start_time @end_time = end_time @comment = comment + @repo = repo end def human_readable @@ -27,9 +28,10 @@ def human_readable end_msg = end_time.nil? ? 'with no specified end' : "until #{format_time(end_time)}" reason = comment.nil? ? 'No reason given' : "Reason: #{comment}" + repo_msg = repo.nil? ? "Repo `#{repo}` " : '' <<~MSG - Environment `#{environment}` is reserved by #{user_name} + #{repo_msg} Environment `#{environment}` is reserved by #{user_name} From #{format_time(start_time)}, #{end_msg} #{reason} MSG @@ -63,7 +65,14 @@ def parse_message!(msg) @end_time = parse_time(end_input) p "Set end time as #{@end_time}" - @comment = s.rest.strip + remaining = s.rest.strip + if remaining.include?('--repo') + parts = remaining.split('--repo') + @comment = parts[0].strip + @repo = parts[1].strip if parts[1] + else + @comment = remaining + end end private diff --git a/spec/reservation_spec.rb b/spec/reservation_spec.rb new file mode 100644 index 0000000..a4add05 --- /dev/null +++ b/spec/reservation_spec.rb @@ -0,0 +1,111 @@ +require 'spec_helper' +require 'logger' +require_relative '../lib/reservation' + +RSpec.describe Reservation do + User = Struct.new(:name, :timezone) + let(:user) { User.new('Alvin Z', 'Australia/Melbourne') } + let(:reservation) { Reservation.new(user: user) } + + def stub_time + frozen_time = Time.parse('2000-01-01 13:30:00 UTC') + frozen_date = Date.parse('2000-01-01') + + allow(Time).to receive(:now).and_return(frozen_time) + allow(DateTime).to receive(:now).and_return(frozen_time.to_datetime) + allow(Date).to receive(:today).and_return(frozen_date) + allow(Date).to receive(:tomorrow).and_return(frozen_date + 1) + end + + before do + stub_time + end + + describe '#parse_message!' do + before { reservation.parse_message!(message) } + + context 'parses environment and "now" start time' do + let(:message) { '@reservebot staging-nz now' } + + it do + expect(reservation.environment).to eq('staging-nz') + expect(reservation.start_time).to eq(Time.parse('2000-01-01 13:30:00 UTC')) + expect(reservation.end_time).to be_nil + expect(reservation.comment).to eq(nil) + expect(reservation.repo).to eq(nil) + end + end + + context 'parses environment, start time, and duration' do + let(:message) { '@reservebot staging-nz now 2h' } + + it do + expect(reservation.environment).to eq('staging-nz') + expect(reservation.start_time).to eq(Time.parse('2000-01-01 13:30:00 UTC')) + expect(reservation.end_time).to eq(Time.parse('2000-01-01 15:30:00 UTC')) + expect(reservation.comment).to eq('') + expect(reservation.repo).to eq(nil) + end + end + + context 'parses environment, start time (plural), and duration' do + let(:message) { '@reservebot demo-au now 3hrs' } + + it do + expect(reservation.environment).to eq('demo-au') + expect(reservation.start_time).to eq(Time.parse('2000-01-01 13:30:00 UTC')) + expect(reservation.end_time).to eq(Time.parse('2000-01-01 16:30:00 UTC')) + expect(reservation.comment).to eq('') + expect(reservation.repo).to eq(nil) + end + end + + context 'parses environment, start time, duration, and comment' do + let(:message) { '@reservebot demo-au now 1h testing new feature' } + + it do + expect(reservation.environment).to eq('demo-au') + expect(reservation.start_time).to eq(Time.parse('2000-01-01 13:30:00 UTC')) + expect(reservation.end_time).to eq(Time.parse('2000-01-01 14:30:00 UTC')) + expect(reservation.comment).to eq('testing new feature') + expect(reservation.repo).to eq(nil) + end + end + + context 'parses optional repo with no comment' do + let(:message) { '@reservebot staging-nz now 1h --repo okkaz' } + + it do + expect(reservation.environment).to eq('staging-nz') + expect(reservation.start_time).to eq(Time.parse('2000-01-01 13:30:00 UTC')) + expect(reservation.end_time).to eq(Time.parse('2000-01-01 14:30:00 UTC')) + expect(reservation.comment).to eq('') + expect(reservation.repo).to eq('okkaz') + end + end + + context 'parses optional repo' do + let(:message) { '@reservebot demo-au now 1h testing new feature --repo okkaz' } + + it do + expect(reservation.environment).to eq('demo-au') + expect(reservation.start_time).to eq(Time.parse('2000-01-01 13:30:00 UTC')) + expect(reservation.end_time).to eq(Time.parse('2000-01-01 14:30:00 UTC')) + expect(reservation.comment).to eq('testing new feature') + expect(reservation.repo).to eq('okkaz') + end + end + + context 'parses free' do + let(:message) { '@reservebot staging-nz free' } + + it do + expect(reservation.environment).to eq('staging-nz') + expect(reservation.start_time).to be_nil + expect(reservation.end_time).to be_nil + expect(reservation.comment).to eq('free') + expect(reservation.repo).to eq(nil) + end + end + end +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb new file mode 100644 index 0000000..c80d44b --- /dev/null +++ b/spec/spec_helper.rb @@ -0,0 +1,98 @@ +# 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 https://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: + # https://rspec.info/features/3-12/rspec-core/configuration/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