Skip to content
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

[feature]: Support for selecting audit rule templates in static audit #501

Merged
merged 1 commit into from
Nov 15, 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
84 changes: 84 additions & 0 deletions packages/shared/lib/api/sqle/service/common.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
AuditTaskResV1AuditLevelEnum,
AuditTaskResV1SqlSourceEnum,
AuditTaskResV1StatusEnum,
BackupSqlDataBackupStrategyEnum,
BatchUpdateSqlManageReqPriorityEnum,
BatchUpdateSqlManageReqStatusEnum,
BlacklistResV1TypeEnum,
Expand Down Expand Up @@ -54,6 +55,8 @@ import {
UpdateInstanceAuditPlanStatusReqV1ActiveEnum,
UpdateReportPushConfigReqV1PushUserTypeEnum,
UpdateReportPushConfigReqV1TriggerTypeEnum,
UpdateSqlBackupStrategyReqStrategyEnum,
UpdateTaskBackupStrategyReqStrategyEnum,
UpdateWorkflowTemplateReqV1AllowSubmitWhenLessAuditLevelEnum,
WorkFlowStepTemplateReqV1TypeEnum,
WorkflowDetailResV1CurrentStepTypeEnum,
Expand All @@ -76,6 +79,7 @@ import {
updatePipelineNodeTypeEnum,
AssociatedStageWorkflowsStatusEnum,
AuditResDataV2AuditLevelEnum,
AuditTaskSQLResV2BackupStrategyEnum,
DirectAuditFileReqV2SqlTypeEnum,
DirectAuditReqV2SqlTypeEnum,
GetWorkflowTasksItemV2StatusEnum,
Expand Down Expand Up @@ -348,6 +352,10 @@ export interface IAuditTaskResV1 {

audit_level?: AuditTaskResV1AuditLevelEnum;

backup_conflict_with_instance?: boolean;

enable_backup?: boolean;

exec_end_time?: string;

exec_mode?: string;
Expand Down Expand Up @@ -421,6 +429,36 @@ export interface IAuditedSQLCount {
total_sql_count?: number;
}

export interface IBackupSqlData {
backup_sqls?: string[];

backup_strategy?: BackupSqlDataBackupStrategyEnum;

description?: string;

exec_order?: number;

exec_sql_id?: number;

exec_status?: string;

instance_id?: string;

instance_name?: string;

origin_sql?: string;
}

export interface IBackupSqlListRes {
code?: number;

data?: IBackupSqlData[];

message?: string;

total_nums?: number;
}

export interface IBatchAssociateWorkflowsWithVersionReqV1 {
workflow_ids?: string[];
}
Expand Down Expand Up @@ -536,6 +574,8 @@ export interface ICreateAuditPlanReqV1 {
}

export interface ICreateAuditTaskReqV1 {
enable_backup?: boolean;

exec_mode?: CreateAuditTaskReqV1ExecModeEnum;

file_order_method?: string;
Expand Down Expand Up @@ -627,6 +667,30 @@ export interface ICreateProjectRuleTemplateReqV1 {
rule_template_name?: string;
}

export interface ICreateRollbackWorkflowReq {
desc?: string;

rollback_sql_ids?: number[];

sql_version_id?: number;

task_ids?: number[];

workflow_subject?: string;
}

export interface ICreateRollbackWorkflowRes {
code?: number;

data?: ICreateRollbackWorkflowResData;

message?: string;
}

export interface ICreateRollbackWorkflowResData {
workflow_id?: string;
}

export interface ICreateRuleTemplateReqV1 {
db_type?: string;

Expand Down Expand Up @@ -2486,6 +2550,8 @@ export interface IRuleTemplateResV1 {

desc?: string;

is_default_rule_template?: boolean;

rule_template_name?: string;
}

Expand All @@ -2494,6 +2560,8 @@ export interface IRuleTemplateTipResV1 {

rule_template_id?: string;

is_default_rule_template?: boolean;

rule_template_name?: string;
}

Expand Down Expand Up @@ -3055,6 +3123,10 @@ export interface IUpdateSQLAuditRecordReqV1 {
tags?: string[];
}

export interface IUpdateSqlBackupStrategyReq {
strategy?: UpdateSqlBackupStrategyReqStrategyEnum;
}

export interface IUpdateSqlFileOrderV1Req {
files_to_sort?: IFileToSort[];
}
Expand Down Expand Up @@ -3089,6 +3161,10 @@ export interface IUpdateSystemVariablesReqV1 {
url?: string;
}

export interface IUpdateTaskBackupStrategyReq {
strategy?: UpdateTaskBackupStrategyReqStrategyEnum;
}

export interface IUpdateWechatConfigurationReqV1 {
corp_id?: string;

Expand Down Expand Up @@ -3568,18 +3644,26 @@ export interface IAuditSQLResV2 {
}

export interface IAuditTaskSQLResV2 {
associate_workflow_ids?: string[];

audit_level?: string;

audit_result?: IAuditResult[];

audit_status?: string;

backup_strategy?: AuditTaskSQLResV2BackupStrategyEnum;

backup_strategy_tip?: string;

description?: string;

exec_result?: string;

exec_sql?: string;

exec_sql_id?: number;

exec_status?: string;

number?: number;
Expand Down
40 changes: 40 additions & 0 deletions packages/shared/lib/api/sqle/service/common.enum.ts
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,16 @@ export enum AuditTaskResV1StatusEnum {
'manually_executed' = 'manually_executed'
}

export enum BackupSqlDataBackupStrategyEnum {
'none' = 'none',

'manual' = 'manual',

'reverse_sql' = 'reverse_sql',

'origin_row' = 'origin_row'
}

export enum BatchUpdateSqlManageReqPriorityEnum {
'UNKNOWN' = '',

Expand Down Expand Up @@ -482,6 +492,26 @@ export enum UpdateReportPushConfigReqV1TriggerTypeEnum {
'timing' = 'timing'
}

export enum UpdateSqlBackupStrategyReqStrategyEnum {
'none' = 'none',

'manual' = 'manual',

'reverse_sql' = 'reverse_sql',

'origin_row' = 'origin_row'
}

export enum UpdateTaskBackupStrategyReqStrategyEnum {
'none' = 'none',

'manual' = 'manual',

'reverse_sql' = 'reverse_sql',

'origin_row' = 'origin_row'
}

export enum UpdateWorkflowTemplateReqV1AllowSubmitWhenLessAuditLevelEnum {
'normal' = 'normal',

Expand Down Expand Up @@ -676,6 +706,16 @@ export enum AuditResDataV2AuditLevelEnum {
'UNKNOWN' = ''
}

export enum AuditTaskSQLResV2BackupStrategyEnum {
'none' = 'none',

'manual' = 'manual',

'reverse_sql' = 'reverse_sql',

'origin_row' = 'origin_row'
}

export enum DirectAuditFileReqV2SqlTypeEnum {
'sql' = 'sql',

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ export interface ICreateSQLAuditRecordV1Params {

instance_schema?: string;

rule_template_name?: string;

db_type?: string;

sqls?: string;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,10 @@ class SqlAuditRecordService extends ServiceBase {
paramsData.append('instance_schema', params.instance_schema as any);
}

if (params.rule_template_name != undefined) {
paramsData.append('rule_template_name', params.rule_template_name as any);
}

if (params.db_type != undefined) {
paramsData.append('db_type', params.db_type as any);
}
Expand Down
20 changes: 20 additions & 0 deletions packages/shared/lib/api/sqle/service/task/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
IUpdateSqlFileOrderV1Req,
IGetSqlFileOrderMethodResV1,
IAuditTaskGroupResV1,
IUpdateTaskBackupStrategyReq,
IBaseRes,
IGetAuditTaskSQLContentResV1,
IGetAuditTaskSQLsResV1,
Expand Down Expand Up @@ -40,6 +41,8 @@ export interface ICreateAndAuditTaskV1Params extends ICreateAuditTaskReqV1 {

instance_schema?: string;

enable_backup?: boolean;

sql?: string;

input_sql_file?: any;
Expand All @@ -55,6 +58,14 @@ export interface ICreateAndAuditTaskV1Params extends ICreateAuditTaskReqV1 {

export interface ICreateAndAuditTaskV1Return extends IGetAuditTaskResV1 {}

export interface IDownloadBackupFileV1Params {
workflow_id: string;

project_name: string;

task_id: string;
}

export interface IUpdateSqlFileOrderV1Params extends IUpdateSqlFileOrderV1Req {
project_name: string;

Expand All @@ -71,6 +82,8 @@ export interface IAuditTaskGroupIdV1Params {

sql?: string;

enable_backup?: boolean;

file_order_method?: string;

input_sql_file?: any;
Expand All @@ -88,6 +101,13 @@ export interface IGetAuditTaskV1Params {

export interface IGetAuditTaskV1Return extends IGetAuditTaskResV1 {}

export interface IUpdateTaskBackupStrategyV1Params
extends IUpdateTaskBackupStrategyReq {
task_id: string;
}

export interface IUpdateTaskBackupStrategyV1Return extends IBaseRes {}

export interface IDownloadAuditFileParams {
task_id: string;
}
Expand Down
Loading
Loading