Merge lp:~fwereade/pyjuju/go-jujuc into lp:pyjuju/go

[William Reade]

Add cmd/jujuc tool, for calling Commands in a separate host process

prereq: lp:~fwereade/juju/go-cmd-server-package

Should be pretty self-explanatory; only impact on other code is rename of
server.jujucDoc so that jujuc can produce consistent output.

https://codereview.appspot.com/5757049/

[William Reade (fwereade)]

Reviewers: mp+96143_code.launchpad.net,

Message:
Please take a look.

Description:
prereq: lp:~fwereade/juju/go-cmd-server-package

Should be pretty self-explanatory; only impact on other code is rename
of
server.jujucDoc so that jujuc can produce consistent output.

https://code.launchpad.net/~fwereade/juju/go-jujuc/+merge/96143

(do not edit description out of merge proposal)

Please review this at https://codereview.appspot.com/5757049/

Affected files:
   M cmd/command.go
   A cmd/context.go
   A cmd/context_test.go
   M cmd/juju/bootstrap.go
   M cmd/juju/main_test.go
   A cmd/jujuc/main.go
   A cmd/jujuc/main_test.go
   M cmd/jujud/initzk.go
   M cmd/jujud/machine.go
   M cmd/jujud/main_test.go
   M cmd/jujud/provisioning.go
   M cmd/jujud/unit.go
   A cmd/server/server.go
   A cmd/server/server_test.go
   M cmd/supercommand.go
   M cmd/supercommand_test.go

[lp:~fwereade/pyjuju/go-jujuc]

85. By William Reade on 2012-03-06

merge parent

[William Reade (fwereade)]

Please take a look.

https://codereview.appspot.com/5757049/

[lp:~fwereade/pyjuju/go-jujuc]

86. By William Reade on 2012-03-06

merge parent, fix outstanding client id mentions

87. By William Reade on 2012-03-12

merge parent

88. By William Reade on 2012-03-13

merge parent

Unmerged revisions

88. By William Reade on 2012-03-13

merge parent

87. By William Reade on 2012-03-12

merge parent

86. By William Reade on 2012-03-06

merge parent, fix outstanding client id mentions

85. By William Reade on 2012-03-06

merge parent

84. By William Reade on 2012-03-06

add jujuc command

83. By William Reade on 2012-03-06

add cmd/server package

82. By William Reade on 2012-03-06

anticipatory SuperCommand tweaks

=== added directory 'cmd/jujuc'
=== added file 'cmd/jujuc/main.go'
--- cmd/jujuc/main.go	1970-01-01 00:00:00 +0000
+++ cmd/jujuc/main.go	2012-03-13 10:27:18 +0000
@@ -0,0 +1,61 @@
+package main
+
+import (
+	"fmt"
+	"launchpad.net/juju/go/cmd/server"
+	"net/rpc"
+	"os"
+	"path/filepath"
+)
+
+func die(err error) {
+	fmt.Fprintf(os.Stderr, "fatal: %v\n", err)
+	fmt.Fprintf(os.Stderr, server.JUJUC_DOC)
+	os.Exit(1)
+}
+
+func requireEnv(name string) string {
+	value := os.Getenv(name)
+	if value == "" {
+		die(fmt.Errorf("%s not set", name))
+	}
+	return value
+}
+
+func requireWd() string {
+	dir, err := os.Getwd()
+	if err != nil {
+		die(err)
+	}
+	abs, err := filepath.Abs(dir)
+	if err != nil {
+		die(err)
+	}
+	return abs
+}
+
+// Main uses JUJU_CONTEXT_ID and JUJU_AGENT_SOCKET to ask a running unit agent to
+// execute a Command on our behalf. This function is not redundant with main,
+// because it provides an entry point for testing with arbitrary command line
+// arguments. Individual commands should be exposed by symlinking the command
+// name to this executable.
+func Main(args []string) {
+	req := server.Request{requireEnv("JUJU_CONTEXT_ID"), requireWd(), args}
+	client, err := rpc.Dial("unix", requireEnv("JUJU_AGENT_SOCKET"))
+	if err != nil {
+		die(err)
+	}
+	defer client.Close()
+	var resp server.Response
+	err = client.Call("RPCcmd.Main", req, &resp)
+	if err != nil {
+		die(err)
+	}
+	os.Stdout.Write([]byte(resp.Stdout))
+	os.Stderr.Write([]byte(resp.Stderr))
+	os.Exit(resp.Code)
+}
+
+func main() {
+	Main(os.Args)
+}

