Merge pull request #16 from hartwork/rename-executable

Rename executable

Author: hartwork

.github/workflows/build_and_test.yml

@@ -26,9 +26,9 @@ jobs:
       - name: Build and test
         run: |-
           set -e
-          go build .
-          ./go-wait-for-it --help
-          ./go-wait-for-it \
+          go build ./cmd/wait-for-it
+          ./wait-for-it --help
+          ./wait-for-it \
               --timeout 2 \
               --service github.com:80 \
               --service github.com:443 \

.gitignore

@@ -1 +1 @@
-/go-wait-for-it
+/wait-for-it

README.md

@@ -6,7 +6,7 @@
 
 ## About
 
-**go-wait-for-it** is a lookalike of
+**wait-for-it** is a lookalike of
 (the perfectly fine)
 Python [wait-for-it](https://github.com/clarketm/wait-for-it)
 written in Go 1.14+.
@@ -24,8 +24,8 @@ $ go version
 go version go1.14.6 linux/amd64
 $ go get github.com/hartwork/go-wait-for-it
 $ export PATH="${PATH}:$(go env GOPATH)/bin"
-$ go-wait-for-it --version
-wait-for-it 1.0.0
+$ wait-for-it --version
+wait-for-it 2.0.0
 ```
 
 
@@ -35,31 +35,31 @@ wait-for-it 1.0.0
 $ go version
 go version go1.14.6 linux/amd64
 $ go build .
-$ ./go-wait-for-it --version
-wait-for-it 1.0.0
+$ ./wait-for-it --version
+wait-for-it 2.0.0
 ```
 
 
 ## Examples
 
 ```console
-$ ./go-wait-for-it -t 2 -s :631 -s localhost:631 -s 127.0.0.1:631 -- echo 'CUPS is available'
+$ wait-for-it -t 2 -s :631 -s localhost:631 -s 127.0.0.1:631 -- echo 'CUPS is very available'
 [*] Trying to connect to :631...
 [*] Trying to connect to localhost:631...
 [*] Trying to connect to 127.0.0.1:631...
 [+] Connected to 127.0.0.1:631 after 201.653µs.
 [+] Connected to :631 after 158.548µs.
 [+] Connected to localhost:631 after 381.536µs.
 [*] Running command: echo CUPS is available
-CUPS is available
+CUPS is very available
 [+] Command succeeded.
 ```
 
 
 ## Usage
 
 ```console
-$ go-wait-for-it --help
+$ wait-for-it --help
 Wait for service(s) to be available before executing a command.
 
 Usage:
@@ -72,7 +72,7 @@ Flags:
   -t, --timeout uint      timeout in seconds, 0 for no timeout (default 15)
   -v, --version           version for wait-for-it
 
-go-wait-for-it is software libre, licensed under the AGPL v3 or later license.
+wait-for-it is software libre, licensed under the AGPL v3 or later license.
 Please report bugs at https://github.com/hartwork/go-wait-for-it/issues.  Thank you!
 ```
 
@@ -82,6 +82,7 @@ Please report bugs at https://github.com/hartwork/go-wait-for-it/issues.  Thank
 ### Go
 
 - [`github.com/alioygur/wait-for`](https://github.com/alioygur/wait-for)
+- [`github.com/hartwork/go-wait-for-it/`](https://github.com/hartwork/go-wait-for-it/) — the one you are looking at
 - [`github.com/maxcnunes/waitforit`](https://github.com/maxcnunes/waitforit)
 
 

main.go renamed to cmd/wait-for-it/main.go

@@ -15,45 +15,45 @@ import (
 
 func TestInnerMainUsageError(t *testing.T) {
 	testlab.WithOutputCapturing(t, func() {
-		err := innerMain([]string{"go-wait-for-it", "--no-such-thing"})
+		err := innerMain([]string{"wait-for-it", "--no-such-thing"})
 		assert.NotNil(t, err)
 	}, &os.Stderr)
 }
 
 func TestInnerMainHelpDisplayed(t *testing.T) {
 	testlab.WithOutputCapturing(t, func() {
-		err := innerMain([]string{"go-wait-for-it", "--help"})
+		err := innerMain([]string{"wait-for-it", "--help"})
 		assert.Nil(t, err)
 	}, &os.Stdout)
 }
 
 func TestInnerMainTimout(t *testing.T) {
 	network.WithUnusedPort(t, func(address network.Address) {
-		err := innerMain([]string{"go-wait-for-it", "-q", "-t", "1", "-s", address.String()})
+		err := innerMain([]string{"wait-for-it", "-q", "-t", "1", "-s", address.String()})
 		assert.NotNil(t, err)
 	})
 }
 
 func TestInnerMainRunError(t *testing.T) {
-	err := innerMain([]string{"go-wait-for-it", "-q", "false"})
+	err := innerMain([]string{"wait-for-it", "-q", "false"})
 	assert.NotNil(t, err)
 }
 
 func TestInnerMainSuccessWithCommand(t *testing.T) {
-	err := innerMain([]string{"go-wait-for-it", "-q", "true"})
+	err := innerMain([]string{"wait-for-it", "-q", "true"})
 	assert.Nil(t, err)
 }
 
 func TestInnerMainSuccessWithoutCommand(t *testing.T) {
-	err := innerMain([]string{"go-wait-for-it"})
+	err := innerMain([]string{"wait-for-it"})
 	assert.Nil(t, err)
 }
 
 func TestMain(t *testing.T) {
 	originalOsArgs := os.Args
 	originalExitFunc := exitFunc
 
-	os.Args = []string{"go-wait-for-it", "-q", "--", "sh", "-c", "exit 123"}
+	os.Args = []string{"wait-for-it", "-q", "--", "sh", "-c", "exit 123"}
 	exitFunc = func(code int) {
 		assert.Equal(t, 123, code)
 	}

main_test.go renamed to cmd/wait-for-it/main_test.go

@@ -27,7 +27,7 @@ func report(err error) {
 
 func Parse(args []string) (config *Config, err error) {
 	usageFooter := dedent.Dedent(`
-		go-wait-for-it is software libre, licensed under the AGPL v3 or later license.
+		wait-for-it is software libre, licensed under the AGPL v3 or later license.
 		Please report bugs at https://github.com/hartwork/go-wait-for-it/issues.  Thank you!
 	`)
 
@@ -63,7 +63,7 @@ func Parse(args []string) (config *Config, err error) {
 				timeout,
 			}
 		},
-		Version: "1.0.0",
+		Version: "2.0.0",
 	}
 
 	rootCommand.SetVersionTemplate("{{.Name}} {{.Version}}\n")

internal/cli/parser.go

@@ -82,7 +82,7 @@ func TestParserHelpOutput(t *testing.T) {
 		  -t, --timeout uint      timeout in seconds, 0 for no timeout (default 15)
 		  -v, --version           version for wait-for-it
 
-		go-wait-for-it is software libre, licensed under the AGPL v3 or later license.
+		wait-for-it is software libre, licensed under the AGPL v3 or later license.
 		Please report bugs at https://github.com/hartwork/go-wait-for-it/issues.  Thank you!
 	`)[1:] // drop leading newline
 
@@ -98,7 +98,7 @@ func TestParserVersionOutput(t *testing.T) {
 		config, err := Parse([]string{"--version"})
 		assert.Nil(t, err)
 		assert.Nil(t, config)
-	}, &os.Stdout, "wait-for-it 1.0.0\n")
+	}, &os.Stdout, "wait-for-it 2.0.0\n")
 }
 
 func TestParserUnknownFlag(t *testing.T) {

internal/cli/parser_test.go

@@ -14,7 +14,7 @@ import (
 )
 
 func newTempFile(t *testing.T) *os.File {
-	fd, err := ioutil.TempFile("", "go-wait-for-it-testing-")
+	fd, err := ioutil.TempFile("", "wait-for-it-testing-")
 	require.Nil(t, err)
 	return fd
 }