Add gRPC API to push metadata of container image

pkg/app/api/grpcapi/api.go

@@ -34,11 +34,12 @@ import (
 
 // API implements the behaviors for the gRPC definitions of API.
 type API struct {
-	applicationStore datastore.ApplicationStore
-	environmentStore datastore.EnvironmentStore
-	deploymentStore  datastore.DeploymentStore
-	pipedStore       datastore.PipedStore
-	commandStore     commandstore.Store
+	applicationStore    datastore.ApplicationStore
+	environmentStore    datastore.EnvironmentStore
+	deploymentStore     datastore.DeploymentStore
+	pipedStore          datastore.PipedStore
+	imageReferenceStore datastore.ImageReferenceStore
+	commandStore        commandstore.Store
 
 	logger *zap.Logger
 }
@@ -50,12 +51,13 @@ func NewAPI(
 	logger *zap.Logger,
 ) *API {
 	a := &API{
-		applicationStore: datastore.NewApplicationStore(ds),
-		environmentStore: datastore.NewEnvironmentStore(ds),
-		deploymentStore:  datastore.NewDeploymentStore(ds),
-		pipedStore:       datastore.NewPipedStore(ds),
-		commandStore:     cmds,
-		logger:           logger.Named("api"),
+		applicationStore:    datastore.NewApplicationStore(ds),
+		environmentStore:    datastore.NewEnvironmentStore(ds),
+		deploymentStore:     datastore.NewDeploymentStore(ds),
+		pipedStore:          datastore.NewPipedStore(ds),
+		imageReferenceStore: datastore.NewImageReferenceStore(ds),
+		commandStore:        cmds,
+		logger:              logger.Named("api"),
 	}
 	return a
 }
@@ -312,6 +314,31 @@ func (a *API) GetCommand(ctx context.Context, req *apiservice.GetCommandRequest)
 	}, nil
 }
 