=== added file 'cmd/jujuc/main_test.go'
--- cmd/jujuc/main_test.go	1970-01-01 00:00:00 +0000
+++ cmd/jujuc/main_test.go	2012-03-13 10:27:18 +0000
@@ -0,0 +1,164 @@
+package main_test
+
+import (
+	"errors"
+	"flag"
+	"fmt"
+	"launchpad.net/gnuflag"
+	. "launchpad.net/gocheck"
+	"launchpad.net/juju/go/cmd"
+	main "launchpad.net/juju/go/cmd/jujuc"
+	"launchpad.net/juju/go/cmd/server"
+	"os"
+	"os/exec"
+	"path/filepath"
+	"strings"
+	"testing"
+)
+
+func Test(t *testing.T) { TestingT(t) }
+
+var flagRunMain = flag.Bool("run-main", false, "Run the application's main function for recursive testing")
+
+// Reentrancy point for testing (something as close as possible to) the jujuc
+// tool itself.
+func TestRunMain(t *testing.T) {
+	if *flagRunMain {
+		main.Main(flag.Args())
+	}
+}
+
+type RemoteCommand struct {
+	msg string
+}
+
+var expectUsage = `usage: (-> jujuc) remote [options]
+purpose: test jujuc
+
+options:
+--error (= "")
+    if set, fail
+
+here is some documentation
+`
+
+func (c *RemoteCommand) Info() *cmd.Info {
+	return &cmd.Info{
+		"remote", "[options]", "test jujuc", "here is some documentation", true}
+}
+
+func (c *RemoteCommand) InitFlagSet(f *gnuflag.FlagSet) {
+	f.StringVar(&c.msg, "error", "", "if set, fail")
+}
+
+func (c *RemoteCommand) ParsePositional(args []string) error {
+	return cmd.CheckEmpty(args)
+}
+
+func (c *RemoteCommand) Run(ctx *cmd.Context) error {
+	if c.msg != "" {
+		return errors.New(c.msg)
+	}
+	fmt.Fprintf(ctx.Stdout, "success!\n")
+	return nil
+}
+
+func run(c *C, sockPath string, contextId string, exit int, cmd ...string) string {
+	args := append([]string{"-test.run", "TestRunMain", "-run-main", "--"}, cmd...)
+	ps := exec.Command(os.Args[0], args...)
+	ps.Dir = c.MkDir()
+	ps.Env = []string{
+		fmt.Sprintf("JUJU_AGENT_SOCKET=%s", sockPath),
+		fmt.Sprintf("JUJU_CONTEXT_ID=%s", contextId),
+	}
+	output, err := ps.CombinedOutput()
+	if exit == 0 {
+		c.Assert(err, IsNil)
+	} else {
+		c.Assert(err, ErrorMatches, fmt.Sprintf("exit status %d", exit))
+	}
+	return string(output)
+}
+
+type MainSuite struct {
+	sockPath string
+	server   *server.Server
+}
+
+var _ = Suite(&MainSuite{})
+
+func (s *MainSuite) SetUpSuite(c *C) {
+	factory := func(contextId string) ([]cmd.Command, error) {
+		if contextId != "bill" {
+			return nil, fmt.Errorf("bad context: %s", contextId)
+		}
+		return []cmd.Command{&RemoteCommand{}}, nil
+	}
+	s.sockPath = filepath.Join(c.MkDir(), "test.sock")
+	srv, err := server.NewServer(factory, s.sockPath)
+	c.Assert(err, IsNil)
+	s.server = srv
+}
+
+func (s *MainSuite) TearDownSuite(c *C) {
+	c.Assert(s.server.Close(), IsNil)
+}
+
+func (s *MainSuite) TestHappyPath(c *C) {
+	output := run(c, s.sockPath, "bill", 0, "remote")
+	c.Assert(output, Equals, "success!\n")
+}
+
+func (s *MainSuite) TestBadRun(c *C) {
+	output := run(c, s.sockPath, "bill", 1, "remote", "--error", "borken")
+	c.Assert(output, Equals, "borken\n")
+}
+
+func (s *MainSuite) TestBadFlag(c *C) {
+	output := run(c, s.sockPath, "bill", 2, "remote", "--unknown")
+	c.Assert(output, Equals, "flag provided but not defined: --unknown\n"+expectUsage)
+}
+
+func (s *MainSuite) TestBadArg(c *C) {
+	output := run(c, s.sockPath, "bill", 2, "remote", "unwanted")
+	c.Assert(output, Equals, "unrecognised args: [unwanted]\n"+expectUsage)
+}
+
+func (s *MainSuite) TestBadCommand(c *C) {
+	output := run(c, s.sockPath, "bill", 2, "unknown")
+	lines := strings.Split(output, "\n")
+	c.Assert(lines[:3], DeepEquals, []string{
+		"unrecognised command: (-> jujuc) unknown",
+		"usage: (-> jujuc) <command> [options] ...",
+		"purpose: invoke a command implemented by another process",
+	})
+	c.Assert(lines[len(lines)-3:], DeepEquals, []string{
+		"commands:",
+		"    remote       test jujuc",
+		"",
+	})
+}
+
+func AssertOutput(c *C, actual, expected string) {
+	c.Assert(actual, Matches, expected+server.JUJUC_DOC)
+}
+
+func (s *MainSuite) TestNoSockPath(c *C) {
+	output := run(c, "", "bill", 1, "remote")
+	AssertOutput(c, output, "fatal: JUJU_AGENT_SOCKET not set\n")
+}
+
+func (s *MainSuite) TestBadSockPath(c *C) {
+	output := run(c, filepath.Join(c.MkDir(), "bad.sock"), "bill", 1, "remote")
+	AssertOutput(c, output, "fatal: dial unix .*: no such file or directory\n")
+}
+
+func (s *MainSuite) TestNoClientId(c *C) {
+	output := run(c, s.sockPath, "", 1, "remote")
+	AssertOutput(c, output, "fatal: JUJU_CONTEXT_ID not set\n")
+}
+
+func (s *MainSuite) TestBadClientId(c *C) {
+	output := run(c, s.sockPath, "ben", 1, "remote")
+	AssertOutput(c, output, "fatal: bad request: bad context: ben\n")
+}

