Update purge audit to purge both audit_log_ext and audit_log (#21608)

Fix integration issue with UI

Signed-off-by: stonezdj <stone.zhang@broadcom.com>
This commit is contained in:
stonezdj(Daojun Zhang) 2025-02-18 17:45:46 +08:00 committed by GitHub
parent add0b600e1
commit 45659070b7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
16 changed files with 85 additions and 50 deletions

View File

@ -4486,7 +4486,7 @@ paths:
description: | description: |
The purge job's schedule, it is a json object. | The purge job's schedule, it is a json object. |
The sample format is | The sample format is |
{"parameters":{"audit_retention_hour":168,"dry_run":true, "include_operations":"create,delete,pull"},"schedule":{"type":"Hourly","cron":"0 0 * * * *"}} | {"parameters":{"audit_retention_hour":168,"dry_run":true,"include_event_types":"create_artifact,delete_artifact,pull_artifact"},"schedule":{"type":"Hourly","cron":"0 0 * * * *"}} |
the include_operation should be a comma separated string, e.g. create,delete,pull, if it is empty, no operation will be purged. the include_operation should be a comma separated string, e.g. create,delete,pull, if it is empty, no operation will be purged.
tags: tags:
- purge - purge
@ -4516,7 +4516,7 @@ paths:
description: | description: |
The purge job's schedule, it is a json object. | The purge job's schedule, it is a json object. |
The sample format is | The sample format is |
{"parameters":{"audit_retention_hour":168,"dry_run":true, "include_operations":"create,delete,pull"},"schedule":{"type":"Hourly","cron":"0 0 * * * *"}} | {"parameters":{"audit_retention_hour":168,"dry_run":true,"include_event_types":"create_artifact,delete_artifact,pull_artifact"},"schedule":{"type":"Hourly","cron":"0 0 * * * *"}} |
the include_operation should be a comma separated string, e.g. create,delete,pull, if it is empty, no operation will be purged. the include_operation should be a comma separated string, e.g. create,delete,pull, if it is empty, no operation will be purged.
tags: tags:
- purge - purge
@ -9101,6 +9101,9 @@ definitions:
banner_message: banner_message:
$ref: '#/definitions/StringConfigItem' $ref: '#/definitions/StringConfigItem'
description: The banner message for the UI.It is the stringified result of the banner message object description: The banner message for the UI.It is the stringified result of the banner message object
disabled_audit_log_event_types:
$ref: '#/definitions/StringConfigItem'
description: The audit log event types to skip to log in database
Configurations: Configurations:
type: object type: object
properties: properties:
@ -9379,6 +9382,11 @@ definitions:
description: The banner message for the UI.It is the stringified result of the banner message object description: The banner message for the UI.It is the stringified result of the banner message object
x-omitempty: true x-omitempty: true
x-isnullable: true x-isnullable: true
disabled_audit_log_event_types:
type: string
description: the list to disable log audit event types.
x-omitempty: true
x-isnullable: true
StringConfigItem: StringConfigItem:
type: object type: object
properties: properties:

View File

@ -208,7 +208,7 @@ const (
// 24h. // 24h.
DefaultCacheExpireHours = 24 DefaultCacheExpireHours = 24
PurgeAuditIncludeOperations = "include_operations" PurgeAuditIncludeEventTypes = "include_event_types"
PurgeAuditDryRun = "dry_run" PurgeAuditDryRun = "dry_run"
PurgeAuditRetentionHour = "audit_retention_hour" PurgeAuditRetentionHour = "audit_retention_hour"
// AuditLogForwardEndpoint indicate to forward the audit log to an endpoint // AuditLogForwardEndpoint indicate to forward the audit log to an endpoint
@ -220,8 +220,8 @@ const (
// ScannerSkipUpdatePullTime // ScannerSkipUpdatePullTime
ScannerSkipUpdatePullTime = "scanner_skip_update_pulltime" ScannerSkipUpdatePullTime = "scanner_skip_update_pulltime"
// AuditLogEventsDisabled // AuditLogEventsDisabled ...
AuditLogEventsDisabled = "audit_log_events_disabled" AuditLogEventsDisabled = "disabled_audit_log_event_types"
// SessionTimeout defines the web session timeout // SessionTimeout defines the web session timeout
SessionTimeout = "session_timeout" SessionTimeout = "session_timeout"

View File

@ -72,7 +72,7 @@ func (c *controller) Start(ctx context.Context, policy JobPolicy, trigger string
para[common.PurgeAuditDryRun] = policy.DryRun para[common.PurgeAuditDryRun] = policy.DryRun
para[common.PurgeAuditRetentionHour] = policy.RetentionHour para[common.PurgeAuditRetentionHour] = policy.RetentionHour
para[common.PurgeAuditIncludeOperations] = policy.IncludeOperations para[common.PurgeAuditIncludeEventTypes] = policy.IncludeEventTypes
execID, err := c.exeMgr.Create(ctx, job.PurgeAuditVendorType, -1, trigger, para) execID, err := c.exeMgr.Create(ctx, job.PurgeAuditVendorType, -1, trigger, para)
if err != nil { if err != nil {

View File

@ -25,7 +25,7 @@ type JobPolicy struct {
Trigger *Trigger `json:"trigger"` Trigger *Trigger `json:"trigger"`
DryRun bool `json:"dryrun"` DryRun bool `json:"dryrun"`
RetentionHour int `json:"retention_hour"` RetentionHour int `json:"retention_hour"`
IncludeOperations string `json:"include_operations"` IncludeEventTypes string `json:"include_event_types"`
ExtraAttrs map[string]interface{} `json:"extra_attrs"` ExtraAttrs map[string]interface{} `json:"extra_attrs"`
} }

View File

@ -21,14 +21,16 @@ import (
"github.com/goharbor/harbor/src/common" "github.com/goharbor/harbor/src/common"
"github.com/goharbor/harbor/src/jobservice/job" "github.com/goharbor/harbor/src/jobservice/job"
"github.com/goharbor/harbor/src/pkg/audit" "github.com/goharbor/harbor/src/pkg/audit"
"github.com/goharbor/harbor/src/pkg/auditext"
) )
// Job defines the purge job // Job defines the purge job
type Job struct { type Job struct {
retentionHour int retentionHour int
includeOperations []string includeEventTypes []string
dryRun bool dryRun bool
auditMgr audit.Manager auditMgr audit.Manager
auditExtMgr auditext.Manager
} }
// MaxFails is implementation of same method in Interface. // MaxFails is implementation of same method in Interface.
@ -72,18 +74,19 @@ func (j *Job) parseParams(params job.Parameters) {
} }
} }
j.includeOperations = []string{} j.includeEventTypes = []string{}
operations, exist := params[common.PurgeAuditIncludeOperations] operations, exist := params[common.PurgeAuditIncludeEventTypes]
if exist { if exist {
if includeOps, ok := operations.(string); ok { if includeOps, ok := operations.(string); ok {
if len(includeOps) > 0 { if len(includeOps) > 0 {
j.includeOperations = strings.Split(includeOps, ",") j.includeEventTypes = strings.Split(includeOps, ",")
} }
} }
} }
// UT will use the mock mgr // UT will use the mock mgr
if os.Getenv("UTTEST") != "true" { if os.Getenv("UTTEST") != "true" {
j.auditMgr = audit.Mgr j.auditMgr = audit.Mgr
j.auditExtMgr = auditext.Mgr
} }
} }
@ -106,17 +109,24 @@ func (j *Job) Run(ctx job.Context, params job.Parameters) error {
if j.retentionHour > common.MaxAuditRetentionHour { if j.retentionHour > common.MaxAuditRetentionHour {
j.retentionHour = common.MaxAuditRetentionHour j.retentionHour = common.MaxAuditRetentionHour
} }
n, err := j.auditMgr.Purge(ormCtx, j.retentionHour, j.includeOperations, j.dryRun) n, err := j.auditMgr.Purge(ormCtx, j.retentionHour, j.includeEventTypes, j.dryRun)
if err != nil { if err != nil {
logger.Errorf("failed to purge audit log, error: %v", err) logger.Errorf("failed to purge audit log, error: %v", err)
return err return err
} }
logger.Infof("Purge operation parameter, retention_hour=%v, include_operations:%v, dry_run:%v", n2, err2 := j.auditExtMgr.Purge(ormCtx, j.retentionHour, j.includeEventTypes, j.dryRun)
j.retentionHour, j.includeOperations, j.dryRun) if err2 != nil {
logger.Errorf("failed to purge audit log ext, error: %v", err2)
return err2
}
logger.Infof("Purge operation parameter, retention_hour:%v, include_event_types:%v, dry_run:%v",
j.retentionHour, j.includeEventTypes, j.dryRun)
if j.dryRun { if j.dryRun {
logger.Infof("[DRYRUN]Purged %d rows of audit logs", n) logger.Infof("[DRYRUN]Purged %d rows of audit logs", n)
logger.Infof("[DRYRUN]Purged %d rows of audit log exts", n2)
} else { } else {
logger.Infof("Purged %d rows of audit logs", n) logger.Infof("Purged %d rows of audit logs", n)
logger.Infof("Purged %d rows of audit log exts", n2)
} }
// Successfully exit // Successfully exit

View File

@ -27,6 +27,7 @@ import (
mockjobservice "github.com/goharbor/harbor/src/testing/jobservice" mockjobservice "github.com/goharbor/harbor/src/testing/jobservice"
"github.com/goharbor/harbor/src/testing/mock" "github.com/goharbor/harbor/src/testing/mock"
mockAudit "github.com/goharbor/harbor/src/testing/pkg/audit" mockAudit "github.com/goharbor/harbor/src/testing/pkg/audit"
mockauditext "github.com/goharbor/harbor/src/testing/pkg/auditext"
) )
type PurgeJobTestSuite struct { type PurgeJobTestSuite struct {
@ -51,14 +52,14 @@ func (suite *PurgeJobTestSuite) TestParseParams() {
j.parseParams(param) j.parseParams(param)
suite.Require().Equal(true, j.dryRun) suite.Require().Equal(true, j.dryRun)
suite.Require().Equal(128, j.retentionHour) suite.Require().Equal(128, j.retentionHour)
suite.Require().Equal([]string{}, j.includeOperations) suite.Require().Equal([]string{}, j.includeEventTypes)
j2 := &Job{} j2 := &Job{}
param2 := job.Parameters{common.PurgeAuditRetentionHour: 24, common.PurgeAuditDryRun: false, common.PurgeAuditIncludeOperations: "Delete,Create,Pull"} param2 := job.Parameters{common.PurgeAuditRetentionHour: 24, common.PurgeAuditDryRun: false, common.PurgeAuditIncludeEventTypes: "delete_artifact,create_artifact,pull_artifact"}
j2.parseParams(param2) j2.parseParams(param2)
suite.Require().Equal(false, j2.dryRun) suite.Require().Equal(false, j2.dryRun)
suite.Require().Equal(24, j2.retentionHour) suite.Require().Equal(24, j2.retentionHour)
suite.Require().Equal([]string{"Delete", "Create", "Pull"}, j2.includeOperations) suite.Require().Equal([]string{"delete_artifact", "create_artifact", "pull_artifact"}, j2.includeEventTypes)
} }
func (suite *PurgeJobTestSuite) TestRun() { func (suite *PurgeJobTestSuite) TestRun() {
@ -67,14 +68,16 @@ func (suite *PurgeJobTestSuite) TestRun() {
ctx.On("GetLogger").Return(logger) ctx.On("GetLogger").Return(logger)
ctx.On("OPCommand").Return(job.NilCommand, true) ctx.On("OPCommand").Return(job.NilCommand, true)
auditManager := &mockAudit.Manager{} auditManager := &mockAudit.Manager{}
auditExtManager := &mockauditext.Manager{}
auditManager.On("Purge", mock.Anything, 128, []string{}, true).Return(int64(100), nil) auditManager.On("Purge", mock.Anything, 128, []string{}, true).Return(int64(100), nil)
j := &Job{auditMgr: auditManager} auditExtManager.On("Purge", mock.Anything, 128, []string{}, true).Return(int64(100), nil)
j := &Job{auditMgr: auditManager, auditExtMgr: auditExtManager}
param := job.Parameters{common.PurgeAuditRetentionHour: 128, common.PurgeAuditDryRun: true} param := job.Parameters{common.PurgeAuditRetentionHour: 128, common.PurgeAuditDryRun: true}
ret := j.Run(ctx, param) ret := j.Run(ctx, param)
suite.Require().Nil(ret) suite.Require().Nil(ret)
auditManager.On("Purge", mock.Anything, 24, []string{}, false).Return(int64(0), fmt.Errorf("failed to connect database")) auditManager.On("Purge", mock.Anything, 24, []string{}, false).Return(int64(0), fmt.Errorf("failed to connect database"))
j2 := &Job{auditMgr: auditManager} j2 := &Job{auditMgr: auditManager, auditExtMgr: auditExtManager}
param2 := job.Parameters{common.PurgeAuditRetentionHour: 24, common.PurgeAuditDryRun: false} param2 := job.Parameters{common.PurgeAuditRetentionHour: 24, common.PurgeAuditDryRun: false}
ret2 := j2.Run(ctx, param2) ret2 := j2.Run(ctx, param2)
suite.Require().NotNil(ret2) suite.Require().NotNil(ret2)
@ -85,7 +88,8 @@ func (suite *PurgeJobTestSuite) TestStop() {
ctx.On("GetLogger").Return(logger) ctx.On("GetLogger").Return(logger)
ctx.On("OPCommand").Return(job.StopCommand, true) ctx.On("OPCommand").Return(job.StopCommand, true)
auditManager := &mockAudit.Manager{} auditManager := &mockAudit.Manager{}
j := &Job{auditMgr: auditManager} auditExtManager := &mockauditext.Manager{}
j := &Job{auditMgr: auditManager, auditExtMgr: auditExtManager}
suite.True(j.shouldStop(ctx)) suite.True(j.shouldStop(ctx))
} }

View File

@ -199,6 +199,8 @@ func permitEventTypes(includeEventTypes []string) []string {
event := strings.ToLower(e) event := strings.ToLower(e)
if utils.StringInSlice(event, model.EventTypes) { if utils.StringInSlice(event, model.EventTypes) {
filterEvents = append(filterEvents, e) filterEvents = append(filterEvents, e)
} else if event == model.OtherEvents { // include all other events
filterEvents = append(filterEvents, model.OtherEventTypes...)
} }
} }
return filterEvents return filterEvents

View File

@ -185,4 +185,9 @@ func TestPermitEventTypes(t *testing.T) {
t.Errorf("permitEventTypes failed") t.Errorf("permitEventTypes failed")
} }
// test other event types
otherEventTypes := permitEventTypes([]string{"create_artifact", "delete_artifact", "pull_artifact", "other_events"})
if len(otherEventTypes) != len(model.EventTypes) {
t.Errorf("permitOtherEventTypes failed, it should include all event types")
}
} }