+func (a *API) PushImageReference(ctx context.Context, req *apiservice.PushImageReferenceRequest) (*apiservice.PushImageReferenceResponse, error) {
+	key, err := requireAPIKey(ctx, model.APIKey_READ_WRITE, a.logger)
+	if err != nil {
+		return nil, err
+	}
+
+	im := model.ImageReference{
+		Id:        uuid.New().String(),
+		RepoName:  req.RepoName,
+		Digest:    req.Digest,
+		Tags:      req.Tags,
+		ProjectId: key.ProjectId,
+	}
+	err = a.imageReferenceStore.AddImageReference(ctx, im)
+	if errors.Is(err, datastore.ErrAlreadyExists) {
+		return nil, status.Error(codes.AlreadyExists, "The image reference already exists")
+	}
+	if err != nil {
+		a.logger.Error("failed to add image reference", zap.Error(err))
+		return nil, status.Error(codes.Internal, "Failed to add image reference")
+	}
+
+	return &apiservice.PushImageReferenceResponse{}, nil
+}
+
 // requireAPIKey checks the existence of an API key inside the given context
 // and ensures that it has enough permissions for the give role.
 func requireAPIKey(ctx context.Context, role model.APIKey_Role, logger *zap.Logger) (*model.APIKey, error) {

pkg/app/api/service/apiservice/service.proto

@@ -34,6 +34,8 @@ service APIService {
     rpc GetDeployment(GetDeploymentRequest) returns (GetDeploymentResponse) {}
 
     rpc GetCommand(GetCommandRequest) returns (GetCommandResponse) {}
+
+    rpc PushImageReference(PushImageReferenceRequest) returns (PushImageReferenceResponse) {}
 }
 
 message AddApplicationRequest {
@@ -92,3 +94,12 @@ message GetCommandRequest {
 message GetCommandResponse {
     pipe.model.Command command = 1;
 }
+
+message PushImageReferenceRequest {
+    string repo_name = 1 [(validate.rules).string.min_len = 1];
+    repeated string tags = 2 [(validate.rules).repeated.min_items = 1];
+    string digest = 3;
+}
+
+message PushImageReferenceResponse {
+}

pkg/datastore/BUILD.bazel

@@ -9,6 +9,7 @@ go_library(
         "datastore.go",
         "deploymentstore.go",
         "environmentstore.go",
+        "imagereference.go",
         "mock.go",
         "pipedstatsstore.go",
         "pipedstore.go",
@@ -31,6 +32,7 @@ go_test(
         "commandstore_test.go",
         "deploymentstore_test.go",
         "environmentstore_test.go",
+        "imagereference_test.go",
         "pipedstatsstore_test.go",
         "pipedstore_test.go",
         "projectstore_test.go",

pkg/datastore/imagereference.go

@@ -0,0 +1,62 @@
+// Copyright 2021 The PipeCD 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 datastore
+
+import (
+	"context"
+	"time"
+
+	"github.com/pipe-cd/pipe/pkg/model"
+)
+
+const imageReferenceModelKind = "ImageReference"
+
+var (
+	imageReferenceFactory = func() interface{} {
+		return &model.ImageReference{}
+	}
+)
+
+type ImageReferenceStore interface {
+	AddImageReference(ctx context.Context, im model.ImageReference) error
+}
+
+type imageReferenceStore struct {
+	backend
+	nowFunc func() time.Time
+}
+
+func NewImageReferenceStore(ds DataStore) ImageReferenceStore {
+	return &imageReferenceStore{
+		backend: backend{
+			ds: ds,
+		},
+		nowFunc: time.Now,
+	}
+}
+
+func (s *imageReferenceStore) AddImageReference(ctx context.Context, im model.ImageReference) error {
+	now := s.nowFunc().Unix()
+	if im.CreatedAt == 0 {
+		im.CreatedAt = now
+	}
+	if im.UpdatedAt == 0 {
+		im.UpdatedAt = now
+	}
+	if err := im.Validate(); err != nil {
+		return err
+	}
+	return s.ds.Create(ctx, imageReferenceModelKind, im.Id, &im)
+}

pkg/datastore/imagereference_test.go

@@ -0,0 +1,75 @@
+// Copyright 2021 The PipeCD 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 datastore
+
+import (
+	"context"
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	"github.com/stretchr/testify/assert"
+
+	"github.com/pipe-cd/pipe/pkg/model"
+)
+
+func TestAddImageReference(t *testing.T) {
+	ctrl := gomock.NewController(t)
+	defer ctrl.Finish()
+
+	im := model.ImageReference{
+		Id:        "id",
+		RepoName:  "repo",
+		Tags:      []string{"tag"},
+		ProjectId: "projectId",
+		CreatedAt: 12345,
+		UpdatedAt: 12345,
+	}
+
+	testcases := []struct {
+		name    string
+		im      model.ImageReference
+		ds      DataStore
+		wantErr bool
+	}{
+		{
+			name: "Invalid image reference",
+			im:   model.ImageReference{},
+			ds: func() DataStore {
+				return NewMockDataStore(ctrl)
+			}(),
+			wantErr: true,
+		},
+		{
+			name: "OK to create",
+			im:   im,
+			ds: func() DataStore {
+				ds := NewMockDataStore(ctrl)
+				ds.EXPECT().
+					Create(gomock.Any(), "ImageReference", im.Id, &im).
+					Return(nil)
+				return ds
+			}(),
+			wantErr: false,
+		},
+	}
+
+	for _, tc := range testcases {
+		t.Run(tc.name, func(t *testing.T) {
+			s := NewImageReferenceStore(tc.ds)
+			err := s.AddImageReference(context.Background(), tc.im)
+			assert.Equal(t, tc.wantErr, err != nil)
+		})
+	}
+}

pkg/model/BUILD.bazel

@@ -12,6 +12,7 @@ proto_library(
         "deployment.proto",
         "environment.proto",
         "event.proto",
+        "imagereference.proto",
         "insight.proto",
         "logblock.proto",
         "piped.proto",

pkg/model/imagereference.proto

@@ -0,0 +1,38 @@
+// Copyright 2021 The PipeCD 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.
+
+syntax = "proto3";
+
+package pipe.model;
+option go_package = "github.com/pipe-cd/pipe/pkg/model";
+
+import "validate/validate.proto";
+
+message ImageReference {
+    // The generated unique identifier.
+    string id = 1 [(validate.rules).string.min_len = 1];
+    // The repository name.
+    string repo_name = 2 [(validate.rules).string.min_len = 1];
+    // The image digest.
+    string digest = 3;
+    // The image tags.
+    repeated string tags = 4 [(validate.rules).repeated.min_items = 1];
+    // The ID of the project this image belongs to.
+    string project_id = 5 [(validate.rules).string.min_len = 1];
+
+    // Unix time when the image metadata was created.
+    int64 created_at = 14 [(validate.rules).int64.gt = 0];
+    // Unix time of the last time when the image metadata is updated.
+    int64 updated_at = 15 [(validate.rules).int64.gt = 0];
+}