Skip to content

Keep compose as-is #523

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions src/cmd/cli/command/commands.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,10 @@ import (
defangv1 "github.com/DefangLabs/defang/src/protos/io/defang/v1"
"github.com/aws/smithy-go"
"github.com/bufbuild/connect-go"
proj "github.com/compose-spec/compose-go/v2/types"
composeTypes "github.com/compose-spec/compose-go/v2/types"
"github.com/spf13/cobra"
)

const DEFANG_PORTAL_HOST = "portal.defang.dev"
const SERVICE_PORTAL_URL = "https://" + DEFANG_PORTAL_HOST + "/service"

const authNeeded = "auth-needed" // annotation to indicate that a command needs authorization
var authNeededAnnotation = map[string]string{authNeeded: ""}

Expand Down Expand Up @@ -613,7 +610,7 @@ var newCmd = &cobra.Command{
RunE: generateCmd.RunE,
}

func collectUnsetEnvVars(project *proj.Project) []string {
func collectUnsetEnvVars(project *composeTypes.Project) []string {
var envVars []string
if project != nil {
for _, service := range project.Services {
Expand Down
14 changes: 7 additions & 7 deletions src/cmd/cli/command/compose.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,19 @@ import (
"github.com/spf13/cobra"
)

func isManagedService(service *defangv1.Service) bool {
if service == nil {
func isManagedService(service compose.ServiceConfig) bool {
if service.Extensions == nil {
return false
}

return service.StaticFiles != nil || service.Redis != nil || service.Postgres != nil
return service.Extensions["x-defang-static-files"] != nil || service.Extensions["x-defang-redis"] != nil || service.Extensions["x-defang-postgres"] != nil
}

func GetUnreferencedManagedResources(serviceInfos []*defangv1.ServiceInfo) []string {
func getUnreferencedManagedResources(serviceInfos compose.Services) []string {
managedResources := make([]string, 0)
for _, service := range serviceInfos {
if isManagedService(service.Service) {
managedResources = append(managedResources, service.Service.Name)
if isManagedService(service) {
managedResources = append(managedResources, service.Name)
}
}

Expand Down Expand Up @@ -83,7 +83,7 @@ func makeComposeUpCmd() *cobra.Command {

printPlaygroundPortalServiceURLs(deploy.Services)

var managedResources = GetUnreferencedManagedResources(deploy.Services)
var managedResources = getUnreferencedManagedResources(project.Services)
if len(managedResources) > 0 {
term.Warnf("Defang cannot monitor status of the following managed service(s): %v.\n To check if the managed service is up, check the status of the service which depends on it.", managedResources)
}
Expand Down
66 changes: 37 additions & 29 deletions src/cmd/cli/command/compose_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,75 +3,83 @@ package command
import (
"testing"

defangv1 "github.com/DefangLabs/defang/src/protos/io/defang/v1"
"github.com/compose-spec/compose-go/v2/types"
)

func TestGetUnreferencedManagedResources(t *testing.T) {

t.Run("no services", func(t *testing.T) {
project := []*defangv1.ServiceInfo{}
managed := GetUnreferencedManagedResources(project)
project := types.Services{}

managed := getUnreferencedManagedResources(project)
if len(managed) != 0 {
t.Errorf("Expected 0 managed resources, got %d (%v)", len(managed), managed)
}
})

t.Run("one service all managed", func(t *testing.T) {
project := []*defangv1.ServiceInfo{}
project = append(project, &defangv1.ServiceInfo{
Service: &defangv1.Service{Name: "service1", Postgres: &defangv1.Postgres{}}})
project := types.Services{
"service1": types.ServiceConfig{
Extensions: map[string]any{"x-defang-postgres": true},
},
}

managed := GetUnreferencedManagedResources(project)
managed := getUnreferencedManagedResources(project)
if len(managed) != 1 {
t.Errorf("Expected 1 managed resource, got %d (%v)", len(managed), managed)
}
})

t.Run("one service unmanaged", func(t *testing.T) {
project := []*defangv1.ServiceInfo{}
project = append(project, &defangv1.ServiceInfo{
Service: &defangv1.Service{Name: "service1"}})
project := types.Services{
"service1": types.ServiceConfig{},
}

managed := GetUnreferencedManagedResources(project)
managed := getUnreferencedManagedResources(project)
if len(managed) != 0 {
t.Errorf("Expected 0 managed resource, got %d (%v)", len(managed), managed)
}
})

t.Run("one service unmanaged, one service managed", func(t *testing.T) {
project := []*defangv1.ServiceInfo{}
project = append(project, &defangv1.ServiceInfo{
Service: &defangv1.Service{Name: "service1"}})
project = append(project, &defangv1.ServiceInfo{
Service: &defangv1.Service{Name: "service2", Postgres: &defangv1.Postgres{}}})
project := types.Services{
"service1": types.ServiceConfig{},
"service2": types.ServiceConfig{
Extensions: map[string]any{"x-defang-postgres": true},
},
}

managed := GetUnreferencedManagedResources(project)
managed := getUnreferencedManagedResources(project)
if len(managed) != 1 {
t.Errorf("Expected 1 managed resource, got %d (%v)", len(managed), managed)
}
})

t.Run("two service two unmanaged", func(t *testing.T) {
project := []*defangv1.ServiceInfo{}
project = append(project, &defangv1.ServiceInfo{
Service: &defangv1.Service{Name: "service1"}})
project = append(project, &defangv1.ServiceInfo{
Service: &defangv1.Service{Name: "service2"}})
project := types.Services{
"service1": types.ServiceConfig{},
"service2": types.ServiceConfig{},
}

managed := GetUnreferencedManagedResources(project)
managed := getUnreferencedManagedResources(project)
if len(managed) != 0 {
t.Errorf("Expected 0 managed resource, got %d (%v)", len(managed), managed)
}
})

t.Run("one service two managed", func(t *testing.T) {
project := []*defangv1.ServiceInfo{}
project = append(project, &defangv1.ServiceInfo{
Service: &defangv1.Service{Name: "service1", Postgres: &defangv1.Postgres{}, Redis: &defangv1.Redis{}}})
project := types.Services{
"service1": types.ServiceConfig{
Extensions: map[string]any{"x-defang-postgres": true},
},
"service2": types.ServiceConfig{
Extensions: map[string]any{"x-defang-redis": true},
},
}

managed := GetUnreferencedManagedResources(project)
if len(managed) != 1 {
t.Errorf("Expected 1 managed resource, got %d (%s)", len(managed), managed)
managed := getUnreferencedManagedResources(project)
if len(managed) != 2 {
t.Errorf("Expected 2 managed resource, got %d (%s)", len(managed), managed)
}
})
}
15 changes: 8 additions & 7 deletions src/cmd/cli/command/deploymentinfo.go
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
package command

import (
"fmt"

"github.com/DefangLabs/defang/src/pkg/cli"
cliClient "github.com/DefangLabs/defang/src/pkg/cli/client"
"github.com/DefangLabs/defang/src/pkg/term"
defangv1 "github.com/DefangLabs/defang/src/protos/io/defang/v1"
)

const DEFANG_PORTAL_HOST = "portal.defang.dev"
const SERVICE_PORTAL_URL = "https://" + DEFANG_PORTAL_HOST + "/service"

func printPlaygroundPortalServiceURLs(serviceInfos []*defangv1.ServiceInfo) {
// We can only show services deployed to the prod1 defang SaaS environment.
if provider == cliClient.ProviderDefang && cluster == cli.DefaultCluster {
term.Info("Monitor your services' status in the defang portal")
for _, serviceInfo := range serviceInfos {
fmt.Println(" -", SERVICE_PORTAL_URL+"/"+serviceInfo.Service.Name)
term.Println(" -", SERVICE_PORTAL_URL+"/"+serviceInfo.Service.Name)
}
}
}
Expand All @@ -36,13 +37,13 @@ func printEndpoints(serviceInfos []*defangv1.ServiceInfo) {
if serviceInfo.Service.Ports[i].Mode == defangv1.Mode_INGRESS {
endpoint = "https://" + endpoint
}
fmt.Println(" -", endpoint)
term.Println(" -", endpoint)
}
if serviceInfo.Service.Domainname != "" {
if serviceInfo.Domainname != "" {
if serviceInfo.ZoneId != "" {
fmt.Println(" -", "https://"+serviceInfo.Service.Domainname)
term.Println(" -", "https://"+serviceInfo.Domainname)
} else {
fmt.Println(" -", "https://"+serviceInfo.Service.Domainname+" (after `defang cert generate` to get a TLS certificate)")
term.Println(" -", "https://"+serviceInfo.Domainname+" (after `defang cert generate` to get a TLS certificate)")
}
}
}
Expand Down
67 changes: 67 additions & 0 deletions src/cmd/cli/command/deploymentinfo_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
package command

import (
"bytes"
"testing"

"github.com/DefangLabs/defang/src/pkg/cli"
cliClient "github.com/DefangLabs/defang/src/pkg/cli/client"
"github.com/DefangLabs/defang/src/pkg/term"
defangv1 "github.com/DefangLabs/defang/src/protos/io/defang/v1"
)

func TestPrintPlaygroundPortalServiceURLs(t *testing.T) {
defaultTerm := term.DefaultTerm
t.Cleanup(func() {
term.DefaultTerm = defaultTerm
})

var stdout, stderr bytes.Buffer
term.DefaultTerm = term.NewTerm(&stdout, &stderr)

provider = cliClient.ProviderDefang
cluster = cli.DefaultCluster
printPlaygroundPortalServiceURLs([]*defangv1.ServiceInfo{
{
Service: &defangv1.Service{Name: "service1"},
}})
const want = ` * Monitor your services' status in the defang portal
- https://portal.defang.dev/service/service1
`
if got := stdout.String(); got != want {
t.Errorf("got %q, want %q", got, want)
}
}

func TestPrintEndpoints(t *testing.T) {
defaultTerm := term.DefaultTerm
t.Cleanup(func() {
term.DefaultTerm = defaultTerm
})

var stdout, stderr bytes.Buffer
term.DefaultTerm = term.NewTerm(&stdout, &stderr)

printEndpoints([]*defangv1.ServiceInfo{
{
Service: &defangv1.Service{
Name: "service1",
Ports: []*defangv1.Port{
{Mode: defangv1.Mode_INGRESS},
{Mode: defangv1.Mode_HOST},
},
},
Status: "UNKNOWN",
Endpoints: []string{
"example.com",
"service1.internal",
},
}})
const want = ` * Service service1 has status UNKNOWN and will be available at:
- https://example.com
- service1.internal
`
if got := stdout.String(); got != want {
t.Errorf("got %q, want %q", got, want)
}
}
19 changes: 10 additions & 9 deletions src/pkg/cli/cert.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (
"github.com/DefangLabs/defang/src/pkg"
"github.com/DefangLabs/defang/src/pkg/cert"
cliClient "github.com/DefangLabs/defang/src/pkg/cli/client"
"github.com/DefangLabs/defang/src/pkg/cli/compose"
"github.com/DefangLabs/defang/src/pkg/dns"
"github.com/DefangLabs/defang/src/pkg/spinner"
"github.com/DefangLabs/defang/src/pkg/term"
Expand Down Expand Up @@ -76,29 +77,29 @@ var (
)

func GenerateLetsEncryptCert(ctx context.Context, client cliClient.Client) error {
projectName, err := client.LoadProjectName(ctx)
project, err := client.LoadProject(ctx)
if err != nil {
return err
}
term.Debugf("Generating TLS cert for project %q", projectName)
term.Debugf("Generating TLS cert for project %q", project.Name)

services, err := client.GetServices(ctx)
if err != nil {
return err
}

cnt := 0
for _, service := range services.Services {
if service.Service != nil && service.Service.Domainname != "" && service.ZoneId == "" {
for _, serviceInfo := range services.Services {
if service, ok := project.Services[serviceInfo.Service.Name]; ok && service.DomainName != "" && serviceInfo.ZoneId == "" {
cnt++
targets := []string{service.PublicFqdn}
for i, endpoint := range service.Endpoints {
if service.Service.Ports[i].Mode == defangv1.Mode_INGRESS {
targets := []string{serviceInfo.PublicFqdn}
for i, endpoint := range serviceInfo.Endpoints {
if service.Ports[i].Mode == compose.Mode_INGRESS {
targets = append(targets, endpoint)
}
}
term.Debugf("Found service %v with domain %v and targets %v", service.Service.Name, service.Service.Domainname, targets)
generateCert(ctx, service.Service.Domainname, targets, client)
term.Debugf("Found service %v with domain %v and targets %v", service.Name, service.DomainName, targets)
generateCert(ctx, service.DomainName, targets, client)
}
}
if cnt == 0 {
Expand Down
4 changes: 0 additions & 4 deletions src/pkg/cli/cert_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,6 @@ import (
"time"
)

type dnsRequest struct {
Type string
Domain string
}
type tryResult struct {
result *http.Response
err error
Expand Down
Loading
Loading