Merge pull request #1779 from ndeloof/labels

define compose labels within the compose API

Author: ndeloof

api/compose/labels.go

@@ -0,0 +1,44 @@
+/*
+   Copyright 2020 Docker Compose CLI authors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package compose
+
+const (
+	// ProjectLabel allow to track resource related to a compose project
+	ProjectLabel = "com.docker.compose.project"
+	// ServiceLabel allow to track resource related to a compose service
+	ServiceLabel = "com.docker.compose.service"
+	// ConfigHashLabel stores configuration hash for a compose service
+	ConfigHashLabel = "com.docker.compose.config-hash"
+	// ContainerNumberLabel stores the container index of a replicated service
+	ContainerNumberLabel = "com.docker.compose.container-number"
+	// VolumeLabel allow to track resource related to a compose volume
+	VolumeLabel = "com.docker.compose.volume"
+	// NetworkLabel allow to track resource related to a compose network
+	NetworkLabel = "com.docker.compose.network"
+	// WorkingDirLabel stores absolute path to compose project working directory
+	WorkingDirLabel = "com.docker.compose.project.working_dir"
+	// ConfigFilesLabel stores absolute path to compose project configuration files
+	ConfigFilesLabel = "com.docker.compose.project.config_files"
+	// EnvironmentFileLabel stores absolute path to compose project env file set by `--env-file`
+	EnvironmentFileLabel = "com.docker.compose.project.environment_file"
+	// OneoffLabel stores value 'True' for one-off containers created by `compose run`
+	OneoffLabel = "com.docker.compose.oneoff"
+	// SlugLabel stores unique slug used for one-off container identity
+	SlugLabel = "com.docker.compose.slug"
+	// VersionLabel stores the compose tool version used to run application
+	VersionLabel = "com.docker.compose.version"
+)

api/compose/tags.go

@@ -289,8 +289,8 @@ func (b *ecsAPIService) parseExternalVolumes(ctx context.Context, project *types
 
 		logrus.Debugf("searching for existing filesystem as volume %q", name)
 		tags := map[string]string{
-			compose.ProjectTag: project.Name,
-			compose.VolumeTag:  name,
+			compose.ProjectLabel: project.Name,
+			compose.VolumeLabel:  name,
 		}
 		previous, err := b.aws.ListFileSystems(ctx, tags)
 		if err != nil {
@@ -397,11 +397,11 @@ func (b *ecsAPIService) ensureVolumes(r *awsResources, project *types.Project, t
 			FileSystemPolicy: nil,
 			FileSystemTags: []efs.FileSystem_ElasticFileSystemTag{
 				{
-					Key:   compose.ProjectTag,
+					Key:   compose.ProjectLabel,
 					Value: project.Name,
 				},
 				{
-					Key:   compose.VolumeTag,
+					Key:   compose.VolumeLabel,
 					Value: name,
 				},
 				{

ecs/awsResources.go

@@ -406,8 +406,8 @@ volumes:
         provisioned_throughput: 1024
 `, useDefaultVPC, func(m *MockAPIMockRecorder) {
 		m.ListFileSystems(gomock.Any(), map[string]string{
-			compose.ProjectTag: t.Name(),
-			compose.VolumeTag:  "db-data",
+			compose.ProjectLabel: t.Name(),
+			compose.VolumeLabel:  "db-data",
 		}).Return(nil, nil)
 	})
 	n := volumeResourceName("db-data")
@@ -452,8 +452,8 @@ volumes:
   db-data: {}
 `, useDefaultVPC, func(m *MockAPIMockRecorder) {
 		m.ListFileSystems(gomock.Any(), map[string]string{
-			compose.ProjectTag: t.Name(),
-			compose.VolumeTag:  "db-data",
+			compose.ProjectLabel: t.Name(),
+			compose.VolumeLabel:  "db-data",
 		}).Return([]awsResource{
 			existingAWSResource{
 				id: "fs-123abc",
@@ -521,7 +521,7 @@ services:
 		for i := 0; i < tags.Len(); i++ {
 			k := tags.Index(i).FieldByName("Key").String()
 			v := tags.Index(i).FieldByName("Value").String()
-			if k == compose.ProjectTag {
+			if k == compose.ProjectLabel {
 				assert.Equal(t, v, t.Name())
 			}
 		}

ecs/cloudformation_test.go

@@ -341,7 +341,7 @@ func (s sdk) CreateStack(ctx context.Context, name string, region string, templa
 			},
 			Tags: []*cloudformation.Tag{
 				{
-					Key:   aws.String(compose.ProjectTag),
+					Key:   aws.String(compose.ProjectLabel),
 					Value: aws.String(name),
 				},
 			},
@@ -455,7 +455,7 @@ func (s sdk) ListStacks(ctx context.Context) ([]compose.Stack, error) {
 		}
 		for _, stack := range response.Stacks {
 			for _, t := range stack.Tags {
-				if *t.Key == compose.ProjectTag {
+				if *t.Key == compose.ProjectLabel {
 					status := compose.RUNNING
 					switch aws.StringValue(stack.StackStatus) {
 					case "CREATE_IN_PROGRESS":
@@ -860,12 +860,12 @@ func (s sdk) DescribeService(ctx context.Context, cluster string, arn string) (c
 	service := services.Services[0]
 	var name string
 	for _, t := range service.Tags {
-		if *t.Key == compose.ServiceTag {
+		if *t.Key == compose.ServiceLabel {
 			name = aws.StringValue(t.Value)
 		}
 	}
 	if name == "" {
-		return compose.ServiceStatus{}, fmt.Errorf("service %s doesn't have a %s tag", *service.ServiceArn, compose.ServiceTag)
+		return compose.ServiceStatus{}, fmt.Errorf("service %s doesn't have a %s tag", *service.ServiceArn, compose.ServiceLabel)
 	}
 	targetGroupArns := []string{}
 	for _, lb := range service.LoadBalancers {
@@ -919,9 +919,9 @@ func (s sdk) DescribeServiceTasks(ctx context.Context, cluster string, project s
 			var service string
 			for _, tag := range t.Tags {
 				switch aws.StringValue(tag.Key) {
-				case compose.ProjectTag:
+				case compose.ProjectLabel:
 					project = aws.StringValue(tag.Value)
-				case compose.ServiceTag:
+				case compose.ServiceLabel:
 					service = aws.StringValue(tag.Value)
 				}
 			}

ecs/sdk.go

@@ -26,7 +26,7 @@ import (
 func projectTags(project *types.Project) []tags.Tag {
 	return []tags.Tag{
 		{
-			Key:   compose.ProjectTag,
+			Key:   compose.ProjectLabel,
 			Value: project.Name,
 		},
 	}
@@ -35,11 +35,11 @@ func projectTags(project *types.Project) []tags.Tag {
 func serviceTags(project *types.Project, service types.ServiceConfig) []tags.Tag {
 	return []tags.Tag{
 		{
-			Key:   compose.ProjectTag,
+			Key:   compose.ProjectLabel,
 			Value: project.Name,
 		},
 		{
-			Key:   compose.ServiceTag,
+			Key:   compose.ServiceLabel,
 			Value: service.Name,
 		},
 	}
@@ -48,11 +48,11 @@ func serviceTags(project *types.Project, service types.ServiceConfig) []tags.Tag
 func networkTags(project *types.Project, net types.NetworkConfig) []tags.Tag {
 	return []tags.Tag{
 		{
-			Key:   compose.ProjectTag,
+			Key:   compose.ProjectLabel,
 			Value: project.Name,
 		},
 		{
-			Key:   compose.NetworkTag,
+			Key:   compose.NetworkLabel,
 			Value: net.Name,
 		},
 	}

ecs/tags.go

@@ -63,11 +63,11 @@ func (b *ecsAPIService) createAccessPoints(project *types.Project, r awsResource
 		ap := efs.AccessPoint{
 			AccessPointTags: []efs.AccessPoint_AccessPointTag{
 				{
-					Key:   compose.ProjectTag,
+					Key:   compose.ProjectLabel,
 					Value: project.Name,
 				},
 				{
-					Key:   compose.VolumeTag,
+					Key:   compose.VolumeLabel,
 					Value: name,
 				},
 				{

ecs/volumes.go

@@ -77,7 +77,7 @@ func NewKubeClient(config genericclioptions.RESTClientGetter) (*KubeClient, erro
 // GetPod retrieves a service pod
 func (kc KubeClient) GetPod(ctx context.Context, projectName, serviceName string) (*corev1.Pod, error) {
 	pods, err := kc.client.CoreV1().Pods(kc.namespace).List(ctx, metav1.ListOptions{
-		LabelSelector: fmt.Sprintf("%s=%s", compose.ProjectTag, projectName),
+		LabelSelector: fmt.Sprintf("%s=%s", compose.ProjectLabel, projectName),
 	})
 	if err != nil {
 		return nil, err
@@ -87,7 +87,7 @@ func (kc KubeClient) GetPod(ctx context.Context, projectName, serviceName string
 	}
 	var pod corev1.Pod
 	for _, p := range pods.Items {
-		service := p.Labels[compose.ServiceTag]
+		service := p.Labels[compose.ServiceLabel]
 		if service == serviceName {
 			pod = p
 			break
@@ -155,7 +155,7 @@ func (kc KubeClient) GetContainers(ctx context.Context, projectName string, all
 	}
 
 	pods, err := kc.client.CoreV1().Pods(kc.namespace).List(ctx, metav1.ListOptions{
-		LabelSelector: fmt.Sprintf("%s=%s", compose.ProjectTag, projectName),
+		LabelSelector: fmt.Sprintf("%s=%s", compose.ProjectLabel, projectName),
 		FieldSelector: fieldSelector,
 	})
 	if err != nil {
@@ -165,7 +165,7 @@ func (kc KubeClient) GetContainers(ctx context.Context, projectName string, all
 	result := []compose.ContainerSummary{}
 	for _, pod := range pods.Items {
 		summary := podToContainerSummary(pod)
-		serviceName := pod.GetObjectMeta().GetLabels()[compose.ServiceTag]
+		serviceName := pod.GetObjectMeta().GetLabels()[compose.ServiceLabel]
 		ports, ok := services[serviceName]
 		if !ok {
 			s, err := kc.client.CoreV1().Services(kc.namespace).Get(ctx, serviceName, metav1.GetOptions{})
@@ -202,15 +202,15 @@ func (kc KubeClient) GetContainers(ctx context.Context, projectName string, all
 // GetLogs retrieves pod logs
 func (kc *KubeClient) GetLogs(ctx context.Context, projectName string, consumer compose.LogConsumer, follow bool) error {
 	pods, err := kc.client.CoreV1().Pods(kc.namespace).List(ctx, metav1.ListOptions{
-		LabelSelector: fmt.Sprintf("%s=%s", compose.ProjectTag, projectName),
+		LabelSelector: fmt.Sprintf("%s=%s", compose.ProjectLabel, projectName),
 	})
 	if err != nil {
 		return err
 	}
 	eg, ctx := errgroup.WithContext(ctx)
 	for _, pod := range pods.Items {
 		request := kc.client.CoreV1().Pods(kc.namespace).GetLogs(pod.Name, &corev1.PodLogOptions{Follow: follow})
-		service := pod.Labels[compose.ServiceTag]
+		service := pod.Labels[compose.ServiceLabel]
 		w := utils.GetWriter(func(line string) {
 			consumer.Log(pod.Name, service, line)
 		})
@@ -243,7 +243,7 @@ func (kc KubeClient) WaitForPodState(ctx context.Context, opts WaitForStatusOpti
 			time.Sleep(500 * time.Millisecond)
 
 			pods, err := kc.client.CoreV1().Pods(kc.namespace).List(ctx, metav1.ListOptions{
-				LabelSelector: fmt.Sprintf("%s=%s", compose.ProjectTag, opts.ProjectName),
+				LabelSelector: fmt.Sprintf("%s=%s", compose.ProjectLabel, opts.ProjectName),
 			})
 			if err != nil {
 				errch <- err

kube/client/client.go

@@ -34,8 +34,8 @@ func TestPodToContainerSummary(t *testing.T) {
 		ObjectMeta: metav1.ObjectMeta{
 			Name: "c1-123",
 			Labels: map[string]string{
-				compose.ProjectTag: "myproject",
-				compose.ServiceTag: "service1",
+				compose.ProjectLabel: "myproject",
+				compose.ServiceLabel: "service1",
 			},
 		},
 		Status: v1.PodStatus{

kube/client/client_test.go

@@ -47,17 +47,17 @@ func podToContainerSummary(pod corev1.Pod) compose.ContainerSummary {
 	return compose.ContainerSummary{
 		ID:      pod.GetObjectMeta().GetName(),
 		Name:    pod.GetObjectMeta().GetName(),
-		Service: pod.GetObjectMeta().GetLabels()[compose.ServiceTag],
+		Service: pod.GetObjectMeta().GetLabels()[compose.ServiceLabel],
 		State:   state,
-		Project: pod.GetObjectMeta().GetLabels()[compose.ProjectTag],
+		Project: pod.GetObjectMeta().GetLabels()[compose.ProjectLabel],
 	}
 }
 
 func checkPodsState(services []string, pods []corev1.Pod, status string) (bool, map[string]string, error) {
 	servicePods := map[string]string{}
 	stateReached := true
 	for _, pod := range pods {
-		service := pod.Labels[compose.ServiceTag]
+		service := pod.Labels[compose.ServiceLabel]
 
 		if len(services) > 0 && !utils.StringContains(services, service) {
 			continue