github.com/solo-io/cue@v0.4.7/cue/testdata/readme.md (about)

     1  # CUE Test Suite
     2  
     3  This directory contains a test suite for testing the CUE language. This is only
     4  intended to test language evaluation and exporting. Eventually it will also
     5  contains tests for parsing and formatting. It is not intended to cover
     6  testing of the API itself.
     7  
     8  ## Overview
     9  
    10  ### Work in progress
    11  
    12  The tests are currently converted from various internal Go tests and the
    13  grouping reflect properties of the current implementation. Once the transition
    14  to the new implementation is completed, tests should be reordered along more
    15  logical lines: such as literals, expressions, references, cycles, etc.
    16  
    17  
    18  ## Forseen Structure
    19  
    20  The txtar format allows a collection of files to be defined. Any .cue file
    21  is used as an input. The out/* files, which should not have an extension,
    22  define outputs for various tests. A test definition is active for a certain test
    23  if it contains output for this test.
    24  
    25  The comments section of the txtar file may contain additional control inputs for
    26  a test. Each line that starts with a `#` immediately followed by a letter or
    27  digit is specially interpreted. These can be boolean tags (`#foo`) or a
    28  key-value pair (`#key: value`), where the value can be a free-form string.
    29  A line starting with `#` followed by a space is interpreted as a comment.
    30  
    31  Lines not starting with a `#` are for interpretation by the testscript package.
    32  
    33  This organization allows the same test sets to be used for the testing of
    34  tooling as well as internal libraries.
    35  
    36  ## Common options
    37  
    38  - `#skip`: skip this test case for all tests
    39  - `#skip-{name}`: skip this test for the namesake test
    40  - `#todo-{name}`: skip this test for the namesake test, but run it if the
    41     `--todo` flag is specified.
    42  
    43  
    44  ## Tests
    45  
    46  ### cue/internal/compile
    47  
    48  Compiles all *.cue files and prints the debug string of the internal
    49  representation. This is not valid CUE.