=== modified file 'cmd/server/server.go'
--- cmd/server/server.go	2012-03-13 10:27:18 +0000
+++ cmd/server/server.go	2012-03-13 10:27:18 +0000
@@ -16,6 +16,13 @@
 	"path/filepath"
 )
 
+var JUJUC_DOC = `
+The jujuc command forwards invocations over RPC for execution by another
+process. It expects to be called via a symlink named for the desired remote
+command, and requires that JUJU_AGENT_SOCKET and JUJU_CONTEXT_ID be set in
+its environment.
+`
+
 // Request contains the information necessary to run a Command whose view of the
 // world is filtered according to its ContextId.
 type Request struct {
@@ -90,13 +97,6 @@
 	factory CmdFactory
 }
 
-var jujucDoc = `
-The jujuc command forwards invocations over RPC for execution by another
-process. It expects to be called via a symlink named for the desired remote
-command, and requires that JUJU_AGENT_SOCKET and JUJU_CONTEXT_ID be set in
-its environment.
-`
-
 // command returns a cmd.SuperCommand which is responsible for selecting one
 // of the Commands produced by calling rpcc.factory.
 func (rpcc *RPCcmd) command(contextId string) (cmd.Command, error) {
@@ -104,7 +104,7 @@
 	if err != nil {
 		return nil, err
 	}
-	sc := cmd.NewSuperCommand("(-> jujuc)", jujucDoc)
+	sc := cmd.NewSuperCommand("(-> jujuc)", JUJUC_DOC)
 	sc.SetsLog = false
 	sc.Purpose = "invoke a command implemented by another process"
 	for _, c := range cmds {

=== modified file 'cmd/server/server_test.go'
--- cmd/server/server_test.go	2012-03-13 10:27:18 +0000
+++ cmd/server/server_test.go	2012-03-13 10:27:18 +0000
@@ -43,7 +43,7 @@
 
 func factory(contextId string) ([]cmd.Command, error) {
 	if contextId != "merlin" {
-		return nil, errors.New("unknown client")
+		return nil, errors.New("unknown context")
 	}
 	return []cmd.Command{&RpcCommand{}}, nil
 }
@@ -114,7 +114,7 @@
 
 func (s *ServerSuite) TestBadContextId(c *C) {
 	_, err := s.Call(c, server.Request{"mordred", c.MkDir(), []string{"magic"}})
-	c.Assert(err, ErrorMatches, "bad request: unknown client")
+	c.Assert(err, ErrorMatches, "bad request: unknown context")
 }
 
 func (s *ServerSuite) AssertBadCommand(c *C, args []string, code int) server.Response {