yaml-schema 0.9.3

A YAML schema validator
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

Feature: CLI usage

  Scenario: Display the version
    When the following command is run:
      ```
      ys version
      ```
    Then it should exit with status code 0
    And it should output:
      ```
      ys 0.9.3
      ```

  Scenario: Basic validation with a valid file
    When the following command is run:
      ```
      ys -f tests/fixtures/schema.yaml tests/fixtures/valid.yaml
      ```
    Then it should exit with status code 0

  Scenario: Validation using top-level $schema instead of -f
    When the following command is run:
      ```
      ys tests/fixtures/instance_with_dollar_schema_valid.yaml
      ```
    Then it should exit with status code 0

  Scenario: Validation using $schema with an invalid instance
    When the following command is run:
      ```
      ys tests/fixtures/instance_with_dollar_schema_invalid.yaml
      ```
    Then it should exit with status code 1
    And stderr output should end with:
      ```
      [2:6] .foo: Expected a string, but got: 42 (int)
      [3:6] .bar: Expected a number, but got: "I'm a string" (string)
      ```

  Scenario: Basic validation with an invalid file
    When the following command is run:
      ```
      ys -f tests/fixtures/schema.yaml tests/fixtures/invalid.yaml
      ```
    Then it should exit with status code 1
    And stderr output should end with:
      ```
      [1:6] .foo: Expected a string, but got: 42 (int)
      [2:6] .bar: Expected a number, but got: "I'm a string" (string)
      ```

  Scenario: Basic validation with an invalid file and JSON output
    When the following command is run:
      ```
      ys --json -f tests/fixtures/schema.yaml tests/fixtures/invalid.yaml
      ```
    Then it should exit with status code 1
    And stdout should be a JSON array with two validation errors for paths foo and bar

  Scenario: Multiple valid files with -f
    When the following command is run:
      ```
      ys -f tests/fixtures/schema.yaml tests/fixtures/valid.yaml tests/fixtures/valid.yaml
      ```
    Then it should exit with status code 0

  Scenario: Multiple files with -f, first invalid, fails fast
    When the following command is run:
      ```
      ys -f tests/fixtures/schema.yaml tests/fixtures/invalid.yaml tests/fixtures/valid.yaml
      ```
    Then it should exit with status code 1
    And stderr output should end with:
      ```
      tests/fixtures/invalid.yaml:
      [1:6] .foo: Expected a string, but got: 42 (int)
      [2:6] .bar: Expected a number, but got: "I'm a string" (string)
      ```

  Scenario: Multiple files with -f and JSON output tags each error with its file
    When the following command is run:
      ```
      ys --json -f tests/fixtures/schema.yaml tests/fixtures/invalid.yaml tests/fixtures/valid.yaml
      ```
    Then it should exit with status code 1
    And stdout should be a JSON array of validation errors tagged with file "tests/fixtures/invalid.yaml", for paths foo and bar

  Scenario: Multiple valid files using top-level $schema instead of -f
    When the following command is run:
      ```
      ys tests/fixtures/instance_with_dollar_schema_valid.yaml tests/fixtures/instance_with_dollar_schema_valid.yaml
      ```
    Then it should exit with status code 0

  Scenario: Multiple files using $schema, first invalid, fails fast
    When the following command is run:
      ```
      ys tests/fixtures/instance_with_dollar_schema_invalid.yaml tests/fixtures/instance_with_dollar_schema_valid.yaml
      ```
    Then it should exit with status code 1
    And stderr output should end with:
      ```
      tests/fixtures/instance_with_dollar_schema_invalid.yaml:
      [2:6] .foo: Expected a string, but got: 42 (int)
      [3:6] .bar: Expected a number, but got: "I'm a string" (string)
      ```

  Scenario: Multiple files without -f, first file missing $schema fails fast
    When the following command is run:
      ```
      ys tests/fixtures/valid.yaml tests/fixtures/instance_with_dollar_schema_valid.yaml
      ```
    Then it should exit with status code 1
    And stderr output should start with:
      ```
      Validation failed: No schema: pass -f/--schema or add a string `$schema` key to the YAML root mapping
      ```