View File

@ -46,7 +46,7 @@ type Resolver struct {
SucceedCodes []int SucceedCodes []int
// SensitiveAttributes is the attributes that need to be redacted // SensitiveAttributes is the attributes that need to be redacted
SensitiveAttributes []string SensitiveAttributes []string
// HasResourceName indicates if the resource has name, if true, need to resolve the resource name before delete // ShouldResolveName indicates if the resource name should be resolved before delete, if true, need to resolve the resource name before delete
ShouldResolveName bool ShouldResolveName bool
// IDToNameFunc is used to resolve the resource name from resource id // IDToNameFunc is used to resolve the resource name from resource id
IDToNameFunc ResolveIDToNameFunc IDToNameFunc ResolveIDToNameFunc

View File

@ -20,6 +20,8 @@ import (
beego_orm "github.com/beego/beego/v2/client/orm" beego_orm "github.com/beego/beego/v2/client/orm"
) )
const OtherEvents = "other_events"
func init() { func init() {
beego_orm.RegisterModel(&AuditLogExt{}) beego_orm.RegisterModel(&AuditLogExt{})
} }
@ -43,7 +45,7 @@ func (a *AuditLogExt) TableName() string {
return "audit_log_ext" return "audit_log_ext"
} }
// EventTypes defines the types of audit log event // EventTypes defines the types of audit log event, new event types should be added at the end of the list
var EventTypes = []string{ var EventTypes = []string{
"create_artifact", "create_artifact",
"delete_artifact", "delete_artifact",
@ -60,3 +62,6 @@ var EventTypes = []string{
"delete_robot", "delete_robot",
"update_configure", "update_configure",
} }
// OtherEventTypes defines the types of other audit log event types excludes previous EventTypes: create_artifact, delete_artifact, pull_artifact
var OtherEventTypes = EventTypes[3:]

View File

@ -84,8 +84,8 @@ func verifyCreateRequest(params purge.CreatePurgeScheduleParams) error {
if _, err := retentionHour(params.Schedule.Parameters); err != nil { if _, err := retentionHour(params.Schedule.Parameters); err != nil {
return err return err
} }
if _, exist := params.Schedule.Parameters[common.PurgeAuditIncludeOperations]; !exist { if _, exist := params.Schedule.Parameters[common.PurgeAuditIncludeEventTypes]; !exist {
return errors.BadRequestError(fmt.Errorf("include_operations should provide")) return errors.BadRequestError(fmt.Errorf("include_event_types should provide"))
} }
return nil return nil
} }
@ -119,8 +119,8 @@ func (p *purgeAPI) kick(ctx context.Context, vendorType string, scheType string,
if dryRun, ok := parameters[common.PurgeAuditDryRun].(bool); ok { if dryRun, ok := parameters[common.PurgeAuditDryRun].(bool); ok {
policy.DryRun = dryRun policy.DryRun = dryRun
} }
if includeOperations, ok := parameters[common.PurgeAuditIncludeOperations].(string); ok { if includeEventTypes, ok := parameters[common.PurgeAuditIncludeEventTypes].(string); ok {
policy.IncludeOperations = includeOperations policy.IncludeEventTypes = includeEventTypes
} }
retHour, err := retentionHour(parameters) retHour, err := retentionHour(parameters)
if err != nil { if err != nil {
@ -312,8 +312,8 @@ func verifyUpdateRequest(params purge.UpdatePurgeScheduleParams) error {
if _, err := retentionHour(params.Schedule.Parameters); err != nil { if _, err := retentionHour(params.Schedule.Parameters); err != nil {
return err return err
} }
if _, exist := params.Schedule.Parameters[common.PurgeAuditIncludeOperations]; !exist { if _, exist := params.Schedule.Parameters[common.PurgeAuditIncludeEventTypes]; !exist {
return errors.BadRequestError(fmt.Errorf("include_operations should provide")) return errors.BadRequestError(fmt.Errorf("include_event_types should provide"))
} }
return nil return nil
} }

View File

@ -18,10 +18,11 @@ import (
"fmt" "fmt"
"testing" "testing"
"github.com/stretchr/testify/assert"
"github.com/goharbor/harbor/src/common" "github.com/goharbor/harbor/src/common"
"github.com/goharbor/harbor/src/server/v2.0/models" "github.com/goharbor/harbor/src/server/v2.0/models"
"github.com/goharbor/harbor/src/server/v2.0/restapi/operations/purge" "github.com/goharbor/harbor/src/server/v2.0/restapi/operations/purge"
"github.com/stretchr/testify/assert"
) )
func Test_verifyUpdateRequest(t *testing.T) { func Test_verifyUpdateRequest(t *testing.T) {
@ -33,9 +34,9 @@ func Test_verifyUpdateRequest(t *testing.T) {
args args args args
wantErr bool wantErr bool
}{ }{
{"normal", args{purge.UpdatePurgeScheduleParams{Schedule: &models.Schedule{Schedule: &models.ScheduleObj{}, Parameters: map[string]interface{}{common.PurgeAuditRetentionHour: "168", common.PurgeAuditIncludeOperations: "pull"}}}}, false}, {"normal", args{purge.UpdatePurgeScheduleParams{Schedule: &models.Schedule{Schedule: &models.ScheduleObj{}, Parameters: map[string]interface{}{common.PurgeAuditRetentionHour: "168", common.PurgeAuditIncludeEventTypes: "pull_artifact"}}}}, false},
{"missing_schedule", args{purge.UpdatePurgeScheduleParams{Schedule: &models.Schedule{Parameters: map[string]interface{}{common.PurgeAuditRetentionHour: "168", common.PurgeAuditIncludeOperations: "pull"}}}}, true}, {"missing_schedule", args{purge.UpdatePurgeScheduleParams{Schedule: &models.Schedule{Parameters: map[string]interface{}{common.PurgeAuditRetentionHour: "168", common.PurgeAuditIncludeEventTypes: "pull_artifact"}}}}, true},
{"missing_retention_hour", args{purge.UpdatePurgeScheduleParams{Schedule: &models.Schedule{Schedule: &models.ScheduleObj{}, Parameters: map[string]interface{}{common.PurgeAuditIncludeOperations: "pull"}}}}, true}, {"missing_retention_hour", args{purge.UpdatePurgeScheduleParams{Schedule: &models.Schedule{Schedule: &models.ScheduleObj{}, Parameters: map[string]interface{}{common.PurgeAuditIncludeEventTypes: "pull_artifact"}}}}, true},
{"missing_operations", args{purge.UpdatePurgeScheduleParams{Schedule: &models.Schedule{Schedule: &models.ScheduleObj{}, Parameters: map[string]interface{}{common.PurgeAuditRetentionHour: "168"}}}}, true}, {"missing_operations", args{purge.UpdatePurgeScheduleParams{Schedule: &models.Schedule{Schedule: &models.ScheduleObj{}, Parameters: map[string]interface{}{common.PurgeAuditRetentionHour: "168"}}}}, true},
} }
for _, tt := range tests { for _, tt := range tests {
@ -56,10 +57,10 @@ func Test_verifyCreateRequest(t *testing.T) {
args args args args
wantErr bool wantErr bool
}{ }{
{"normal", args{purge.CreatePurgeScheduleParams{Schedule: &models.Schedule{Schedule: &models.ScheduleObj{}, Parameters: map[string]interface{}{common.PurgeAuditRetentionHour: "168", common.PurgeAuditIncludeOperations: "pull"}}}}, false}, {"normal", args{purge.CreatePurgeScheduleParams{Schedule: &models.Schedule{Schedule: &models.ScheduleObj{}, Parameters: map[string]interface{}{common.PurgeAuditRetentionHour: "168", common.PurgeAuditIncludeEventTypes: "pull_artifact"}}}}, false},
{"missing_schedule", args{purge.CreatePurgeScheduleParams{Schedule: &models.Schedule{Parameters: map[string]interface{}{common.PurgeAuditRetentionHour: "168", common.PurgeAuditIncludeOperations: "pull"}}}}, true}, {"missing_schedule", args{purge.CreatePurgeScheduleParams{Schedule: &models.Schedule{Parameters: map[string]interface{}{common.PurgeAuditRetentionHour: "168", common.PurgeAuditIncludeEventTypes: "pull_artifact"}}}}, true},
{"missing_retention_hour", args{purge.CreatePurgeScheduleParams{Schedule: &models.Schedule{Schedule: &models.ScheduleObj{}, Parameters: map[string]interface{}{common.PurgeAuditIncludeOperations: "pull"}}}}, true}, {"missing_retention_hour", args{purge.CreatePurgeScheduleParams{Schedule: &models.Schedule{Schedule: &models.ScheduleObj{}, Parameters: map[string]interface{}{common.PurgeAuditIncludeEventTypes: "pull_artifact"}}}}, true},
{"missing_operations", args{purge.CreatePurgeScheduleParams{Schedule: &models.Schedule{Schedule: &models.ScheduleObj{}, Parameters: map[string]interface{}{common.PurgeAuditRetentionHour: "168"}}}}, true}, {"missing_event_types", args{purge.CreatePurgeScheduleParams{Schedule: &models.Schedule{Schedule: &models.ScheduleObj{}, Parameters: map[string]interface{}{common.PurgeAuditRetentionHour: "168"}}}}, true},
} }
for _, tt := range tests { for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) { t.Run(tt.name, func(t *testing.T) {

View File

@ -10,13 +10,13 @@ class Purge(base.Base):
def __init__(self): def __init__(self):
super(Purge, self).__init__(api_type="purge") super(Purge, self).__init__(api_type="purge")
def create_purge_schedule(self, type, cron, dry_run=True, audit_retention_hour=24, include_operations="create,delete,pull", expect_status_code=201, expect_response_body=None, **kwargs): def create_purge_schedule(self, type, cron, dry_run=True, audit_retention_hour=24, include_event_types="create_artifact,delete_artifact,pull_artifact", expect_status_code=201, expect_response_body=None, **kwargs):
scheduleObj = v2_swagger_client.ScheduleObj(type=type) scheduleObj = v2_swagger_client.ScheduleObj(type=type)
if cron is not None: if cron is not None:
scheduleObj.cron = cron scheduleObj.cron = cron
parameters = { parameters = {
"audit_retention_hour": audit_retention_hour, "audit_retention_hour": audit_retention_hour,
"include_operations": include_operations, "include_event_types": include_event_types,
"dry_run": dry_run "dry_run": dry_run
} }
schedule = v2_swagger_client.Schedule(schedule=scheduleObj, parameters=parameters) schedule = v2_swagger_client.Schedule(schedule=scheduleObj, parameters=parameters)
@ -30,11 +30,11 @@ class Purge(base.Base):
return return
base._assert_status_code(expect_status_code, status_code) base._assert_status_code(expect_status_code, status_code)
def update_purge_schedule(self, type, cron, audit_retention_hour=24, include_operations="create,delete,pull", expect_status_code=200, expect_response_body=None, **kwargs): def update_purge_schedule(self, type, cron, audit_retention_hour=24, include_event_types="create_artifact,delete_artifact,pull_artifact", expect_status_code=200, expect_response_body=None, **kwargs):
scheduleObj = v2_swagger_client.ScheduleObj(type=type, cron=cron) scheduleObj = v2_swagger_client.ScheduleObj(type=type, cron=cron)
parameters = { parameters = {
"audit_retention_hour": audit_retention_hour, "audit_retention_hour": audit_retention_hour,
"include_operations": include_operations, "include_event_types": include_event_types,
"dry_run": False "dry_run": False
} }
schedule = v2_swagger_client.Schedule(schedule=scheduleObj, parameters=parameters) schedule = v2_swagger_client.Schedule(schedule=scheduleObj, parameters=parameters)

View File

@ -73,18 +73,18 @@ class TestLogRotation(unittest.TestCase, object):
schedule_type = "Weekly" schedule_type = "Weekly"
schedule_cron = "0 0 0 * * 0" schedule_cron = "0 0 0 * * 0"
audit_retention_hour = 24 audit_retention_hour = 24
include_operations = "create,delete,pull" include_event_types = "create_artifact,delete_artifact,pull_artifact"
self.purge.create_purge_schedule(type=schedule_type, cron=schedule_cron, dry_run=False, audit_retention_hour=audit_retention_hour, include_operations=include_operations) self.purge.create_purge_schedule(type=schedule_type, cron=schedule_cron, dry_run=False, audit_retention_hour=audit_retention_hour, include_event_types=include_event_types)
# 8. Verify schedule # 8. Verify schedule
self.verifySchedule(schedule_type, schedule_cron, audit_retention_hour, include_operations) self.verifySchedule(schedule_type, schedule_cron, audit_retention_hour, include_event_types)
# 9. Update schedule # 9. Update schedule
schedule_type = "Custom" schedule_type = "Custom"
schedule_cron = "0 15 10 ? * *" schedule_cron = "0 15 10 ? * *"
audit_retention_hour = 12 audit_retention_hour = 12
include_operations = "create,delete" include_event_types = "create_artifact,delete_artifact"
self.purge.update_purge_schedule(type=schedule_type, cron=schedule_cron, audit_retention_hour=audit_retention_hour, include_operations=include_operations) self.purge.update_purge_schedule(type=schedule_type, cron=schedule_cron, audit_retention_hour=audit_retention_hour, include_event_types=include_event_types)
# 10. Verify schedule # 10. Verify schedule
self.verifySchedule(schedule_type, schedule_cron, audit_retention_hour, include_operations) self.verifySchedule(schedule_type, schedule_cron, audit_retention_hour, include_event_types)
def testLogRotationAPIPermission(self): def testLogRotationAPIPermission(self):
""" """
@ -125,13 +125,13 @@ class TestLogRotation(unittest.TestCase, object):
# 9. User(UA) should not have permission to update purge schedule API # 9. User(UA) should not have permission to update purge schedule API
self.purge.update_purge_schedule(type="Custom", cron="0 15 10 ? * *", expect_status_code=expect_status_code, expect_response_body=expect_response_body, **USER_CLIENT) self.purge.update_purge_schedule(type="Custom", cron="0 15 10 ? * *", expect_status_code=expect_status_code, expect_response_body=expect_response_body, **USER_CLIENT)
def verifySchedule(self, schedule_type, schedule_cron, audit_retention_hour, include_operations): def verifySchedule(self, schedule_type, schedule_cron, audit_retention_hour, include_event_types):
purge_schedule = self.purge.get_purge_schedule() purge_schedule = self.purge.get_purge_schedule()
job_parameters = json.loads(purge_schedule.job_parameters) job_parameters = json.loads(purge_schedule.job_parameters)
self.assertEqual(purge_schedule.schedule.type, schedule_type) self.assertEqual(purge_schedule.schedule.type, schedule_type)
self.assertEqual(purge_schedule.schedule.cron, schedule_cron) self.assertEqual(purge_schedule.schedule.cron, schedule_cron)
self.assertEqual(job_parameters["audit_retention_hour"], audit_retention_hour) self.assertEqual(job_parameters["audit_retention_hour"], audit_retention_hour)
self.assertEqual(job_parameters["include_operations"], include_operations) self.assertEqual(job_parameters["include_event_types"], include_event_types)
if __name__ == '__main__': if __name__ == '__main__':
unittest.main() unittest.main()

View File

@ -318,7 +318,7 @@ update_gc_schedule = Permission("{}/system/gc/schedule".format(harbor_base_url),
purge_audit_payload = { purge_audit_payload = {
"parameters": { "parameters": {
"audit_retention_hour": 24, "audit_retention_hour": 24,
"include_operations": "create,delete,pull", "include_event_types": "create_artifact,delete_artifact,pull_artifact",
"dry_run": True "dry_run": True
}, },
"schedule": { "schedule": {

View File

@ -247,7 +247,7 @@ Test Case - Log Rotation Schedule Job
Should Be Equal As Strings ${log["job_status"]} Success Should Be Equal As Strings ${log["job_status"]} Success
Should Be Equal As Strings ${log["job_parameters"]["audit_retention_hour"]} 48 Should Be Equal As Strings ${log["job_parameters"]["audit_retention_hour"]} 48
Should Be Equal As Strings ${log["job_parameters"]["dry_run"]} False Should Be Equal As Strings ${log["job_parameters"]["dry_run"]} False
Should Not Contain Any ${log["job_parameters"]["include_operations"]} @{exclude_operations} ignore_case=True Should Not Contain Any ${log["job_parameters"]["include_event_types"]} @{exclude_operations} ignore_case=True
END END
Should Be True ${len} > 3 and ${len} < 6 Should Be True ${len} > 3 and ${len} < 6
Close Browser Close Browser