Skip to content

Commit d3d0465

Browse files
easyCZeasyCZ
committed
[public-api] Convert to a cobra command and add config
1 parent f70a58c commit d3d0465

File tree

5 files changed

+97
-10
lines changed

5 files changed

+97
-10
lines changed

‎components/public-api-server/go.mod

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,11 @@ go 1.17
55
require (
66
github.com/gitpod-io/gitpod/common-go v0.0.0-00010101000000-000000000000
77
github.com/gitpod-io/gitpod/public-api v0.0.0-00010101000000-000000000000
8+
github.com/sirupsen/logrus v1.8.1
9+
github.com/spf13/cobra v1.4.0
810
github.com/stretchr/testify v1.7.0
911
google.golang.org/grpc v1.45.0
12+
google.golang.org/protobuf v1.28.0
1013
)
1114

1215
require (
@@ -18,21 +21,21 @@ require (
1821
github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0 // indirect
1922
github.com/hashicorp/golang-lru v0.5.1 // indirect
2023
github.com/heptiolabs/healthcheck v0.0.0-20211123025425-613501dd5deb // indirect
24+
github.com/inconshreveable/mousetrap v1.0.0 // indirect
2125
github.com/matttproud/golang_protobuf_extensions v1.0.1 // indirect
2226
github.com/opentracing/opentracing-go v1.2.0 // indirect
2327
github.com/pmezard/go-difflib v1.0.0 // indirect
2428
github.com/prometheus/client_golang v1.12.1 // indirect
2529
github.com/prometheus/client_model v0.2.0 // indirect
2630
github.com/prometheus/common v0.32.1 // indirect
2731
github.com/prometheus/procfs v0.7.3 // indirect
28-
github.com/sirupsen/logrus v1.8.1 // indirect
32+
github.com/spf13/pflag v1.0.5 // indirect
2933
golang.org/x/net v0.0.0-20211209124913-491a49abca63 // indirect
3034
golang.org/x/sys v0.0.0-20220114195835-da31bd327af9 // indirect
3135
golang.org/x/text v0.3.7 // indirect
3236
golang.org/x/time v0.0.0-20191024005414-555d28b269f0 // indirect
3337
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
3438
google.golang.org/genproto v0.0.0-20201019141844-1ed22bb0c154 // indirect
35-
google.golang.org/protobuf v1.28.0 // indirect
3639
gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
3740
)
3841

‎components/public-api-server/go.sum

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ github.com/cncf/udpa/go v0.0.0-20210930031921-04548b0d99d4/go.mod h1:6pvJx4me5XP
5757
github.com/cncf/xds/go v0.0.0-20210805033703-aa0b78936158/go.mod h1:eXthEFrGJvWHgFFCl3hGmgk+/aYT6PnTQLykKQRLhEs=
5858
github.com/cncf/xds/go v0.0.0-20210922020428-25de7278fc84/go.mod h1:eXthEFrGJvWHgFFCl3hGmgk+/aYT6PnTQLykKQRLhEs=
5959
github.com/cncf/xds/go v0.0.0-20211011173535-cb28da3451f1/go.mod h1:eXthEFrGJvWHgFFCl3hGmgk+/aYT6PnTQLykKQRLhEs=
60+
github.com/cpuguy83/go-md2man/v2 v2.0.1/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
6061
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
6162
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
6263
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -145,6 +146,8 @@ github.com/hashicorp/golang-lru v0.5.1/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ
145146
github.com/heptiolabs/healthcheck v0.0.0-20211123025425-613501dd5deb h1:tsEKRC3PU9rMw18w/uAptoijhgG4EvlA5kfJPtwrMDk=
146147
github.com/heptiolabs/healthcheck v0.0.0-20211123025425-613501dd5deb/go.mod h1:NtmN9h8vrTveVQRLHcX2HQ5wIPBDCsZ351TGbZWgg38=
147148
github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc=
149+
github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM=
150+
github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
148151
github.com/jpillora/backoff v1.0.0/go.mod h1:J/6gKK9jxlEcS3zixgDgUAsiuZ7yrSoa/FX5e0EB2j4=
149152
github.com/json-iterator/go v1.1.6/go.mod h1:+SdeFBvtyEkXs7REEP0seUULqWtbJapLOCVDaaPEHmU=
150153
github.com/json-iterator/go v1.1.10/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4=
@@ -205,11 +208,16 @@ github.com/prometheus/procfs v0.7.3 h1:4jVXhlkAyzOScmCkXBTOLRLTz8EeU+eyjrwB/EPq0
205208
github.com/prometheus/procfs v0.7.3/go.mod h1:cz+aTbrPOrUb4q7XlbU9ygM+/jj0fzG6c1xBZuNvfVA=
206209
github.com/rogpeppe/fastuuid v1.2.0/go.mod h1:jVj6XXZzXRy/MSR5jhDC/2q6DgLz+nrA6LYCDYWNEvQ=
207210
github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=
211+
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
208212
github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo=
209213
github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE=
210214
github.com/sirupsen/logrus v1.6.0/go.mod h1:7uNnSEd1DgxDLC74fIahvMZmmYsHGZGEOFrfsX/uA88=
211215
github.com/sirupsen/logrus v1.8.1 h1:dJKuHgqk1NNQlqoA6BTlM1Wf9DOH3NBjQyu0h9+AZZE=
212216
github.com/sirupsen/logrus v1.8.1/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
217+
github.com/spf13/cobra v1.4.0 h1:y+wJpx64xcgO1V+RcnwW0LEHxTKRi2ZDPSBjWnrg88Q=
218+
github.com/spf13/cobra v1.4.0/go.mod h1:Wo4iy3BUC+X2Fybo0PDqwJIv3dNRiZLHQymsfxlB84g=
219+
github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
220+
github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
213221
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
214222
github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
215223
github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=

‎components/public-api-server/main.go

Lines changed: 65 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,76 @@
55
package main
66

77
import (
8+
"context"
89
"github.com/gitpod-io/gitpod/common-go/log"
910
"github.com/gitpod-io/gitpod/public-api-server/pkg/server"
11+
"github.com/sirupsen/logrus"
12+
"github.com/spf13/cobra"
13+
"github.com/spf13/pflag"
14+
"net/url"
15+
)
16+
17+
const (
18+
// Version is the current component version. Set during build time.
19+
Version = ""
20+
Service = "public-api-server"
1021
)
1122

1223
func main() {
13-
logger := log.New()
24+
ctx := context.Background()
25+
cmd := command()
1426

15-
if err := server.Start(logger); err != nil {
16-
logger.WithError(err).Fatal("Server errored.")
27+
if err := cmd.ExecuteContext(ctx); err != nil {
28+
log.Log.WithError(err).Fatal("Failed to execute command.")
1729
}
1830
}
31+
32+
func command() *cobra.Command {
33+
var (
34+
gitpodAPIURL string
35+
httpPort, grpcPort int
36+
verbose bool
37+
)
38+
39+
cmd := &cobra.Command{
40+
Use: "public-api-server",
41+
Short: "Serves public API services",
42+
Version: Version,
43+
Run: func(cmd *cobra.Command, args []string) {
44+
log.Init(Service, Version, true, verbose)
45+
logger := log.Log
46+
47+
logger.WithField("config", flagsToLogFields(cmd.Flags())).Info("Starting with config.")
48+
49+
gitpodAPI, urlErr := url.Parse(gitpodAPIURL)
50+
if urlErr != nil {
51+
logger.WithError(urlErr).Fatal("Failed to parse Gitpod API URL.")
52+
}
53+
54+
if err := server.Start(logger, server.Config{
55+
GitpodAPI: gitpodAPI,
56+
HTTPPort: httpPort,
57+
GRPCPort: grpcPort,
58+
}); err != nil {
59+
logger.WithError(err).Fatal("Server errored.")
60+
}
61+
},
62+
}
63+
64+
cmd.Flags().StringVar(&gitpodAPIURL, "gitpod-api-url", "wss://main.preview.gitpod-dev.com/api/v1", "URL for existing Gitpod Websocket API")
65+
cmd.Flags().IntVar(&httpPort, "http-port", 9500, "Port for serving HTTP traffic")
66+
cmd.Flags().IntVar(&grpcPort, "grpc-port", 9501, "Port for serving gRPC traffic")
67+
cmd.Flags().BoolVar(&verbose, "verbose", false, "Toggle verbose logging (debug level)")
68+
69+
return cmd
70+
}
71+
72+
func flagsToLogFields(fs *pflag.FlagSet) logrus.Fields {
73+
fields := logrus.Fields{}
74+
75+
fs.VisitAll(func(f *pflag.Flag) {
76+
fields[f.Name] = f.Value
77+
})
78+
79+
return fields
80+
}

‎components/public-api-server/pkg/server/config.go

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
// Copyright (c) 2022 Gitpod GmbH. All rights reserved.
2+
// Licensed under the GNU Affero General Public License (AGPL).
3+
// See License-AGPL.txt in the project root for license information.
4+
5+
package server
6+
7+
import "net/url"
8+
9+
type Config struct {
10+
GitpodAPI *url.URL
11+
12+
HTTPPort int
13+
GRPCPort int
14+
}

‎components/public-api-server/pkg/server/server.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,17 @@ import (
1515
"net/http"
1616
)
1717

18-
func Start(logger *logrus.Entry) error {
18+
func Start(logger *logrus.Entry, cfg Config) error {
1919
srv, err := baseserver.New("public_api_server",
2020
baseserver.WithLogger(logger),
21-
baseserver.WithHTTPPort(9000),
22-
baseserver.WithGRPCPort(9001),
21+
baseserver.WithHTTPPort(cfg.HTTPPort),
22+
baseserver.WithGRPCPort(cfg.GRPCPort),
2323
)
2424
if err != nil {
2525
return fmt.Errorf("failed to initialize public api server: %w", err)
2626
}
2727

28-
if registerErr := register(srv); registerErr != nil {
28+
if registerErr := register(srv, cfg); registerErr != nil {
2929
return fmt.Errorf("failed to register services: %w", registerErr)
3030
}
3131

@@ -36,7 +36,7 @@ func Start(logger *logrus.Entry) error {
3636
return nil
3737
}
3838

39-
func register(srv *baseserver.Server) error {
39+
func register(srv *baseserver.Server, cfg Config) error {
4040
logger := log.New()
4141
m := middleware.NewLoggingMiddleware(logger)
4242
srv.HTTPMux().Handle("/", m(http.HandlerFunc(HelloWorldHandler)))

0 commit comments

Comments
 (0)