Merge pull request #250 from carlosms/go-cli

Use go-cli, add version/serve subcommands

Author: carlosms

Dockerfile

@@ -9,3 +9,4 @@ RUN apt-get update && \
 ADD ./build/bin /bin
 
 ENTRYPOINT ["/bin/gitbase-web"]
+CMD ["serve"]

Gopkg.lock

@@ -63,23 +63,23 @@ Download the binary from our [releases section](https://github.com/src-d/gitbase
 ```bash
 $ export GITBASEPG_DB_CONNECTION="root@tcp(<gitbase-ip>:3306)/none"
 $ export GITBASEPG_BBLFSH_SERVER_URL="<bblfshd-ip>:9432"
-$ ./gitbase-web
+$ ./gitbase-web serve
 ```
 
 # Configuration
 
-Any of the previous execution methods accept configuration through the following environment variables.
-
-| Variable | Default value | Meaning |
-| -- | -- | -- |
-| `GITBASEPG_HOST` | `0.0.0.0` | IP address to bind the HTTP server |
-| `GITBASEPG_PORT` | `8080` | Port to bind the HTTP server |
-| `GITBASEPG_SERVER_URL` | | URL used to access the application in the form `HOSTNAME[:PORT]`. Leave it unset to allow connections from any proxy or public address |
-| `GITBASEPG_DB_CONNECTION` | `root@tcp(localhost:3306)/none?maxAllowedPacket=4194304` | gitbase connection string. Use the DSN (Data Source Name) format described in the [Go MySQL Driver docs](https://github.com/go-sql-driver/mysql#dsn-data-source-name). |
-| `GITBASEPG_BBLFSH_SERVER_URL` | `127.0.0.1:9432` | Address where bblfsh server is listening |
-| `GITBASEPG_ENV` | `production` | Sets the log level. Use `dev` to enable debug log messages |
-| `GITBASEPG_SELECT_LIMIT` | `100` | Default `LIMIT` forced on all the SQL queries done from the UI. Set it to 0 to remove any limit |
-| `GITBASEPG_FOOTER_HTML` | | Allows to add any custom html to the page footer. It must be a string encoded in base64. Use it, for example, to add your analytics tracking code snippet  |
+Any of the previous execution methods accept configuration through the following environment variables or CLI arguments.
+
+| Variable | Argument | Default value | Meaning |
+| -- | -- | -- | -- |
+| `GITBASEPG_HOST` | `--host` | `0.0.0.0` | IP address to bind the HTTP server |
+| `GITBASEPG_PORT` | `--port` | `8080` | Port to bind the HTTP server |
+| `GITBASEPG_SERVER_URL` | `--server` | | URL used to access the application in the form `HOSTNAME[:PORT]`. Leave it unset to allow connections from any proxy or public address |
+| `GITBASEPG_DB_CONNECTION` | `--db` | `root@tcp(localhost:3306)/none?maxAllowedPacket=4194304` | gitbase connection string. Use the DSN (Data Source Name) format described in the [Go MySQL Driver docs](https://github.com/go-sql-driver/mysql#dsn-data-source-name). |
+| `GITBASEPG_BBLFSH_SERVER_URL` | `--bblfsh` | `127.0.0.1:9432` | Address where bblfsh server is listening |
+| `GITBASEPG_ENV` | `--env` | `production` | Sets the log level. Use `dev` to enable debug log messages |
+| `GITBASEPG_SELECT_LIMIT` | `--select-limit` | `100` | Default `LIMIT` forced on all the SQL queries done from the UI. Set it to 0 to remove any limit |
+| `GITBASEPG_FOOTER_HTML` | `--footer` | | Allows to add any custom html to the page footer. It must be a string encoded in base64. Use it, for example, to add your analytics tracking code snippet  |
 
 # Contribute
 

README.md

@@ -10,49 +10,60 @@ import (
 	"github.com/src-d/gitbase-web/server/service"
 
 	_ "github.com/go-sql-driver/mysql"
-	"github.com/kelseyhightower/envconfig"
+	"gopkg.in/src-d/go-cli.v0"
 )
 
 // version will be replaced automatically by the CI build.
 // See https://github.com/src-d/ci/blob/v1/Makefile.main#L56
-var version = "dev"
+var (
+	name    = "gitbase-web"
+	version = "undefined"
+	build   = "undefined"
+)
+
+var app = cli.New(name, version, build, "gitbase web client")
 
 // Note: maxAllowedPacket must be explicitly set for go-sql-driver/mysql v1.3.
 // Otherwise gitbase will be asked for the max_allowed_packet column and the
 // query will fail.
 // The next release should make this parameter optional for us:
 // https://github.com/go-sql-driver/mysql/pull/680
-type appConfig struct {
-	Env             string `envconfig:"ENV" default:"production"`
-	Host            string `envconfig:"HOST" default:"0.0.0.0"`
-	Port            int    `envconfig:"PORT" default:"8080"`
-	ServerURL       string `envconfig:"SERVER_URL"`
-	DBConn          string `envconfig:"DB_CONNECTION" default:"root@tcp(localhost:3306)/none?maxAllowedPacket=4194304"`
-	SelectLimit     int    `envconfig:"SELECT_LIMIT" default:"100"`
-	BblfshServerURL string `envconfig:"BBLFSH_SERVER_URL" default:"127.0.0.1:9432"`
-	FooterHTML      string `envconfig:"FOOTER_HTML"`
+type ServeCommand struct {
+	cli.PlainCommand `name:"serve" short-description:"serve the app" long-description:"starts serving the application"`
+	Env              string `long:"env" env:"GITBASEPG_ENV" default:"production" description:"Sets the log level. Use 'dev' to enable debug log messages"`
+	Host             string `long:"host" env:"GITBASEPG_HOST" default:"0.0.0.0" description:"IP address to bind the HTTP server"`
+	Port             int    `long:"port" env:"GITBASEPG_PORT" default:"8080" description:"Port to bind the HTTP server"`
+	ServerURL        string `long:"server" env:"GITBASEPG_SERVER_URL" description:"URL used to access the application in the form 'HOSTNAME[:PORT]'. Leave it unset to allow connections from any proxy or public address"`
+	DBConn           string `long:"db" env:"GITBASEPG_DB_CONNECTION" default:"root@tcp(localhost:3306)/none?maxAllowedPacket=4194304" description:"gitbase connection string. Use the DSN (Data Source Name) format described in the Go MySQL Driver docs: https://github.com/go-sql-driver/mysql#dsn-data-source-name"`
+	SelectLimit      int    `long:"select-limit" env:"GITBASEPG_SELECT_LIMIT" default:"100" description:"Default 'LIMIT' forced on all the SQL queries done from the UI. Set it to 0 to remove any limit"`
+	BblfshServerURL  string `long:"bblfsh" env:"GITBASEPG_BBLFSH_SERVER_URL" default:"127.0.0.1:9432" description:"Address where bblfsh server is listening"`
+	FooterHTML       string `long:"footer" env:"GITBASEPG_FOOTER_HTML" description:"Allows to add any custom html to the page footer. It must be a string encoded in base64. Use it, for example, to add your analytics tracking code snippet"`
 }
 
-func main() {
-	// main configuration
-	var conf appConfig
-	envconfig.MustProcess("GITBASEPG", &conf)
-
+func (c *ServeCommand) Execute(args []string) error {
 	// logger
-	logger := service.NewLogger(conf.Env)
+	logger := service.NewLogger(c.Env)
 
 	// database
-	db, err := sql.Open("mysql", conf.DBConn)
+	db, err := sql.Open("mysql", c.DBConn)
 	if err != nil {
 		logger.Fatalf("error opening the database: %s", err)
 	}
 	defer db.Close()
 
-	static := handler.NewStatic("build/public", conf.ServerURL, conf.SelectLimit, conf.FooterHTML)
+	static := handler.NewStatic("build/public", c.ServerURL, c.SelectLimit, c.FooterHTML)
 
 	// start the router
-	router := server.Router(logger, static, version, db, conf.BblfshServerURL)
-	logger.Infof("listening on %s:%d", conf.Host, conf.Port)
-	err = http.ListenAndServe(fmt.Sprintf("%s:%d", conf.Host, conf.Port), router)
+	router := server.Router(logger, static, version, db, c.BblfshServerURL)
+	logger.Infof("listening on %s:%d", c.Host, c.Port)
+	err = http.ListenAndServe(fmt.Sprintf("%s:%d", c.Host, c.Port), router)
 	logger.Fatal(err)
+
+	return nil
+}
+
+func main() {
+	app.AddCommand(&ServeCommand{})
+
+	app.RunMain()
 }

cmd/gitbase-web/main.go

@@ -90,7 +90,7 @@ Instead of rebuilding the frontend and restarting the backend every time you do
 In one terminal run the Go backend:
 
 ```bash
-$ GITBASEPG_ENV=dev go run cmd/gitbase-web/main.go
+$ GITBASEPG_ENV=dev go run cmd/gitbase-web/main.go serve
 ```
 
 In another terminal, run the frontend: