vyos-cloud-init.git/cloudinit/config/cc_write_files.py, branch sagitta-public-unmaintained

use PEP 589 syntax for TypeDict (#1253)

2022-02-14T19:24:00+00:00

Use PEP 589 syntax for TypeDict annotation. Also fixes previously broken typing MetaSchema typing implementation.

Adopt Black and isort (SC-700) (#1157)

2021-12-16T02:16:38+00:00

Applied Black and isort, fixed any linting issues, updated tox.ini and CI.

Add Strict Metaschema Validation (#1101)

2021-12-06T22:27:12+00:00

Improve schema validation. This adds strict validation of config module definitions at testing time, with plumbing included for future runtime validation. This eliminates a class of bugs resulting from schemas that have definitions that are incorrect, but get interpreted by jsonschema as "additionalProperties" that are therefore ignored. - Add strict meta-schema for jsonschema unit test validation - Separate schema from module metadata structure - Improve type annotations for various functions and data types Cleanup: - Remove unused jsonschema "required" elements - Eliminate manual memoization in schema.py:get_schema(), reference module.__doc__ directly

Add module 'write-files-deferred' executed in stage 'final' (#916)

2021-10-25T19:31:07+00:00

The main idea is to introduce a second module that takes care of writing files, but in the 'final' stage. While the introduction of a second module would allow for choosing the appropriate place withing the order of modules (and stages), there is no addition top-level directive being added to the cloud configuration schema. Instead, 'write-files' schema is being extended to include a 'defer' attribute used only by the 'write-deffered-files' modules. The new module 'write-deferred-files' reuses as much as possible of the 'write-files' functionality.

Add schema to apt configure config (#357)

2020-05-13T20:45:01+00:00

Create a schema object for the `apt_configure` module and validate this schema in the `handle` function of the module. There are some considerations regarding this PR: * The `primary` and `security` keys have the exact same properties. I tried to eliminate this redundancy by moving their properties to a common place and then just referencing it for both security and primary. Similar to what is documented here: https://json-schema.org/understanding-json-schema/structuring.html under the `Reuse` paragraph. However, this approach does not work, because the `#` pointer goes to the beginning of the file, which is a python module instead of a json file, not allowing the pointer to find the correct definition. What I did was to create a separate dict for the mirror config and reuse it for primary and security, but maybe there are better approaches to do that. * There was no documentation for the config `debconf_selections`. I tried to infer what it supposed to do by looking at the code and the `debconf-set-selections` manpage, but my description may not be accurate or complete. * Add a _parse_description function to schema.py to render multi-line preformatted content instead of squashing all whitespace LP: #1858884

Add docs about creating parent folders (#330)

2020-04-28T15:55:34+00:00

Clarify in documentation that write_files will create parent folders for paths that do not already exist. This obfuscates what the problem is when people erroneously create files in /tmp despite the warnings in the documentation not to do so. People naturally assume that their file is absent because the parent folder did not exist for it to be created in, causing them to add a runcmd block to create the folder, even though execution order means that this will not occur until after write_files have all finished.

schema: add json schema for write_files module (#152)

2020-04-24T20:39:25+00:00

Add schema definition to cc_write_files.py Cloud-config containing write_files config directives will now emit warnings for invalid config keys or values for the write_files module. Add an extension to JSON schema's draft4validator to permit either binary or text values for 'string' objects. This allows for JSON schema validating the YAML declaration of binary valiues in cloud-config using YAML's '!!binary' syntax. Add the ability to pass a specific module name to `cloud-init devel schema --docs |all` to optionally limit doc output during development to a single schema doc.

Drop most of the remaining use of six (#179)

2020-01-21T23:02:42+00:00

write_files: add support for appending to files.

2018-12-06T18:26:32+00:00

Add 'append: true' to write_files entries to append 'content' to file specified by 'path' key. This modifies the file open mode to append.

docs: note in rtd about avoiding /tmp when writing files

2018-07-09T20:13:47+00:00

LP: #1727876