Skip to content

aws-ssm-tunnel (new formula) #221863

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

aws-ssm-tunnel (new formula) #221863

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 18 additions & 0 deletions Formula/a/aws-ssm-tunnel.rb
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
class AwsSsmTunnel < Formula
desc "CLI tool to tunnel into RDS & ElastiCache over SSM-managed EC2 instances"
homepage "https://github.com/ilkerispir/aws-ssm-tunnel"
url "https://github.com/ilkerispir/aws-ssm-tunnel/archive/refs/tags/v0.0.1.tar.gz"
sha256 "ba83bec1427a9a4997e3a4ff155138ed07ee7312d3a0b43075ca1dc092bfc4cf"
license "Apache-2.0"

depends_on "go" => :build

def install
system "go", "build", *std_go_args(output: bin/"aws-ssm-tunnel")
Copy link
Member

Choose a reason for hiding this comment

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

Is the naming not correct if you leave out the output: arg?

end

test do
output = shell_output("#{bin}/aws-ssm-tunnel --help")
assert_match "Usage", output
Comment on lines +15 to +16
Copy link
Member

Choose a reason for hiding this comment

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

We need a test that exercises the some of the functionality of the app. Version checks or usage checks (foo --version or foo --help) are not sufficient, as explained in the formula cookbook.

In most cases, a good test would involve running a simple test case: run #{bin}/foo input.txt.

  • Then you can check that the output is as expected (with assert_equal or assert_match on the output of shell_output)
  • You can also check that an output file was created, if that is expected: assert_predicate testpath/"output.txt", :exist?

Some advice for specific cases:

  • If the formula is a library, compile and run some simple code that links against it. It could be taken from upstream's documentation / source examples.
  • If the formula is for a GUI program, try to find some function that runs as command-line only, like a format conversion, reading or displaying a config file, etc.
  • If the software cannot function without credentials, a test could be to try to connect with invalid credentials (or without credentials) and confirm that it fails as expected.
  • Same if the software requires a virtual machine, docker instance, etc. to be running.

end
end
Loading
Oops, something went wrong.