Delete tag retention rule and tag immutable rule when deleting project

fixes #18250

Signed-off-by: stonezdj <daojunz@vmware.com>

src/controller/event/handler/init.go

@@ -70,6 +70,7 @@ func init() {
 	_ = notifier.Subscribe(event.TopicPullArtifact, &internal.Handler{})
 	_ = notifier.Subscribe(event.TopicPushArtifact, &internal.Handler{})
 	_ = notifier.Subscribe(event.TopicDeleteArtifact, &internal.Handler{})
+	_ = notifier.Subscribe(event.TopicDeleteProject, &internal.Handler{})
 
 	_ = task.RegisterTaskStatusChangePostFunc(job.ReplicationVendorType, func(ctx context.Context, taskID int64, status string) error {
 		notification.AddEvent(ctx, &metadata.ReplicationMetaData{

src/controller/event/handler/internal/artifact.go

@@ -26,7 +26,9 @@ import (
 	"github.com/goharbor/harbor/src/controller/artifact"
 	"github.com/goharbor/harbor/src/controller/event"
 	"github.com/goharbor/harbor/src/controller/event/operator"
+	"github.com/goharbor/harbor/src/controller/immutable"
 	"github.com/goharbor/harbor/src/controller/repository"
+	"github.com/goharbor/harbor/src/controller/retention"
 	"github.com/goharbor/harbor/src/controller/tag"
 	"github.com/goharbor/harbor/src/jobservice/job"
 	"github.com/goharbor/harbor/src/lib/config"
@@ -102,6 +104,8 @@ func (a *Handler) Handle(ctx context.Context, value interface{}) error {
 		return a.onPush(ctx, v.ArtifactEvent)
 	case *event.DeleteArtifactEvent:
 		return a.onDelete(ctx, v.ArtifactEvent)
+	case *event.DeleteProjectEvent:
+		return a.onProjectDelete(ctx, v)
 	default:
 		log.Errorf("Can not handler this event type! %#v", v)
 	}
@@ -317,6 +321,21 @@ func (a *Handler) onDelete(ctx context.Context, event *event.ArtifactEvent) erro
 	return nil
 }
 
+func (a *Handler) onProjectDelete(ctx context.Context, event *event.DeleteProjectEvent) error {
+	log.Infof("delete project id: %d", event.ProjectID)
+	// delete tag immutable
+	err := immutable.Ctr.DeleteImmutableRuleByProject(ctx, event.ProjectID)
+	if err != nil {
+		log.Errorf("failed to delete immutable rule, error %v", err)
+	}
+	// delete tag retention
+	err = retention.Ctl.DeleteRetentionByProject(ctx, event.ProjectID)
+	if err != nil {
+		log.Errorf("failed to delete retention rule, error %v", err)
+	}
+	return nil
+}
+
 // isScannerUser check if the current user is a scanner user by its prefix
 // usually a scanner user should be named like `robot$<projectName>+<Scanner UUID (8byte)>-<Scanner Name>-<UUID>`
 // verify it by the prefix `robot$<projectName>+<Scanner UUID (8byte)>`

src/controller/event/handler/internal/artifact_test.go

@@ -24,13 +24,16 @@ import (
 
 	common_dao "github.com/goharbor/harbor/src/common/dao"
 	"github.com/goharbor/harbor/src/controller/event"
+	"github.com/goharbor/harbor/src/controller/immutable"
 	"github.com/goharbor/harbor/src/controller/scanner"
 	"github.com/goharbor/harbor/src/lib/config"
 	"github.com/goharbor/harbor/src/lib/orm"
 	"github.com/goharbor/harbor/src/pkg"
 	"github.com/goharbor/harbor/src/pkg/artifact"
 	_ "github.com/goharbor/harbor/src/pkg/config/db"
+	immutableModel "github.com/goharbor/harbor/src/pkg/immutable/model"
 	"github.com/goharbor/harbor/src/pkg/project"
+	"github.com/goharbor/harbor/src/pkg/project/models"
 	"github.com/goharbor/harbor/src/pkg/repository/model"
 	"github.com/goharbor/harbor/src/pkg/tag"
 	tagmodel "github.com/goharbor/harbor/src/pkg/tag/model/tag"
@@ -162,6 +165,48 @@ func (suite *ArtifactHandlerTestSuite) TestOnPull() {
 	}, 3*asyncFlushDuration, asyncFlushDuration/2, "wait for pull_count async update")
 }
 
+func (suite *ArtifactHandlerTestSuite) TestOnProjectDelete() {
+	// create project
+	projID, err := project.New().Create(suite.ctx, &models.Project{Name: "test-project", OwnerID: 1})
+	suite.Nil(err)
+
+	defer project.New().Delete(suite.ctx, projID)
+	immutableRule := &immutableModel.Metadata{
+		ProjectID: projID,
+		Priority:  1,
+		Action:    "immutable",
+		Template:  "immutable_template",
+		TagSelectors: []*immutableModel.Selector{
+			{
+				Kind:       "doublestar",
+				Decoration: "matches",
+				Pattern:    "release-**",
+			},
+		},
+		ScopeSelectors: map[string][]*immutableModel.Selector{
+			"repository": {
+				{
+					Kind:       "doublestar",
+					Decoration: "repoMatches",
+					Pattern:    "redis",
+				},
+			},
+		},
+	}
+	// create immutable rule
+	immutableID, err := immutable.Ctr.CreateImmutableRule(suite.ctx, immutableRule)
+	suite.Nil(err)
+
+	// emit delete project event
+	event := &event.DeleteProjectEvent{ProjectID: projID}
+	err = suite.handler.onProjectDelete(suite.ctx, event)
+	suite.Nil(err)
+
+	// check if immutable rule is deleted
+	_, err = immutable.Ctr.GetImmutableRule(suite.ctx, immutableID)
+	suite.NotNil(err)
+}
+
 func (suite *ArtifactHandlerTestSuite) TestOnDelete() {
 	evt := &event.ArtifactEvent{Artifact: &artifact.Artifact{ID: 1, RepositoryID: 1, Digest: "mock-digest", References: []*artifact.Reference{{ChildDigest: "ref-1", ChildID: 2}, {ChildDigest: "ref-2", ChildID: 3}}}}
 	suite.execMgr.On("DeleteByVendor", suite.ctx, "IMAGE_SCAN", int64(1)).Return(nil).Times(1)

src/controller/immutable/controller.go

@@ -47,13 +47,29 @@ type Controller interface {
 
 	// Count count the immutable rules
 	Count(ctx context.Context, query *q.Query) (int64, error)
+
+	// DeleteImmutableRuleByProject delete immuatable rules with project id
+	DeleteImmutableRuleByProject(ctx context.Context, projectID int64) error
 }
 
 // DefaultAPIController ...
 type DefaultAPIController struct {
 	manager immutable.Manager
 }
 
+func (r *DefaultAPIController) DeleteImmutableRuleByProject(ctx context.Context, projectID int64) error {
+	rules, err := r.ListImmutableRules(ctx, q.New(q.KeyWords{"ProjectID": projectID}))
+	if err != nil {
+		return err
+	}
+	for _, rule := range rules {
+		if err = r.DeleteImmutableRule(ctx, rule.ID); err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
 // GetImmutableRule ...
 func (r *DefaultAPIController) GetImmutableRule(ctx context.Context, id int64) (*model.Metadata, error) {
 	return r.manager.GetImmutableRule(ctx, id)

src/controller/retention/controller.go

@@ -62,6 +62,8 @@ type Controller interface {
 	GetRetentionExecTaskLog(ctx context.Context, taskID int64) ([]byte, error)
 
 	GetRetentionExecTask(ctx context.Context, taskID int64) (*retention.Task, error)
+	// DeleteRetentionByProject delete retetion rule by project id
+	DeleteRetentionByProject(ctx context.Context, projectID int64) error
 }
 
 var (
@@ -405,6 +407,21 @@ func (r *defaultController) UpdateTaskInfo(ctx context.Context, taskID int64, to
 	return r.taskMgr.UpdateExtraAttrs(ctx, taskID, t.ExtraAttrs)
 }
 
+func (r *defaultController) DeleteRetentionByProject(ctx context.Context, projectID int64) error {
+	policyIDs, err := r.manager.ListPolicyIDs(ctx,
+		q.New(q.KeyWords{"scope_level": "project",
+			"scope_reference": fmt.Sprintf("%d", projectID)}))
+	if err != nil {
+		return err
+	}
+	for _, policyID := range policyIDs {
+		if err := r.DeleteRetention(ctx, policyID); err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
 // NewController ...
 func NewController() Controller {
 	retentionMgr := retention.NewManager()

src/pkg/retention/dao/retention.go

@@ -18,6 +18,7 @@ import (
 	"context"
 
 	"github.com/goharbor/harbor/src/lib/orm"
+	"github.com/goharbor/harbor/src/lib/q"
 	"github.com/goharbor/harbor/src/pkg/retention/dao/models"
 )
 
@@ -67,3 +68,16 @@ func GetPolicy(ctx context.Context, id int64) (*models.RetentionPolicy, error) {
 	}
 	return p, nil
 }
+
+// ListPolicy list retention policy by query
+func ListPolicy(ctx context.Context, query *q.Query) ([]*models.RetentionPolicy, error) {
+	plcs := []*models.RetentionPolicy{}
+	qs, err := orm.QuerySetter(ctx, &models.RetentionPolicy{}, query)
+	if err != nil {
+		return nil, err
+	}
+	if _, err = qs.All(&plcs); err != nil {
+		return nil, err
+	}
+	return plcs, nil
+}

src/pkg/retention/dao/retention_test.go

@@ -11,6 +11,7 @@ import (
 
 	"github.com/goharbor/harbor/src/common/dao"
 	"github.com/goharbor/harbor/src/lib/orm"
+	"github.com/goharbor/harbor/src/lib/q"
 	"github.com/goharbor/harbor/src/pkg/retention/dao/models"
 	"github.com/goharbor/harbor/src/pkg/retention/policy"
 	"github.com/goharbor/harbor/src/pkg/retention/policy/rule"
@@ -63,10 +64,11 @@ func TestPolicy(t *testing.T) {
 		},
 	}
 	p1 := &models.RetentionPolicy{
-		ScopeLevel:  p.Scope.Level,
-		TriggerKind: p.Trigger.Kind,
-		CreateTime:  time.Now(),
-		UpdateTime:  time.Now(),
+		ScopeLevel:     p.Scope.Level,
+		ScopeReference: 1,
+		TriggerKind:    p.Trigger.Kind,
+		CreateTime:     time.Now(),
+		UpdateTime:     time.Now(),
 	}
 	data, _ := json.Marshal(p)
 	p1.Data = string(data)
@@ -81,6 +83,10 @@ func TestPolicy(t *testing.T) {
 	assert.EqualValues(t, "project", p1.ScopeLevel)
 	assert.True(t, p1.ID > 0)
 
+	plcs, err := ListPolicy(ctx, q.New(q.KeyWords{"scope_level": "project", "scope_reference": "1"}))
+	assert.Nil(t, err)
+	assert.True(t, len(plcs) > 0)
+
 	p1.ScopeLevel = "test"
 	err = UpdatePolicy(ctx, p1)
 	assert.Nil(t, err)

src/pkg/retention/launcher_test.go

@@ -24,6 +24,7 @@ import (
 
 	"github.com/goharbor/harbor/src/common/job"
 	"github.com/goharbor/harbor/src/lib/orm"
+	pq "github.com/goharbor/harbor/src/lib/q"
 	_ "github.com/goharbor/harbor/src/lib/selector/selectors/doublestar"
 	"github.com/goharbor/harbor/src/pkg/project"
 	proModels "github.com/goharbor/harbor/src/pkg/project/models"
@@ -40,6 +41,9 @@ import (
 
 type fakeRetentionManager struct{}
 
+func (f *fakeRetentionManager) ListPolicyIDs(ctx context.Context, query *pq.Query) ([]int64, error) {
+	return nil, nil
+}
 func (f *fakeRetentionManager) GetTotalOfRetentionExecs(policyID int64) (int64, error) {
 	return 0, nil
 }

src/pkg/retention/manager.go

@@ -24,6 +24,7 @@ import (
 	"github.com/go-openapi/strfmt"
 
 	"github.com/goharbor/harbor/src/common/utils"
+	"github.com/goharbor/harbor/src/lib/q"
 	"github.com/goharbor/harbor/src/pkg/retention/dao"
 	"github.com/goharbor/harbor/src/pkg/retention/dao/models"
 	"github.com/goharbor/harbor/src/pkg/retention/policy"
@@ -41,6 +42,8 @@ type Manager interface {
 	DeletePolicy(ctx context.Context, id int64) error
 	// Get the specified policy
 	GetPolicy(ctx context.Context, id int64) (*policy.Metadata, error)
+	// List the retention policy with query conditions
+	ListPolicyIDs(ctx context.Context, query *q.Query) ([]int64, error)
 }
 
 // DefaultManager ...
@@ -103,6 +106,19 @@ func (d *DefaultManager) GetPolicy(ctx context.Context, id int64) (*policy.Metad
 	return p, nil
 }
 
+// ListPolicyIDs list policy id by query
+func (d *DefaultManager) ListPolicyIDs(ctx context.Context, query *q.Query) ([]int64, error) {
+	policyIDs := make([]int64, 0)
+	plcs, err := dao.ListPolicy(ctx, query)
+	if err != nil {
+		return nil, err
+	}
+	for _, p := range plcs {
+		policyIDs = append(policyIDs, p.ID)
+	}
+	return policyIDs, nil
+}
+
 // NewManager ...
 func NewManager() Manager {
 	return &DefaultManager{}