Return an error when we fail to instantiate the server (#3642)

Add a test that verifies the server can be constructed for all services

cmd/server/main.go

@@ -181,7 +181,7 @@ func buildCLI() *cli.App {
 				if err != nil {
 					return cli.Exit(fmt.Sprintf("Unable to instantiate claim mapper: %v.", err), 1)
 				}
-				s := temporal.NewServer(
+				s, err := temporal.NewServer(
 					temporal.ForServices(services),
 					temporal.WithConfig(cfg),
 					temporal.WithDynamicConfigClient(dynamicConfigClient),
@@ -192,6 +192,9 @@ func buildCLI() *cli.App {
 						return claimMapper
 					}),
 				)
+				if err != nil {
+					return cli.Exit(fmt.Sprintf("Unable to create server. Error: %v.", err), 1)
+				}
 
 				err = s.Start()
 				if err != nil {

temporal/fx.go

@@ -131,7 +131,7 @@ type (
 	}
 )
 
-func NewServerFx(opts ...ServerOption) *ServerFx {
+func NewServerFx(opts ...ServerOption) (*ServerFx, error) {
 	app := fx.New(
 		pprof.Module,
 		ServerFxImplModule,
@@ -152,7 +152,7 @@ func NewServerFx(opts ...ServerOption) *ServerFx {
 	s := &ServerFx{
 		app,
 	}
-	return s
+	return s, app.Err()
 }
 
 func ServerOptionsProvider(opts []ServerOption) (serverOptionsProvider, error) {

temporal/server.go

@@ -54,6 +54,6 @@ var (
 )
 
 // NewServer returns a new instance of server that serves one or many services.
-func NewServer(opts ...ServerOption) Server {
+func NewServer(opts ...ServerOption) (Server, error) {
 	return NewServerFx(opts...)
 }

temporal/server_test.go

@@ -0,0 +1,52 @@
+// The MIT License
+//
+// Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
+//
+// Copyright (c) 2020 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+package temporal
+
+import (
+	"path"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"go.temporal.io/server/common/config"
+	// need to import this package to register the sqlite plugin
+	_ "go.temporal.io/server/common/persistence/sql/sqlplugin/sqlite"
+	"go.temporal.io/server/tests/testhelper"
+)
+
+// TestNewServer verifies that NewServer doesn't cause any fx errors
+func TestNewServer(t *testing.T) {
+	configDir := path.Join(testhelper.GetRepoRootDirectory(), "config")
+	cfg, err := config.LoadConfig("development-sqlite", configDir, "")
+	require.NoError(t, err)
+	cfg.DynamicConfigClient.Filepath = path.Join(configDir, "dynamicconfig", "development-sql.yaml")
+	_, err = NewServer(
+		ForServices(Services),
+		WithConfig(cfg),
+	)
+	assert.NoError(t, err)
+	// TODO: add tests for Server.Run(), etc.
+}