Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add dbconsole command #94

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions bin/nib
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,22 @@ command :console do |c|
end
end

desc 'Start a Database REPL session for the given service'
long_desc <<-"DESC"
This command, for now, will simply run the file supplied at $pwd/bin/dbconsole.
We recommend someting as simple as:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

someting -> something


#! /bin/sh\n
psql "$@"
DESC
arg :service
arg :command, %i(optional multiple)
command :dbconsole do |c|
c.action do |global, options, args|
Nib::Run.execute(args.insert(1, './bin/dbconsole'))
end
end

desc 'Connect to a running byebug server for a given service'
long_desc 'This command requires a little extra setup.

Expand Down
3 changes: 3 additions & 0 deletions spec/dummy/rails/bin/dbconsole
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#! /bin/sh

echo 'Running psql (or some other db repl)'
4 changes: 4 additions & 0 deletions spec/integration/dbconsole_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
RSpec.describe command('cd spec/dummy/rails && nibtest dbconsole web') do
its(:stdout) { should match(/psql/) }
its(:exit_status) { should eq 0 }
end
22 changes: 22 additions & 0 deletions spec/unit/dbconsole_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
RSpec.describe 'dbconsole' do
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know that this particular unit spec is necessary - it's essentially the same as unit/run_spec.rb

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would tend to agree at this stage @blankenshipz. When originally implementing this feature we had added a ./lib/nib/dbconsole.rb and therefore added a unit test to match. As of this commit, we found that it was really just a run...

Upon further review though we believe we'll need to break this back out into it's own class. The reason being is the shell is doing some very strange things with quoted strings passed to nib. Therefore we will need some special handling of args for this command. That being the case we'll likely want to have a unit test. 😉

let(:service) { 'web' }
let(:command) { './bin/dbconsole -c \'SELECT * FROM foo;\'' }

subject { Nib::Run.new(service, command) }

it 'executes ./bin/dbconsole' do
expect(subject.script).to match(
%r{
docker-compose
.*
run
.*
--rm
.*
#{service}
.*
\./bin/dbconsole\s-c\s'SELECT\s\*\sFROM\sfoo;'
}x
)
end
end