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

[Security Solution] Adds unit tests for simple diff algorithm #184483

Merged
merged 2 commits into from
May 31, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/

import type { ThreeVersionsOf } from '../../../../../../../../common/api/detection_engine';
import {
ThreeWayDiffOutcome,
ThreeWayMergeOutcome,
MissingVersion,
} from '../../../../../../../../common/api/detection_engine';
import { simpleDiffAlgorithm } from './simple_diff_algorithm';

const mockStringFieldVersions: ThreeVersionsOf<string> = {
base_version: 'rule name',
current_version: 'rule name',
target_version: 'rule name',
};

describe('simpleDiffAlgorithm', () => {
// AAA
it('returns current_version as merged output if there is no update', () => {
const result = simpleDiffAlgorithm(mockStringFieldVersions);

expect(result).toEqual(
expect.objectContaining({
merged_version: mockStringFieldVersions.current_version,
diff_outcome: ThreeWayDiffOutcome.StockValueNoUpdate,
merge_outcome: ThreeWayMergeOutcome.Current,
has_conflict: false,
})
);
});

// ABA
it('returns current_version as merged output if current_version is different and there is no update', () => {
const newMockStringFieldVersions: ThreeVersionsOf<string> = {
...mockStringFieldVersions,
current_version: 'custom rule name',
};
const result = simpleDiffAlgorithm(newMockStringFieldVersions);

expect(result).toEqual(
expect.objectContaining({
merged_version: newMockStringFieldVersions.current_version,
diff_outcome: ThreeWayDiffOutcome.CustomizedValueNoUpdate,
merge_outcome: ThreeWayMergeOutcome.Current,
has_conflict: false,
})
);
});

// AAB
it('returns target_version as merged output if current_version is the same and there is an update', () => {
const newMockStringFieldVersions: ThreeVersionsOf<string> = {
...mockStringFieldVersions,
target_version: 'updated rule name',
};
const result = simpleDiffAlgorithm(newMockStringFieldVersions);

expect(result).toEqual(
expect.objectContaining({
merged_version: newMockStringFieldVersions.target_version,
diff_outcome: ThreeWayDiffOutcome.StockValueCanUpdate,
merge_outcome: ThreeWayMergeOutcome.Target,
has_conflict: false,
})
);
});

// ABB
it('returns current_version as merged output if current version is different but it matches the update', () => {
const newMockStringFieldVersions: ThreeVersionsOf<string> = {
...mockStringFieldVersions,
current_version: 'updated rule name',
target_version: 'updated rule name',
};
const result = simpleDiffAlgorithm(newMockStringFieldVersions);

expect(result).toEqual(
expect.objectContaining({
merged_version: newMockStringFieldVersions.current_version,
diff_outcome: ThreeWayDiffOutcome.CustomizedValueSameUpdate,
merge_outcome: ThreeWayMergeOutcome.Current,
has_conflict: false,
})
);
});

// ABC
it('returns current_version as merged output if all three versions are different', () => {
const newMockStringFieldVersions: ThreeVersionsOf<string> = {
base_version: 'rule name',
current_version: 'custom rule name',
target_version: 'updated rule name',
};
const result = simpleDiffAlgorithm(newMockStringFieldVersions);

expect(result).toEqual(
expect.objectContaining({
merged_version: newMockStringFieldVersions.current_version,
diff_outcome: ThreeWayDiffOutcome.CustomizedValueCanUpdate,
merge_outcome: ThreeWayMergeOutcome.Conflict,
has_conflict: true,
})
);
});

describe('if base_version is missing', () => {
it('returns current_version as merged output if current_version and target_version are the same', () => {
const newMockFieldVersions: ThreeVersionsOf<string> = {
...mockStringFieldVersions,
base_version: MissingVersion,
};

const result = simpleDiffAlgorithm(newMockFieldVersions);

expect(result).toEqual(
expect.objectContaining({
merged_version: newMockFieldVersions.current_version,
diff_outcome: ThreeWayDiffOutcome.StockValueNoUpdate,
merge_outcome: ThreeWayMergeOutcome.Current,
has_conflict: false,
})
);
});

it('returns target_version as merged output if current_version and target_version are different', () => {
const newMockFieldVersions: ThreeVersionsOf<string> = {
...mockStringFieldVersions,
base_version: MissingVersion,
target_version: 'updated rule name',
};

const result = simpleDiffAlgorithm(newMockFieldVersions);

expect(result).toEqual(
expect.objectContaining({
merged_version: newMockFieldVersions.target_version,
diff_outcome: ThreeWayDiffOutcome.StockValueCanUpdate,
merge_outcome: ThreeWayMergeOutcome.Target,
has_conflict: false,
})
);
});
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ const mergeVersions = <TValue>({
case ThreeWayDiffOutcome.CustomizedValueCanUpdate: {
return {
mergeOutcome: ThreeWayMergeOutcome.Conflict,
mergedVersion: targetVersion,
mergedVersion: currentVersion,
};
}
default:
Expand Down