test-network-function-claim

test-network-function-claim provides the definition for a test-network-function claim.

A claim contains:

• The test-network-function version used for testing. Note: The claim keeps track of only the test-network-function version, and not individual test versions. For the current offering, the tests included in a test-network-function release are immutable, and the source for all included tests is public. Any changes to provided tests require a subsequent test-network-function release.
• A start time for the claim evaluation.
• A description of the Hardware System(s) Under Test
• All test configurations used by tests.
• All tests run, and their respective results.
• An end time for the claim evaluation.

schemas/claim.schema.json defines the claim schema using JSON Schema Draft-07. JSON Schema serves as the only definition language for a test-network-function claim. In other words, even though other language bindings are possible (and some provided), the ultimate claim definition is claim.schema.json. In the unfortunate event of ambiguity between claim.schema.json and a particular language binding, the former rules.

claim.example.json is an example of a claim file.

Language Bindings

A GoLang implementation of for claim is exposed through pkg/claim/schema.go. This is currently the only language binding.

Requirements

At a minimum, the following dependencies must be installed to work with the GoLang bindings:

Dependency	Minimum Version
GoLang	1.22
golangci-lint	1.58

Modifying the claim schema

In order to make changes to claim.schema.json, please follow these steps.

Edit the file as you see fit

Make the appropriate changes and save the claim.schema.json.

Build the language bindings

After you are done editing the file to a desired state, issue the following command:

make

This will run the Makefile targets necessary to generate a new pkg/claim/schema.go GoLang schema language binding, run the linter, run gofmt and execute all available tests.

One should take all effort to ensure changes to the schema are backwards compatible. In the event that a breaking change is necessary, please make sure to include that information in the commit message. All breaking schema changes require a semantic version major version bump upon release.

Due to the fact that a-h/generate generates the GoLang language binding, some generated code is not easily modifiable. The library will occasionally output un-testable code, so 100% unit test is not a requirement. An example of un-testable code is:

comma := false
// "EndTime" field is required
// only required object types supported for marshal checking (for now)
// Marshal the "endTime" field
if comma {
	buf.WriteString(",")
}

In the above example, the conditional will never evaluate as true. This is a performance limitation of the tool that is accepted, as the GoLang compiler will likely elide the conditional using Abstract Syntax Tree pruning anyway as a compile-time optimization.

Overriding type inferences

a-h/generate is known to output JSON object types as GoLang structs. Although this is normally desirable, we occasionally wish to allow arbitrary JSON instead. In this case, we have no struct definition for some facets of our claim, such as "lshw" and "results". This is due to the fact that others define those JSON structures, and we are not in the business of redefinition. This is a rare case in which we want to allow GoLang to represent arbitrary JSON data.

To remap a property type, please consult override.json, which provides an entrypoint for remapping types in GoLang generated client code.

Validating a JSON claim input file

Requirements

jsonschema must be installed and made available in $PATH.

In order to install jsonschema, issue the following command:

> pip3 install jsonschema

Running the validation utility

In order to validate a given schema, issue the following command:

> jsonschema -i <path_to_claim_file> ./schemas/claim.schema.json

For a successful validation of the input claim, one should expect no output and a 0 exit code.

> jsonschema -i ./sample.json ./schemas/claim.schema.json
> echo $?
0
> 

If the claim does not adhere to the schema, jsonschema outputs an appropriate error message describing the issue.

Running the validation utility against the example claim

In order to run the validation utility against the example, run the following command:

make validate-example

The output should resemble the following:

> make validate-example
jsonschema -i schemas/claim.example.json schemas/claim.schema.json
>