diff --git a/.gitignore b/.gitignore index 79390fd..c8d3ea9 100644 --- a/.gitignore +++ b/.gitignore @@ -21,3 +21,7 @@ # Node.js files for tools (e.g. markdown-toc) node_modules/ package-lock.json + +# validator binary +otel_config_validator +validator/schema diff --git a/validator/Dockerfile b/validator/Dockerfile new file mode 100644 index 0000000..d4eecbc --- /dev/null +++ b/validator/Dockerfile @@ -0,0 +1,21 @@ +# syntax=docker/dockerfile:1 +FROM golang:1.22 AS build + +WORKDIR /app + +COPY go.mod go.sum ./ +RUN go mod download + +COPY . . + +RUN CGO_ENABLED=0 GOOS=linux go build -o /otel_config_validator + +FROM gcr.io/distroless/base-debian12 + +WORKDIR / + +COPY --from=build /otel_config_validator /otel_config_validator + +USER nonroot:nonroot + +ENTRYPOINT ["/otel_config_validator"] diff --git a/validator/Dockerfile.shelltest b/validator/Dockerfile.shelltest new file mode 100644 index 0000000..4810ff3 --- /dev/null +++ b/validator/Dockerfile.shelltest @@ -0,0 +1,15 @@ +FROM ubuntu:22.04 + +RUN + +RUN DEBIAN_FRONTEND=noninteractive \ + apt-get update \ + && apt-get install -y software-properties-common \ + && apt-add-repository ppa:rmescandon/yq \ + && apt-get update \ + && apt-get install -y shelltestrunner jq yq \ + && rm -rf /var/lib/apt/lists/* + +WORKDIR /root + +ENTRYPOINT ["shelltest"] diff --git a/validator/LICENSE b/validator/LICENSE new file mode 100644 index 0000000..f49a4e1 --- /dev/null +++ b/validator/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/validator/Makefile b/validator/Makefile new file mode 100644 index 0000000..6fcb084 --- /dev/null +++ b/validator/Makefile @@ -0,0 +1,18 @@ +ROOT_DIR := $(realpath $(shell dirname $(firstword $(MAKEFILE_LIST)))) +SCHEMA_DIR := ${ROOT_DIR}/../schema +CURRENT_GIT_REF := $(shell git rev-parse --short HEAD) +DOCKER_IMAGE_TAG := ${CURRENT_GIT_REF} +DOCKER_BUILD_ARGS := -t otel_config_validator:${DOCKER_IMAGE_TAG} + +all: build + +copy-schema: + cp -R ${SCHEMA_DIR} ${ROOT_DIR}/ + +build: copy-schema + go build + +docker: copy-schema + docker build . ${DOCKER_BUILD_ARGS} + +.PHONY: all copy-schema build docker diff --git a/validator/README.md b/validator/README.md new file mode 100644 index 0000000..3bad07e --- /dev/null +++ b/validator/README.md @@ -0,0 +1,52 @@ +## OpenTelemetry SDK Configuration Validator + +This application will validate a yaml or json file against the [OpenTelemetry +SDK Configuration schema](https://github.com/open-telemetry/opentelemetry-configuration/). + +### Build + +The `schema` directory is required to be in the directory of the Go file that +embeds it so a `go build` alone will fail, instead run `make` which will copy +the schema: + +``` +$ make +``` + +Same is true for building the docker image: + +``` +$ make docker +``` + +### Usage + +The command `otel_config_validator` takes one argument, the path to the yaml or +json configuration file and optionally the path to a file to output the +configuration after environment variable expansion and validation has been done. +The format (json or yaml) of the output is based on the extension (`.json` or +`yml`/`.yaml`) of the output file name. + +``` +$ ./otel_config_validator -o out.json ../examples/kitchen-sink.yaml +``` + +Environment variable substitution is supported with the syntax `${VARIABLE}`. +Default values are supported in the form `${VARIABLE:default}`. + +### Testing + +Run the Go unit tests: + +``` +$ go test . +``` + +Running the tests of the compiled CLI requires +[shelltest](https://github.com/simonmichael/shelltestrunner), +[jq](https://github.com/jqlang/jq/) and [yq](https://github.com/mikefarah/yq): + +``` +$ shelltest -c --diff --all shelltests/*.test +``` + diff --git a/validator/go.mod b/validator/go.mod new file mode 100644 index 0000000..cb008d4 --- /dev/null +++ b/validator/go.mod @@ -0,0 +1,16 @@ +module otel_config_validator + +go 1.22.0 + +require ( + github.com/santhosh-tekuri/jsonschema/v5 v5.3.1 + github.com/stretchr/testify v1.8.4 + github.com/urfave/cli/v3 v3.0.0-alpha9 + gopkg.in/yaml.v3 v3.0.1 +) + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect +) diff --git a/validator/go.sum b/validator/go.sum new file mode 100644 index 0000000..bbf394f --- /dev/null +++ b/validator/go.sum @@ -0,0 +1,15 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/santhosh-tekuri/jsonschema/v5 v5.3.1 h1:lZUw3E0/J3roVtGQ+SCrUrg3ON6NgVqpn3+iol9aGu4= +github.com/santhosh-tekuri/jsonschema/v5 v5.3.1/go.mod h1:uToXkOrWAZ6/Oc07xWQrPOhJotwFIyu2bBVN41fcDUY= +github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +github.com/urfave/cli/v3 v3.0.0-alpha9 h1:P0RMy5fQm1AslQS+XCmy9UknDXctOmG/q/FZkUFnJSo= +github.com/urfave/cli/v3 v3.0.0-alpha9/go.mod h1:0kK/RUFHyh+yIKSfWxwheGndfnrvYSmYFVeKCh03ZUc= +github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 h1:bAn7/zixMGCfxrRTfdpNzjtPYqr8smhKouy9mxVdGPU= +github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673/go.mod h1:N3UwUGtsrSj3ccvlPHLoLsHnpR27oXr4ZE984MbSER8= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/validator/main.go b/validator/main.go new file mode 100644 index 0000000..86dd646 --- /dev/null +++ b/validator/main.go @@ -0,0 +1,241 @@ +package main + +import ( + "bytes" + "context" + "embed" + "encoding/json" + "log" + "net/url" + "os" + "path/filepath" + "strings" + + jsonschema "github.com/santhosh-tekuri/jsonschema/v5" + "github.com/urfave/cli/v3" + yaml "gopkg.in/yaml.v3" +) + +//go:embed schema/* +var schemaFS embed.FS + +func main() { + log.SetFlags(0) + + cmd := &cli.Command{ + Name: "otel_config_validator", + Usage: "Validate a configuration file against the OpenTelemetry Configuration Schema", + Flags: []cli.Flag{ + &cli.StringFlag{ + Name: "output", + Aliases: []string{"o"}, + OnlyOnce: true, + Usage: "optionally where to output the configuration (as json or yaml) after variable expansion and validation", + }, + }, + Action: runAction(), + } + + if err := cmd.Run(context.Background(), os.Args); err != nil { + log.Fatal(err) + } +} + +func runAction() func(ctx context.Context, cmd *cli.Command) error { + return func(ctx context.Context, cmd *cli.Command) error { + if cmd.Args().Len() < 1 { + log.Fatalf("Must pass a configuration filename") + } else { + configFilePath := cmd.Args().Get(0) + + jsonConfig := validateConfiguration(configFilePath) + + if o := cmd.String("output"); o != "" { + jsonToFile(jsonConfig, o) + } + } + return nil + } +} + +func validateConfiguration(configFile string) interface{} { + schemaFiles, err := schemaFS.ReadDir("schema") + if err != nil { + log.Fatal(err) + } + + c := jsonschema.NewCompiler() + + for _, file := range schemaFiles { + schemaURL, err := url.JoinPath("https://opentelemetry.io/otelconfig/", file.Name()) + schema, err := schemaFS.ReadFile(filepath.Join("schema", file.Name())) + if err != nil { + log.Fatal(err) + } + + if err := c.AddResource(schemaURL, bytes.NewReader(schema)); err != nil { + log.Fatal(err) + } + } + + schema, err := c.Compile("https://opentelemetry.io/otelconfig/opentelemetry_configuration.json") + if err != nil { + log.Fatalf("%#v", err) + } + + v := decodeFile(configFile) + expandedConfig := replaceVariables(v) + + if err = schema.Validate(expandedConfig); err != nil { + if ve, ok := err.(*jsonschema.ValidationError); ok { + log.Fatalf("%#v", ve) + } else { + log.Fatalf("%#v", err) + } + } + + return expandedConfig +} + +func decodeFile(file string) interface{} { + data, err := os.ReadFile(file) + if err != nil { + log.Fatal(err) + } + + ext := filepath.Ext(file) + if ext == ".yaml" || ext == ".yml" { + return decodeYAML(file) + } + + var v interface{} + if err := json.Unmarshal(data, &v); err != nil { + log.Fatalf("Invalid json file %s: %#v", file, err) + } + + return v +} + +func decodeYAML(file string) interface{} { + var v interface{} + + body, err := os.ReadFile(file) + if err != nil { + log.Fatalf("Failed to read configuration file %s: %v", file, err) + } + + reader := bytes.NewReader(body) + dec := yaml.NewDecoder(reader) + + if err := dec.Decode(&v); err != nil { + log.Fatalf("Invalid yaml file %s: %v", file, err) + } + + return v +} + +func jsonToFile(j interface{}, outFile string) { + ext := filepath.Ext(outFile) + if ext == ".yaml" || ext == ".yml" { + yamlString, err := yaml.Marshal(j) + err = os.WriteFile(outFile, yamlString, 0644) + if err != nil { + log.Fatalf("Unable to write output file: %v", err) + } + + err = os.WriteFile(outFile, yamlString, 0644) + if err != nil { + log.Fatalf("Unable to write output file: %v", err) + } + } else if ext == ".json" { + jsonString, err := json.MarshalIndent(j, "", " ") + if err != nil { + log.Fatalf("Unable to convert to json: %v", err) + } + + err = os.WriteFile(outFile, jsonString, 0644) + if err != nil { + log.Fatalf("Unable to write output file: %v", err) + } + } else { + log.Fatalf("Unknown extension on output file %v", outFile) + } +} + +func replaceVariables(c interface{}) interface{} { + expandedConfig := make(map[string]any) + m, _ := c.(map[string]any) + for k := range m { + val := expandValues(m[k]) + expandedConfig[k] = val + } + + return expandedConfig +} + +func expandValues(value any) any { + switch v := value.(type) { + case string: + if !strings.Contains(v, "${") || !strings.Contains(v, "}") { + return v + } + + return expandString(v) + case []any: + l := []any{} + for _, e := range v { + newElement := expandValues(e) + l = append(l, newElement) + } + return l + case map[string]any: + newMap := make(map[string]any) + + for k, v := range v { + updated := expandValues(v) + newMap[k] = updated + } + + return newMap + } + + return value +} + +// Replace environment variables ${EXAMPLE} with their value and continue to +// try replacing variables until there are no more, meaning ${EXAMPLE} could +// contain another variable ${ANOTHER_VARIABLE}. But stop after 100 iterations +// to prevent an infinite loop. +// This does not use os.ExpandVars in order to support defaults like ${VAR:default} +func expandString(s string) string { + result := s + for i := 0; i < 100; i++ { + if !strings.Contains(result, "${") || !strings.Contains(result, "}") { + break + } + + closeIndex := strings.Index(result, "}") + openIndex := strings.LastIndex(result[:closeIndex+1], "${") + + fullEnvVar := result[openIndex : closeIndex+1] + envVar := result[openIndex+2 : closeIndex] + + maybeDefaultIndex := strings.Index(envVar, ":-") + + var newValue string + if maybeDefaultIndex != -1 { + d := envVar[maybeDefaultIndex+2:] + envVar = envVar[:maybeDefaultIndex] + newValue = os.Getenv(envVar) + if strings.EqualFold(newValue, "") { + newValue = d + } + } else { + newValue = os.Getenv(envVar) + } + + result = strings.ReplaceAll(result, fullEnvVar, newValue) + } + + return result +} diff --git a/validator/main_test.go b/validator/main_test.go new file mode 100644 index 0000000..84b25a2 --- /dev/null +++ b/validator/main_test.go @@ -0,0 +1,51 @@ +package main + +import ( + "os" + "strings" + "testing" +) + +func TestExpandString(t *testing.T) { + e1 := "VARIABLE1" + v1 := "${VARIABLE2}" + + e2 := "VARIABLE2" + v2 := "value2" + + e3 := "VARIABLE3" + v3 := "VARIABLE1" + + os.Setenv(e1, v1) + os.Setenv(e2, v2) + os.Setenv(e3, v3) + + t.Cleanup(func() { + os.Unsetenv(e1) + }) + + s := expandString("${VARIABLE1} World") + if !strings.Contains(s, v2) { + t.Errorf("String \"%v\" does not contain value %v", s, v2) + } + + s = expandString("${VARIABLE1}${VARIABLE2}") + if !strings.Contains(s, "value2value2") { + t.Errorf("String \"%v\" does not contain value %v", s, v2) + } + + s = expandString("${${VARIABLE3}}") + if !strings.Contains(s, v2) { + t.Errorf("String \"%v\" does not contain value %v", s, v2) + } + + s = expandString("${VARIABLE2") + if !strings.Contains(s, "${VARIABLE2") { + t.Errorf("String \"%v\" should still contains ${VARIABLE2", s) + } + + s = expandString("${UNDEFINED:-mydefault}") + if !strings.EqualFold(s, "mydefault") { + t.Errorf("String \"%v\" should be mydefault", s) + } +} diff --git a/validator/shelltests/help.test b/validator/shelltests/help.test new file mode 100644 index 0000000..e1948d2 --- /dev/null +++ b/validator/shelltests/help.test @@ -0,0 +1,15 @@ +./otel_config_validator --help +>>> +NAME: + otel_config_validator - Validate a configuration file against the OpenTelemetry Configuration Schema + +USAGE: + otel_config_validator [global options] [command [command options]] [arguments...] + +COMMANDS: + help, h Shows a list of commands or help for one command + +GLOBAL OPTIONS: + --output value, -o value optionally where to output the configuration (as json or yaml) after variable expansion and validation + --help, -h show help (default: false) +>>>= 0 diff --git a/validator/shelltests/json_out.test b/validator/shelltests/json_out.test new file mode 100644 index 0000000..44ba3e4 --- /dev/null +++ b/validator/shelltests/json_out.test @@ -0,0 +1,8 @@ +FILE_FORMAT=0.1 ./otel_config_validator -o out.json shelltests/test.yaml +>>> +>>>= 0 + +jq '.file_format' out.json +>>> +"0.1" +>>>= 0 \ No newline at end of file diff --git a/validator/shelltests/missing_arg.test b/validator/shelltests/missing_arg.test new file mode 100644 index 0000000..0ca83ba --- /dev/null +++ b/validator/shelltests/missing_arg.test @@ -0,0 +1,4 @@ +./otel_config_validator -o out.json +>>>2 +Must pass a configuration filename +>>>= 1 diff --git a/validator/shelltests/missing_ext.test b/validator/shelltests/missing_ext.test new file mode 100644 index 0000000..fa81e8d --- /dev/null +++ b/validator/shelltests/missing_ext.test @@ -0,0 +1,4 @@ +./otel_config_validator -o out shelltests/test.yaml +>>>2 +Unknown extension on output file out +>>>= 1 diff --git a/validator/shelltests/missing_required.test b/validator/shelltests/missing_required.test new file mode 100644 index 0000000..95ca337 --- /dev/null +++ b/validator/shelltests/missing_required.test @@ -0,0 +1,5 @@ +./otel_config_validator shelltests/missing_required.yaml +>>>2 +[I#] [S#] doesn't validate with https://opentelemetry.io/otelconfig/opentelemetry_configuration.json# + [I#] [S#/required] missing properties: 'file_format' +>>>= 1 diff --git a/validator/shelltests/missing_required.yaml b/validator/shelltests/missing_required.yaml new file mode 100644 index 0000000..555fe92 --- /dev/null +++ b/validator/shelltests/missing_required.yaml @@ -0,0 +1 @@ +missing_required: file_format diff --git a/validator/shelltests/test.yaml b/validator/shelltests/test.yaml new file mode 100644 index 0000000..4fe6208 --- /dev/null +++ b/validator/shelltests/test.yaml @@ -0,0 +1 @@ +file_format: ${FILE_FORMAT} diff --git a/validator/shelltests/yaml_out.test b/validator/shelltests/yaml_out.test new file mode 100644 index 0000000..db5c467 --- /dev/null +++ b/validator/shelltests/yaml_out.test @@ -0,0 +1,8 @@ +FILE_FORMAT=0.1 ./otel_config_validator -o out.yaml shelltests/test.yaml +>>> +>>>= 0 + +yq eval '.file_format' out.yaml +>>> +0.1 +>>>= 0 \ No newline at end of file