feat(deploy): Print the api endpoints after deploying

Author: asalkeld

pkg/cmd/deployment/root.go

@@ -26,6 +26,7 @@ import (
 	"github.com/nitrictech/cli/pkg/codeconfig"
 	"github.com/nitrictech/cli/pkg/output"
 	"github.com/nitrictech/cli/pkg/provider"
+	"github.com/nitrictech/cli/pkg/provider/types"
 	"github.com/nitrictech/cli/pkg/stack"
 	"github.com/nitrictech/cli/pkg/target"
 	"github.com/nitrictech/cli/pkg/tasklet"
@@ -97,14 +98,22 @@ nitric deployment apply -n prod -t aws`,
 		}
 		tasklet.MustRun(buildImages, tasklet.Opts{})
 
+		d := &types.Deployment{}
 		deploy := tasklet.Runner{
 			StartMsg: "Deploying..",
 			Runner: func(progress output.Progress) error {
-				return p.Apply(progress, deploymentName)
+				d, err = p.Apply(progress, deploymentName)
+				return err
 			},
 			StopMsg: "Stack",
 		}
 		tasklet.MustRun(deploy, tasklet.Opts{SuccessPrefix: "Deployed"})
+
+		rows := [][]string{{"API", "Endpoint"}}
+		for k, v := range d.ApiEndpoints {
+			rows = append(rows, []string{k, v})
+		}
+		_ = pterm.DefaultTable.WithBoxed().WithData(rows).Render()
 	},
 	Args: cobra.MinimumNArgs(0),
 }

pkg/provider/pulumi/aws/gateway.go

@@ -51,6 +51,8 @@ func newApiGateway(ctx *pulumi.Context, name string, args *ApiGatewayArgs, opts
 		return nil, err
 	}
 
+	opts = append(opts, pulumi.Parent(res))
+
 	nameArnPairs := make([]interface{}, 0, len(args.LambdaFunctions))
 
 	// collect name arn pairs for output iteration
@@ -103,7 +105,7 @@ func newApiGateway(ctx *pulumi.Context, name string, args *ApiGatewayArgs, opts
 		Body:         doc,
 		ProtocolType: pulumi.String("HTTP"),
 		Tags:         common.Tags(ctx, name),
-	}, pulumi.Parent(res))
+	}, opts...)
 	if err != nil {
 		return nil, err
 	}
@@ -113,7 +115,7 @@ func newApiGateway(ctx *pulumi.Context, name string, args *ApiGatewayArgs, opts
 		Name:       pulumi.String("$default"),
 		ApiId:      res.Api.ID(),
 		Tags:       common.Tags(ctx, name+"DefaultStage"),
-	}, pulumi.Parent(res))
+	}, opts...)
 	if err != nil {
 		return nil, err
 	}
@@ -125,16 +127,19 @@ func newApiGateway(ctx *pulumi.Context, name string, args *ApiGatewayArgs, opts
 			Action:    pulumi.String("lambda:InvokeFunction"),
 			Principal: pulumi.String("apigateway.amazonaws.com"),
 			SourceArn: pulumi.Sprintf("%s/*/*/*", res.Api.ExecutionArn),
-		}, pulumi.Parent(res))
+		}, opts...)
 		if err != nil {
 			return nil, err
 		}
 	}
 
-	return res, ctx.RegisterResourceOutputs(res, pulumi.Map{
-		"name": pulumi.String(name),
-		"api":  res.Api,
-	})
+	endPoint := res.Api.ApiEndpoint.ApplyT(func(ep string) string {
+		return ep
+	}).(pulumi.StringInput)
+
+	ctx.Export("api:"+name, endPoint)
+
+	return res, nil
 }
 
 func awsOperation(op *openapi3.Operation, funcs map[string]string) *openapi3.Operation {

pkg/provider/pulumi/aws/lambda.go

@@ -51,6 +51,8 @@ func newLambda(ctx *pulumi.Context, name string, args *LambdaArgs, opts ...pulum
 		return nil, err
 	}
 
+	opts = append(opts, pulumi.Parent(res))
+
 	tmpJSON, err := json.Marshal(map[string]interface{}{
 		"Version": "2012-10-17",
 		"Statement": []map[string]interface{}{
@@ -71,15 +73,15 @@ func newLambda(ctx *pulumi.Context, name string, args *LambdaArgs, opts ...pulum
 	res.Role, err = iam.NewRole(ctx, name+"LambdaRole", &iam.RoleArgs{
 		AssumeRolePolicy: pulumi.String(tmpJSON),
 		Tags:             common.Tags(ctx, name+"LambdaRole"),
-	}, pulumi.Parent(res))
+	}, opts...)
 	if err != nil {
 		return nil, err
 	}
 
 	_, err = iam.NewRolePolicyAttachment(ctx, name+"LambdaBasicExecution", &iam.RolePolicyAttachmentArgs{
 		PolicyArn: iam.ManagedPolicyAWSLambdaBasicExecutionRole,
 		Role:      res.Role.ID(),
-	}, pulumi.Parent(res))
+	}, opts...)
 	if err != nil {
 		return nil, err
 	}
@@ -112,7 +114,7 @@ func newLambda(ctx *pulumi.Context, name string, args *LambdaArgs, opts ...pulum
 	_, err = iam.NewRolePolicy(ctx, name+"ListAccess", &iam.RolePolicyArgs{
 		Role:   res.Role.ID(),
 		Policy: pulumi.String(tmpJSON),
-	}, pulumi.Parent(res))
+	}, opts...)
 	if err != nil {
 		return nil, err
 	}
@@ -150,7 +152,7 @@ func newLambda(ctx *pulumi.Context, name string, args *LambdaArgs, opts ...pulum
 	_, err = iam.NewRolePolicy(ctx, name+"SecretsAccess", &iam.RolePolicyArgs{
 		Role:   res.Role.ID(),
 		Policy: pulumi.String(tmpJSON),
-	}, pulumi.Parent(res))
+	}, opts...)
 	if err != nil {
 		return nil, err
 	}
@@ -163,7 +165,7 @@ func newLambda(ctx *pulumi.Context, name string, args *LambdaArgs, opts ...pulum
 		PackageType: pulumi.String("Image"),
 		Role:        res.Role.Arn,
 		Tags:        common.Tags(ctx, name),
-	}, pulumi.Parent(res))
+	}, opts...)
 	if err != nil {
 		return nil, err
 	}
@@ -176,7 +178,7 @@ func newLambda(ctx *pulumi.Context, name string, args *LambdaArgs, opts ...pulum
 				Function:  res.Function.Name,
 				Principal: pulumi.String("sns.amazonaws.com"),
 				Action:    pulumi.String("lambda:InvokeFunction"),
-			}, pulumi.Parent(res))
+			}, opts...)
 			if err != nil {
 				return nil, err
 			}
@@ -185,7 +187,7 @@ func newLambda(ctx *pulumi.Context, name string, args *LambdaArgs, opts ...pulum
 				Endpoint: res.Function.Arn,
 				Protocol: pulumi.String("lambda"),
 				Topic:    topic.ID(), // TODO check (was topic.sns)
-			}, pulumi.Parent(res))
+			}, opts...)
 			if err != nil {
 				return nil, err
 			}

pkg/provider/pulumi/aws/schedule.go

@@ -50,6 +50,8 @@ func (a *awsProvider) newSchedule(ctx *pulumi.Context, name string, args Schedul
 		return nil, err
 	}
 
+	opts = append(opts, pulumi.Parent(res))
+
 	awsCronValue, err := cron.ConvertToAWS(args.Expression)
 	if err != nil {
 		return nil, err
@@ -58,15 +60,15 @@ func (a *awsProvider) newSchedule(ctx *pulumi.Context, name string, args Schedul
 	res.EventRule, err = cloudwatch.NewEventRule(ctx, name+"Schedule", &cloudwatch.EventRuleArgs{
 		ScheduleExpression: pulumi.String(awsCronValue),
 		Tags:               common.Tags(ctx, name+"Schedule"),
-	}, pulumi.Parent(res))
+	}, opts...)
 	if err != nil {
 		return nil, err
 	}
 
 	res.EventTarget, err = cloudwatch.NewEventTarget(ctx, name+"Target", &cloudwatch.EventTargetArgs{
 		Rule: res.EventRule.Name,
 		Arn:  args.TopicArn,
-	}, pulumi.Parent(res))
+	}, opts...)
 	if err != nil {
 		return nil, err
 	}
@@ -95,7 +97,7 @@ func (a *awsProvider) newSchedule(ctx *pulumi.Context, name string, args Schedul
 	_, err = sns.NewTopicPolicy(ctx, fmt.Sprintf("%sTarget%vPolicy", name, args.TopicName), &sns.TopicPolicyArgs{
 		Arn:    args.TopicArn,
 		Policy: pdocJSON,
-	}, pulumi.Parent(res))
+	}, opts...)
 
 	return res, err
 }

pkg/provider/pulumi/azure/apimanagement.go

@@ -17,6 +17,8 @@
 package azure
 
 import (
+	"fmt"
+
 	"github.com/getkin/kin-openapi/openapi3"
 	"github.com/pkg/errors"
 	apimanagement "github.com/pulumi/pulumi-azure-native/sdk/go/azure/apimanagement/v20201201"
@@ -90,6 +92,15 @@ func newAzureApiManagement(ctx *pulumi.Context, name string, args *AzureApiManag
 		return nil, err
 	}
 
+	endPoint := res.Api.ServiceUrl.ApplyT(func(ep *string) (string, error) {
+		if ep == nil {
+			return "", fmt.Errorf("api %s returned nil serviceUrl", res.Name)
+		}
+		return *ep, nil
+	}).(pulumi.StringInput)
+
+	ctx.Export("api:"+name, endPoint)
+
 	for _, pathItem := range args.OpenAPISpec.Paths {
 		for _, op := range pathItem.Operations() {
 			if v, ok := op.Extensions["x-nitric-target"]; ok {

pkg/provider/pulumi/generator.go

@@ -18,6 +18,8 @@ package pulumi
 
 import (
 	"context"
+	"fmt"
+	"strings"
 
 	"github.com/pkg/errors"
 	"github.com/pulumi/pulumi/sdk/v3/go/auto"
@@ -98,18 +100,28 @@ func (p *pulumiDeployment) load(name string) (*auto.Stack, error) {
 	return &s, errors.WithMessage(err, "Refresh")
 }
 
-func (p *pulumiDeployment) Apply(log output.Progress, name string) error {
+func (p *pulumiDeployment) Apply(log output.Progress, name string) (*types.Deployment, error) {
 	s, err := p.load(name)
 	if err != nil {
-		return errors.WithMessage(err, "loading pulumi stack")
+		return nil, errors.WithMessage(err, "loading pulumi stack")
 	}
 
 	res, err := s.Up(context.Background(), updateLoggingOpts(log)...)
 	defer p.p.CleanUp()
 	if err != nil {
-		return errors.WithMessage(err, "Updating pulumi stack "+res.Summary.Message)
+		return nil, errors.WithMessage(err, "Updating pulumi stack "+res.Summary.Message)
 	}
-	return nil
+
+	d := &types.Deployment{
+		ApiEndpoints: map[string]string{},
+	}
+
+	for k, v := range res.Outputs {
+		if strings.HasPrefix(k, "api:") {
+			d.ApiEndpoints[strings.TrimPrefix(k, "api:")] = fmt.Sprint(v.Value)
+		}
+	}
+	return d, nil
 }
 
 func (p *pulumiDeployment) List() (interface{}, error) {

pkg/provider/types/interface.go

@@ -18,8 +18,12 @@ package types
 
 import "github.com/nitrictech/cli/pkg/output"
 
+type Deployment struct {
+	ApiEndpoints map[string]string `json:"apiEndpoints,omitempty"`
+}
+
 type Provider interface {
-	Apply(log output.Progress, deploymentName string) error
+	Apply(log output.Progress, deploymentName string) (*Deployment, error)
 	Delete(log output.Progress, deploymentName string) error
 	List() (interface{}, error)
 	//Status()