Ksconf

~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Fix an ``unarchive`` bug triggered by trailing slashes in ``--app-name``.
Trailing slashes are removed automatically.
Any other ``/`` present will trigger an error and require the user to clarify.

~~~~~~~~~~~~~~~~~~~~~~~~~~~

* **Fix for pre-commit hook installation.**
Pre-commit now uses an alternate shallow clone that fails to fetch the actual tag pointed to by ``rev``.
The ksconf python packaging process relies on git metadata.
This results in an error message ``InvalidVersion: Invalid version: 'cec3615'`` in the pre-commit.log file.
See `pre-commit 2610 <https://github.com/pre-commit/pre-commit/issues/2610>`__ for additional background.

-----------

**Highlights:**

* Ksconf now requires Python 3.7 or newer.
* The Python package was renamed ``ksconf``.


**API Changes**

* Core layer combining logic now lives in :py:class:`~ksconf.combine.LayerCombiner`.
The new :py:class:`~ksconf.command.combine.RepeatableCombiner` class has logic for marker safety checks and settings for removing or preserving existing files.
The :py:class:`~ksconf.command.combine.CombineCmd` now contains only the command line functionality.

~~~~~~~~~~~~~~~~~~~~~~~~~~~


**Highlights:**

* The official Python package was renamed ``ksconf``.
The ``kintyre-splunk-conf`` package will continue to be released in parallel at least until version 1.0.
You can continue updating and using the ``kintyre-splunk-conf`` package but eventually startup warnings will be added to remind users to switch.
* Ksconf v0.10 and later requires Python 3.7 or newer.
If you need Python 2.7 or 3.6 support, please stick with the latest 0.9.x release of ``kintyre-splunk-conf``.
* The KSCONF acronym has taken on a new meaning.
Originally, meaning *Kintyre's Splunk CONFiguration tool*,
now becomes a recursive acronym: *Ksconf Splunk CONFiguration tool*.
Kintyre has been acquired by CDI LLC, and this option seemed least intrusive.
* Add support Dashboard Studio dashboards.
The JSON blobs inside of Simple XML payloads can now be formatted too.
Multiline searches are still difficult to diff, but there's no way to fix that while using JSON.


More changes:

* Remove ``six`` built-in dependency.
* Refactor the ``combine`` logic into more reusable classes.
This simplifies the CLI logic for both the ``combine`` and ``package`` functionality.
The ``combine`` CLI and functionality remains unchanged.
* Updated ``package`` to use new combine new layer classes rather than making internal CLI calls to "combine".
This has the potentially to be more efficient and allow for easier functionality expansions in the future.
* Deprecated the ``--layer_method=auto`` choice from the ``package`` command. This will be an error in the next release (v0.11).
* Add new layer-related dynamic variables for the ``package`` command.
Use ``{{layers_list}}`` to capture what unique layer names made their way into a tarball, and
use ``{{layers_hash}}`` when that list get too long to be manageable.

Bug fixes:

* Fixed ``sort`` bug where the user was incorrectly told that a file with errors was unexpectedly also successfully replaced.
The contradictory output messages have been cleaned up.
For clarity, this only occurred for inline replacement mode, and was purely a reporting issue, not a file handling problem.
* Fixed compatibility issues with ``rest-publish`` command and the splunk-sdk library around data type expectations.
A big thanks to bayeslearner (`95 <https://github.com/Kintyre/ksconf/issues/95>`__) for the fix.
If you run into any issues, try upgrading your version of ``splunk-sdk``.

~~~~~~~~~~~~~~~~~~~~~~~~~~
- Added internal caching for :py:class:`~ksconf.package.AppVarMagic` (``ksconf package`` command) to reduce repeated variable expansion work.
This will likely go unnoticed by most, but it does speed up some operations in the ``cdillc.splunk.ksconf_package`` Ansible module.
- Minor docs corrections.

~~~~~~~~~~~~~~~~~~~~~~~~~~
- The ``filter`` command can now include/exclude stanzas based on the boolean value of ``disabled`` using the new ``--enabled-only`` or ``--disabled-only`` arguments.
The default behavior remains the same, that is, the ``disabled`` attribute is completely ignored.
Thanks to John B Splunker for inspiring this feature!