Output Status of Running Applications #224

tubbo · 2020-02-06T17:59:14Z

Add a puma-dev status sub-command to output the status of all
applications currently running through puma-dev. Uses the Status API
requested from http://localhost/status with Host: "puma-dev".

Fixes #222

nateberkopec · 2020-02-07T17:10:57Z

👍 Needs tests

nateberkopec · 2020-02-07T17:48:41Z

👍 That's good enough. Can you resolve the conflicts?

tubbo · 2020-02-08T17:42:35Z

I guess my local master branch was a bit out-of-date, I didn't have a command_test.go, so I rebased and placed my test on top of the existing file. Way easier :)

nateberkopec · 2020-02-09T14:20:46Z

👍 Looks like the test you added is failing.

nonrational · 2020-02-12T15:11:20Z

You'll also want to add this command to the usage output.

puma-dev/cmd/puma-dev/main.go

Line 37 in 69b5794

fmt.Fprintf(os.Stderr, "\nAvailable subcommands: link\n")

tubbo · 2020-02-13T22:29:10Z

Thanks @nonrational, will do!

I'm not sure if we should be throwing an error here when the server can't be connected to. I assume this is not an "exceptional" case that the puma-dev server could be down or for some reason not accepting connections over localhost, so for now I'm just printing a message and returning out. But I'm open to suggestions if you folks think it should actually error out here. Just thought it would make tests easier to run if you don't have puma-dev running in the background here.

nonrational

see feedback in-line. I think your approach is perfectly acceptable, but I'd add port override and assertions around the output of the error message.

now that I have the lay of the land, i'm planning to bite off a test that actually spins up puma-dev and symlinks in a dummy rack app so we can test the meat of this thing. given that will need to run on travis, it will almost definitely need to run on a non-standard port. once that's available ( 🤞) it should be trivial to cover the non-error branch of this.

nonrational · 2020-02-14T14:24:14Z

cmd/puma-dev/command_test.go

@@ -100,3 +100,7 @@ func TestCommand_link_reassignExistingApp(t *testing.T) {

 	assert.Equal(t, fmt.Sprintf("! App '%s' already exists, pointed at '%s'\n", appAlias, appDir1), actual2)
 }
