Skip to content

Add JSON patch to remove SLO assets for spec versions less than 3.4.0 #884

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.

Sign up for GitHub

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

Merged
mrodm merged 14 commits into from
Mar 24, 2025
Merged

Add JSON patch to remove SLO assets for spec versions less than 3.4.0 #884

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
d7b0288
Add JSON patch to remove slo folder in content packages
mrodm Mar 21, 2025
b225c40
Add slo assets into good_content test package
mrodm Mar 21, 2025
b01367e
Add changelog entry
mrodm Mar 21, 2025
3161ea5
Remove security capability
mrodm Mar 21, 2025
72fa169
Run kibana validation rules in content packages too
mrodm Mar 21, 2025
dd33139
Add another changelog entry
mrodm Mar 21, 2025
6250bd1
Add basic content package for compliance tests
mrodm Mar 21, 2025
c8d3ffc
Add missing attribute in dashboard
mrodm Mar 21, 2025
833b6d8
Include compliance test for 3.4.0 with current latest snapshot
mrodm Mar 21, 2025
432bfa3
Set spec version 3.3.0 for basic_content
mrodm Mar 21, 2025
d03827b
Set 3.3.1 spec version for basic_content
mrodm Mar 21, 2025
335b842
Add new compliance checks for SLO and dashboards
mrodm Mar 24, 2025
68f0ca3
Refactor kibana functions
mrodm Mar 24, 2025
5b59414
Remove compliance test for 9.1.0-SNAPSHOT and spec 3.4.0
mrodm Mar 24, 2025
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
8 changes: 4 additions & 4 deletions code/go/internal/validator/spec.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,15 +202,15 @@ func (s Spec) rules(pkgType string, rootSpec spectypes.ItemSpec) validationRules
{fn: semantic.ValidateDateFields, types: []string{"integration", "input"}},
{fn: semantic.ValidateRequiredFields, types: []string{"integration", "input"}},
{fn: semantic.ValidateExternalFieldsWithDevFolder, types: []string{"integration", "input"}},
{fn: semantic.WarnOn(semantic.ValidateVisualizationsUsedByValue), types: []string{"integration"}, until: semver.MustParse("3.0.0")},
{fn: semantic.ValidateVisualizationsUsedByValue, types: []string{"integration"}, since: semver.MustParse("3.0.0")},
{fn: semantic.WarnOn(semantic.ValidateVisualizationsUsedByValue), types: []string{"integration", "content"}, until: semver.MustParse("3.0.0")},
{fn: semantic.ValidateVisualizationsUsedByValue, types: []string{"integration", "content"}, since: semver.MustParse("3.0.0")},
{fn: semantic.ValidateILMPolicyPresent, since: semver.MustParse("2.0.0"), types: []string{"integration"}},
{fn: semantic.ValidateProfilingNonGA, types: []string{"integration"}},
{fn: semantic.ValidateKibanaObjectIDs, types: []string{"integration"}},
{fn: semantic.ValidateKibanaObjectIDs, types: []string{"integration", "content"}},
{fn: semantic.ValidateRoutingRulesAndDataset, types: []string{"integration"}, since: semver.MustParse("2.9.0")},
{fn: semantic.ValidateKibanaNoDanglingObjectIDs, since: semver.MustParse("3.0.0")},
{fn: semantic.ValidateKibanaFilterPresent, since: semver.MustParse("3.0.0")},
{fn: semantic.ValidateKibanaNoLegacyVisualizations, types: []string{"integration"}, since: semver.MustParse("3.0.0")},
{fn: semantic.ValidateKibanaNoLegacyVisualizations, types: []string{"integration", "content"}, since: semver.MustParse("3.0.0")},

@jsoriano jsoriano Mar 21, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should these changes be mentioned in the changelog too?

@mrodm mrodm Mar 21, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a new changelog entry for these changes in dd33139

{fn: semantic.ValidateDimensionsPresent, types: []string{"integration"}, since: semver.MustParse("3.0.1")},
{fn: semantic.ValidateCapabilitiesRequired, since: semver.MustParse("2.10.0")}, // capabilities definition was added in spec version 2.10.0
{fn: semantic.ValidateRequiredVarGroups},
Expand Down
5 changes: 5 additions & 0 deletions spec/changelog.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@
- description: Add support for semantic_text field definition.
type: enhancement
link: https://github.com/elastic/package-spec/pull/807
- version: 3.3.4-next
changes:
- description: Remove slo assets when spec versions are less than 3.4.0.
type: bugfix
link: https://github.com/elastic/package-spec/pull/884
- version: 3.3.3
changes:
- description: Introduce siem category.
Expand Down
5 changes: 5 additions & 0 deletions spec/content/kibana/spec.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,8 @@ spec:
pattern: '^{PACKAGE_NAME}-.+\.json$'
forbiddenPatterns:
- '^.+-(ecs|ECS)\.json$' # ECS suffix is forbidden
versions:
- before: 3.4.0
patch:
- op: remove
path: "/contents/2" # remove SLO definitions
29 changes: 29 additions & 0 deletions test/packages/good_content/kibana/slo/good_content-slo-abc-1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"attributes": {
"name": "Admin Console Availability",
"description": "",
"indicator": {
"type": "sli.kql.custom",
"params": {
"index": "kbn-data-forge-fake_stack.admin-console-*",
"filter": "",
"good": "http.response.status_code < 500",
"total": "http.response.status_code : *",
"timestampField": "@timestamp"
}
},
"budgetingMethod": "occurrences",
"timeWindow": {
"duration": "7d",
"type": "rolling"
},
"objective": {
"target": 0.99
},
"tags": [],
"groupBy": "url.domain"
},
"id": "good_content-slo-abc-1",
"references": [],
"type": "slo"
}
2 changes: 1 addition & 1 deletion test/packages/good_content/manifest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
format_version: 3.3.1
format_version: 3.4.0

@mrodm mrodm Mar 21, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should it be updated the spec version for the compliance test here ?

package-spec/compliance/features/basic.feature

Lines 16 to 19 in 4366bf7

@3.3.0
Scenario: Content package can be installed
Given the "good_content" package is installed
#Then there are no errors.

That test is running successfully even if that spec version is not updated.

@jsoriano jsoriano Mar 21, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the package has SLOs it should be updated, yes.

@mrodm mrodm Mar 21, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If that spec version is updated to be @3.4.0, I guess it should be needed to add a new compliance test for 3.4.0.

Or should it be updated the one with stack 9.1.0-SNAPSHOT to 3.4.0 ? @jsoriano

package-spec/.buildkite/pipeline.trigger.compliance.tests.sh

Line 31 in 4366bf7

compliance_test 9.1.0-SNAPSHOT 3.3.3

Would it be better to create a new content package without SLO , so it can be tested that scenario with previous spec versions 3.3.0 ?

@mrodm mrodm Mar 21, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a new basic_content test package , to be able to keep testing content packages with spec version 3.3.0 (and previous Elastic stacks). Added in 6250bd1

name: good_content
title: Good content package
description: >
Expand Down
3 changes: 3 additions & 0 deletions test/packages/good_content/validation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
errors:
exclude_checks:
- PSR00001 # Allow to use unreleased features in GA package.
Comment on lines +1 to +3

@mrodm mrodm Mar 21, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added since 3.4.0 is not released yet (-next prerelease tag)