Add new policy_api_format setting in system tests to force the use of an specific policy API format

code/go/pkg/validator/validator_test.go

@@ -155,6 +155,12 @@ func TestValidateFile(t *testing.T) {
 				"field streams.0.vars.3: Must not be present",
 			},
 		},
+		"bad_policy_api_format": {
+			"data_stream/foo/_dev/test/system/test-default-config.yml",
+			[]string{
+				"field policy_api_format: policy_api_format must be one of the following: \"legacy\", \"simplified\"",
+			},
+		},
 		"bad_skip_ignored_fields": {
 			"data_stream/foo/_dev/test/system/test-default-config.yml",
 			[]string{

spec/changelog.yml

@@ -55,6 +55,9 @@
     - description: Add support for migrating input types at integrations policy templates and data streams.
       type: enhancement
       link: https://github.com/elastic/package-spec/pull/1021
+    - description: Allow to force the format used in the policy API in system and policy tests.
+      type: enhancement
+      link: https://github.com/elastic/package-spec/pull/1103
 - version: 3.5.7
   changes:
     - description: Allow _dev directory for content-only packages; use _dev/shared for development files (e.g. dashboard YML sources).

spec/integration/data_stream/_dev/test/config.spec.yml

@@ -44,6 +44,18 @@ spec:
               type: string
           required:
             - source
+    policy_api_format:
+      description: |-
+        Tests can create policies using the Fleet APIs with different formats. The "legacy" format requires to
+        send variables with hints about their type, and defaults are not managed automatically.
+        The newer, "simplified" format has better format support for variables and don't allow to include hints,
+        it also uses defaults automatically, and requires explicit enablement or disablement of inputs and streams.
+        In most cases tests should not set this value. The main use case is to set it to "legacy" for cases that
+        cannot be fully supported with the newer "simplified" format.
+      type: string
+      enum:
+        - legacy
+        - simplified
     vars:
       description: Variables defined for the test case.
       type:

spec/integration/data_stream/_dev/test/policy/config.spec.yml

@@ -29,3 +29,5 @@ spec:
       type: array
       items:
         $ref: "./../config.spec.yml#/definitions/package_requirement"
+    policy_api_format:
+      $ref: "./../config.spec.yml#/definitions/policy_api_format"

spec/integration/data_stream/_dev/test/system/config.spec.yml

@@ -167,6 +167,8 @@ spec:
         vars:
           description: Variables used to configure settings defined in the data stream manifest.
           $ref: "./../config.spec.yml#/definitions/vars"
+    policy_api_format:
+      $ref: "./../config.spec.yml#/definitions/policy_api_format"
     requires:
       description: Package dependencies required for this test with exact versions.
       type: array

test/packages/bad_policy_api_format/LICENSE.txt

@@ -0,0 +1,93 @@
+Elastic License 2.0
+
+URL: https://www.elastic.co/licensing/elastic-license
+
+## Acceptance
+
+By using the software, you agree to all of the terms and conditions below.
+
+## Copyright License
+
+The licensor grants you a non-exclusive, royalty-free, worldwide,
+non-sublicensable, non-transferable license to use, copy, distribute, make
+available, and prepare derivative works of the software, in each case subject to
+the limitations and conditions below.
+
+## Limitations
+
+You may not provide the software to third parties as a hosted or managed
+service, where the service provides users with access to any substantial set of
+the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality
+in the software, and you may not remove or obscure any functionality in the
+software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices
+of the licensor in the software. Any use of the licensor’s trademarks is subject
+to applicable law.
+
+## Patents
+
+The licensor grants you a license, under any patent claims the licensor can
+license, or becomes able to license, to make, have made, use, sell, offer for
+sale, import and have imported the software, in each case subject to the
+limitations and conditions in this license. This license does not cover any
+patent claims that you cause to be infringed by modifications or additions to
+the software. If you or your company make any written claim that the software
+infringes or contributes to infringement of any patent, your patent license for
+the software granted under these terms ends immediately. If your company makes
+such a claim, your patent license ends immediately for work on behalf of your
+company.
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you
+also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the
+software prominent notices stating that you have modified the software.
+
+## No Other Rights
+
+These terms do not imply any licenses other than those expressly granted in
+these terms.
+
+## Termination
+
+If you use the software in violation of these terms, such use is not licensed,
+and your licenses will automatically terminate. If the licensor provides you
+with a notice of your violation, and you cease all violation of this license no
+later than 30 days after you receive that notice, your licenses will be
+reinstated retroactively. However, if you violate these terms after such
+reinstatement, any additional violation of these terms will cause your licenses
+to terminate automatically and permanently.
+
+## No Liability
+
+*As far as the law allows, the software comes as is, without any warranty or
+condition, and the licensor will not be liable to you for any damages arising
+out of these terms or the use or nature of the software, under any kind of
+legal claim.*
+
+## Definitions
+
+The **licensor** is the entity offering these terms, and the **software** is the
+software the licensor makes available under these terms, including any portion
+of it.
+
+**you** refers to the individual or entity agreeing to these terms.
+
+**your company** is any legal entity, sole proprietorship, or other kind of
+organization that you work for, plus all organizations that have control over,
+are under the control of, or are under common control with that
+organization. **control** means ownership of substantially all the assets of an
+entity, or the power to direct its management and policies by vote, contract, or
+otherwise. Control can be direct or indirect.
+
+**your licenses** are all the licenses granted to you for the software under
+these terms.
+
+**use** means anything you do with the software requiring one of your licenses.
+
+**trademark** means trademarks, service marks, and similar rights.

test/packages/bad_policy_api_format/changelog.yml

@@ -0,0 +1,6 @@
+# newer versions go on top
+- version: "0.0.1"
+  changes:
+    - description: Initial draft of the package
+      type: enhancement
+      link: https://github.com/elastic/integrations/pull/1 # FIXME Replace with the real PR link

test/packages/bad_policy_api_format/data_stream/foo/_dev/test/system/test-default-config.yml

@@ -0,0 +1,3 @@
+wait_for_data_timeout: 10m
+vars: ~
+policy_api_format: unexpected

test/packages/bad_policy_api_format/data_stream/foo/agent/stream/stream.yml.hbs

@@ -0,0 +1,7 @@
+paths:
+{{#each paths as |path i|}}
+  - {{path}}
+{{/each}}
+exclude_files: [".gz$"]
+processors:
+  - add_locale: ~

test/packages/bad_policy_api_format/data_stream/foo/elasticsearch/ingest_pipeline/default.yml

@@ -0,0 +1,18 @@
+---
+description: Pipeline for processing sample logs
+processors:
+- set:
+    tag: set_sample_field
+    field: sample_field
+    value: "1"
+on_failure:
+- set:
+    field: event.kind
+    value: pipeline_error
+- set:
+    field: error.message
+    value: >-
+      Processor '{{{ _ingest.on_failure_processor_type }}}'
+      with tag '{{{ _ingest.on_failure_processor_tag }}}'
+      in pipeline '{{{ _ingest.pipeline }}}'
+      failed with message '{{{ _ingest.on_failure_message }}}'

test/packages/bad_policy_api_format/data_stream/foo/fields/base-fields.yml

@@ -0,0 +1,12 @@
+- name: data_stream.type
+  type: constant_keyword
+  description: Data stream type.
+- name: data_stream.dataset
+  type: constant_keyword
+  description: Data stream dataset.
+- name: data_stream.namespace
+  type: constant_keyword
+  description: Data stream namespace.
+- name: '@timestamp'
+  type: date
+  description: Event timestamp.

test/packages/bad_policy_api_format/data_stream/foo/manifest.yml

@@ -0,0 +1,13 @@
+title: "Foo"
+type: logs
+streams:
+  - input: logfile
+    title: Sample logs
+    description: Collect sample logs
+    vars:
+      - name: paths
+        type: text
+        title: Paths
+        multi: true
+        default:
+          - /var/log/*.log

test/packages/bad_policy_api_format/docs/README.md

@@ -0,0 +1,3 @@
+# Bad Policy API Format
+
+Test package for validating that `policy_api_format` only accepts the allowed values `legacy` and `simplified`.

test/packages/bad_policy_api_format/manifest.yml

@@ -0,0 +1,36 @@
+format_version: 3.6.0
+name: bad_policy_api_format
+title: "Malformed policy_api_format"
+version: 0.0.1
+source:
+  license: "Elastic-2.0"
+description: "This is a new package."
+type: integration
+categories:
+  - custom
+conditions:
+  kibana:
+    version: "^8.12.1"
+  elastic:
+    subscription: "basic"
+screenshots:
+  - src: /img/sample-screenshot.png
+    title: Sample screenshot
+    size: 600x600
+    type: image/png
+icons:
+  - src: /img/sample-logo.svg
+    title: Sample logo
+    size: 32x32
+    type: image/svg+xml
+policy_templates:
+  - name: sample
+    title: Sample logs
+    description: Collect sample logs
+    inputs:
+      - type: logfile
+        title: Collect sample logs from instances
+        description: Collecting sample logs
+owner:
+  github: elastic/integrations
+  type: elastic

test/packages/good_v3/data_stream/foo/_dev/test/policy/test-default.yml

@@ -2,3 +2,4 @@ data_stream:
   vars:
     paths:
       - "/var/logs/apache/access.log*"
+policy_api_format: simplified

test/packages/good_v3/data_stream/foo/_dev/test/system/test-default-config.yml

@@ -2,3 +2,4 @@ wait_for_data_timeout: 10m
 skip_ignored_fields:
   - error.message
 vars: ~
+policy_api_format: legacy