+
+func TestCommand_status(t *testing.T) {
+	assert.Nil(t, status())


You can make this a bit stronger by utilizing the WithStdOutCaptured helper in the devtest package and assert that this simple case prints the correct error message.

and that it reads the port information correctly.

thanks! I am admittedly quite new to writing Go tests...so I wasn't sure if this was enough coverage over what it does, but I couldn't think of something that would be simple enough to include here.

of course! admittedly, so am i. but, i've been slowly working on adding enough sugar in here to make testing this stuff a bit easier.

take a look here for an example of how to use that helper i mentioned. i'm happy to answer questions / address feedback.

puma-dev/cmd/puma-dev/command_test.go

Lines 85 to 92 in 69b5794

StubFlagArgs([]string{"link", "-n", appAlias, appDir1})

actual1 := WithStdoutCaptured(func() {

if err := command(); err != nil {

assert.Fail(t, err.Error())

}

})

assert.Equal(t, fmt.Sprintf("+ App '%s' created, linked to '%s'\n", appAlias, appDir1), actual1)

cmd/puma-dev/main.go

nonrational · 2020-02-14T14:32:01Z

cmd/puma-dev/command.go

+
+func status() error {
+	client := &http.Client{}
+	req, err := http.NewRequest("GET", "http://localhost/status", nil)


does puma-dev always expose status on port 80? if you're running on a nonstandard port, you'd need to access it elsewhere.

admittedly, :80 is very likely the most common case. but, it might be worth respecting fHTTPPort when checking the status so puma-dev -http-port 8080 status would work.

Possibly, but the status API documentation makes no mention of needing to use a different port other than :80 here. You can just run curl -H "Host: puma-dev" localhost/status, and as long as localhost resolves to puma-dev's DNS server, it should work.

we could consider the dynamic port a future enhancement. i think this will get the job done for the majority of users.

eventually, we'll need to have dynamic port in order to call this feature complete. if, say, you're not interested in running puma-dev as a daemon on 80, you won't be able to use status but maybe that's okay, as long as the error message communicates that.

Here's a quick example of checking status of two different puma-dev's running.

osiris:~$ curl -H "Host: puma-dev" localhost/status # get status of puma-dev running as daemon {} osiris:~$ curl -H "Host: puma-dev" localhost:9280/status # get status of puma-dev running interactively {} osiris:~$ curl -H "Host: epimetheus" localhost:9280/ | head -n1 # boot an app via interactive puma-dev <!DOCTYPE html> osiris:~$ curl -H "Host: puma-dev" localhost:9280/status | head -n1 # get status of puma-dev running interactively, now that an app has been booted {"epimetheus":{"scheme":".......} osiris:~$ curl -H "Host: puma-dev" localhost/status # get status of puma-dev running as daemon {} osiris:~$

That's interesting...are you running on macOS or Linux? I'm getting a different response when I try to curl the status using the default HTTP port number on macOS Catalina:

$ curl -H "Host: puma-dev" localhost:9280/status curl: (7) Failed to connect to localhost port 9280: Connection refused

Some other info of note:

$ launchctl list | grep io.puma 27687 0 io.puma.dev

$ ps -ef | grep puma-dev 502 27687 1 0 11:17AM ?? 0:00.36 /usr/local/Cellar/puma-dev/0.12/bin/puma-dev -launchd -dir ~/.puma-dev -d test -timeout 15m0s 502 77111 76171 0 12:21PM ttys005 0:00.47 vim cmd/puma-dev/command.go 502 77879 76171 0 12:22PM ttys005 0:00.00 grep puma-dev

Also, of course:

$ curl -H "Host: puma-dev" localhost/status {}

This may be due to a file (which was apparently generated by puma-dev at some point) in /etc/resolver/localhost:

# Generated by puma-dev nameserver 127.0.0.1 port 9253

i'm sorry. i didn't include enough context. i'm explicitly running puma-dev in interactive mode alongside my daemonized puma-dev on macOS in order to prove that /status listens on whatever port puma-dev is configured to use.

osiris:puma-dev(cover-homedir-report-coverage)$ puma-dev * Directory for apps: /Users/norton/.puma-dev * Domains: test * DNS Server port: 9253 * HTTP Server port: 9280 * HTTPS Server port: 9283 ! Puma dev listening on http and https ! Booting app 'epimetheus' on socket /Users/norton/.puma-dev/epimetheus/tmp/puma-dev-63200.sock epimetheus[63609]: bash: no job control in this shell epimetheus[63609]: Puma starting in single mode... epimetheus[63609]: * Version 4.3.0 (ruby 2.6.5-p114), codename: Mysterious Traveller epimetheus[63609]: * Min threads: 0, max threads: 5 epimetheus[63609]: * Environment: development epimetheus[63609]: * Listening on unix:/Users/norton/.puma-dev/epimetheus/tmp/puma-dev-63200.sock epimetheus[63609]: Use Ctrl-C to stop ! App 'epimetheus' booted ! Killing 'epimetheus' (63609) epimetheus[63609]: - Gracefully stopping, waiting for requests to finish epimetheus[63609]: === puma shutdown: 2020-02-14 11:41:54 -0500 === epimetheus[63609]: - Goodbye! ! Killing 'epimetheus' (63609) * App 'epimetheus' shutdown and cleaned up

nonrational · 2020-02-14T14:34:53Z

cmd/puma-dev/command.go

+	res, err := client.Do(req)
+
+	if err != nil {
+		fmt.Println("puma-dev is not running")


i'm not sure if we have enough information to say for sure that puma dev isn't running. what we do know is that we weren't able to get the status from GET localhost:80/status.

by way of heading off future new issues saying "puma-dev is running but status says it's not!!1", how do you feel about fmt.Sprintf("Unable to lookup puma-dev status. Is puma-dev listening on port %s?", fHTTPPort) ?

edit: not sure what the capitalization rules are. I guess it should be sentence case. Updating casing...

Totally cool with it.

nonrational · 2020-03-18T18:05:52Z

@tubbo still interested in getting this over the finish line? i think the testing story is now a little more straightforward. you should be able to call your status method on a running puma-dev inside main_test.go,TestMainPumaDev(), similar to

puma-dev/cmd/puma-dev/main_test.go

Lines 133 to 138 in 7312d73

    
           t.Run("status", func(t *testing.T) { 
        
           	statusUrl := fmt.Sprintf("http://localhost:%d/status", *fHTTPPort) 
        
           	statusHost := "puma-dev" 
        
           	assert.Equal(t, "{}", getUrlWithHost(t, statusUrl, statusHost)) 
        
           })

tubbo · 2020-03-27T15:15:06Z

Will do! I'll update the tests. Sorry this took so long.

Add a `puma-dev status` subcommand to output the status of all applications currently running through `puma-dev`. Uses the Status API requested from `http://localhost/status` with `Host: "puma-dev"`. Fixes puma#222

tubbo · 2020-07-10T15:19:23Z

~~hey @nonrational, is this what you were looking for? I can add some more test cases if you think this isn't sufficient.~~

wait, something is wrong...I didn't push what I thought I pushed :)

nonrational · 2020-07-13T15:29:35Z

@tubbo yeah, looks like you added commits that aren't being reflected in the diff. maybe try an interactive rebase?

tubbo force-pushed the status-command branch from e216745 to 6398fd5 Compare February 6, 2020 18:00

tubbo changed the title ~~Output Status of Servers with `docker-dev tatus~~ Output Status of Running Applications Feb 6, 2020

tubbo force-pushed the status-command branch from f53d273 to f9e369b Compare February 8, 2020 17:42

nonrational requested changes Feb 14, 2020

View reviewed changes

nonrational self-requested a review February 25, 2020 04:45

nonrational added the enhancement label Mar 21, 2020

Tom Scott added 5 commits June 18, 2020 14:33

Output Status of Running Applications

4870a64

Add a `puma-dev status` subcommand to output the status of all applications currently running through `puma-dev`. Uses the Status API requested from `http://localhost/status` with `Host: "puma-dev"`. Fixes puma#222

Add tests for status sub-command

c24aca3

Print message in status response when puma-dev is not running.

0bcbcb5

Add status to available subcommands

668aa09

Allow status to run on alternate ports

d7c9e16

tubbo force-pushed the status-command branch from 593cb48 to d7c9e16 Compare July 10, 2020 15:15

tubbo closed this Jul 23, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Output Status of Running Applications #224

Output Status of Running Applications #224

tubbo commented Feb 6, 2020

nateberkopec commented Feb 7, 2020

nateberkopec commented Feb 7, 2020

tubbo commented Feb 8, 2020

nateberkopec commented Feb 9, 2020

nonrational commented Feb 12, 2020

tubbo commented Feb 13, 2020

nonrational left a comment

nonrational Feb 14, 2020

nonrational Feb 14, 2020

tubbo Feb 14, 2020 •

edited

nonrational Feb 14, 2020

nonrational Feb 14, 2020

tubbo Feb 14, 2020

nonrational Feb 14, 2020

tubbo Feb 14, 2020

nonrational Feb 14, 2020

nonrational Feb 14, 2020 •

edited

tubbo Feb 14, 2020

nonrational commented Mar 18, 2020

tubbo commented Mar 27, 2020

tubbo commented Jul 10, 2020 •

edited

nonrational commented Jul 13, 2020

	StubFlagArgs([]string{"link", "-n", appAlias, appDir1})
	actual1 := WithStdoutCaptured(func() {
	if err := command(); err != nil {
	assert.Fail(t, err.Error())
	}
	})

	assert.Equal(t, fmt.Sprintf("+ App '%s' created, linked to '%s'\n", appAlias, appDir1), actual1)

Output Status of Running Applications #224

Output Status of Running Applications #224

Conversation

tubbo commented Feb 6, 2020

nateberkopec commented Feb 7, 2020

nateberkopec commented Feb 7, 2020

tubbo commented Feb 8, 2020

nateberkopec commented Feb 9, 2020

nonrational commented Feb 12, 2020

tubbo commented Feb 13, 2020

nonrational left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tubbo Feb 14, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nonrational Feb 14, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nonrational commented Mar 18, 2020

tubbo commented Mar 27, 2020

tubbo commented Jul 10, 2020 • edited

nonrational commented Jul 13, 2020

tubbo Feb 14, 2020 •

edited

nonrational Feb 14, 2020 •

edited

tubbo commented Jul 10, 2020 •

edited