Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

YAML documentation, test, and readability improvements #63158

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

YAML documentation, test, and readability improvements #63158

wants to merge 12 commits into from

Commits on Dec 11, 2023

  1. yaml: Fix documentation about datetime conversion 

    I believe the behavior changed with commit
002aa88 which was first released in
Salt v2018.3.0.
    @rhansen @dwoz
    rhansen authored and dwoz committed Dec 11, 2023
    Configuration menu
    Copy the full SHA
    760b244 View commit details
    Browse the repository at this point in the history

  2. yaml: Document that !!omap should be avoided due to bugs

    @rhansen @dwoz
    rhansen authored and dwoz committed Dec 11, 2023
    Configuration menu
    Copy the full SHA
    7579360 View commit details
    Browse the repository at this point in the history

  3. yaml: Convert salt.utils.yaml tests to pytest

    @rhansen @dwoz
    rhansen authored and dwoz committed Dec 11, 2023
    Configuration menu
    Copy the full SHA
    e7b41bf View commit details
    Browse the repository at this point in the history

  4. yaml: Add integration test for YAML map iteration order 

    This demonstrates that saltstack#12161
has already been fixed (thanks to Python 3.6 changing `dict` to
iterate in insertion order).
    @rhansen @dwoz
    rhansen authored and dwoz committed Dec 11, 2023
    Configuration menu
    Copy the full SHA
    4b926b0 View commit details
    Browse the repository at this point in the history

  5. yaml: Add TODO comments next to puzzling code

    @rhansen @dwoz
    rhansen authored and dwoz committed Dec 11, 2023
    Configuration menu
    Copy the full SHA
    252abc0 View commit details
    Browse the repository at this point in the history

  6. yaml: Delete unnecessary IndentMixin class to improve readability

    @rhansen @dwoz
    rhansen authored and dwoz committed Dec 11, 2023
    Configuration menu
    Copy the full SHA
    7aa5b2d View commit details
    Browse the repository at this point in the history

  7. yaml: Use a for loop to factor out duplicate code

    @rhansen @dwoz
    rhansen authored and dwoz committed Dec 11, 2023
    Configuration menu
    Copy the full SHA
    4699911 View commit details
    Browse the repository at this point in the history

  8. yaml: Register default representer with OrderedDumper too 

    This does not change the behavior, but it does simplify the code.
    @rhansen @dwoz
    rhansen authored and dwoz committed Dec 11, 2023
    Configuration menu
    Copy the full SHA
    b5ed823 View commit details
    Browse the repository at this point in the history

  9. yaml: Factor out duplicate code in salt.utils.yaml.safe_dump()

    @rhansen @dwoz
    rhansen authored and dwoz committed Dec 11, 2023
    Configuration menu
    Copy the full SHA
    1171f5a View commit details
    Browse the repository at this point in the history

  10. yaml: Improve readability of salt.utils.yaml.dump()

    @rhansen @dwoz
    rhansen authored and dwoz committed Dec 11, 2023
    Configuration menu
    Copy the full SHA
    6d36bc3 View commit details
    Browse the repository at this point in the history

  11. yaml: Delete the ineffectual timestamp representer

    @rhansen @dwoz
    rhansen authored and dwoz committed Dec 11, 2023
    Configuration menu
    Copy the full SHA
    0b85753 View commit details
    Browse the repository at this point in the history

  12. tests: Use salt.utils.yaml to generate reference YAML 

    The same YAML value can be represented in different ways, so tests
that compare a generated YAML string with a manually typed string are
fragile.  Use `salt.utils.yaml` to generate the reference YAML so that
the implementation of the YAML dumper can change without breaking the
tests.
    @rhansen @dwoz
    rhansen authored and dwoz committed Dec 11, 2023
    Configuration menu
    Copy the full SHA
    60d8ed3 View commit details
    Browse the repository at this point in the history