Skip to content

CHANGELOG.md

Latest commit

 

History

History
253 lines (176 loc) · 8.86 KB

CHANGELOG.md

File metadata and controls

253 lines (176 loc) · 8.86 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

3.6.0 - 2026-03-26

Added

  • TextStyle type alias (Literal["without_comments", "merged", "with_comments"]) for the style parameter on HConfigChild.cisco_style_text() and RemediationReporter.to_text(), replacing the unconstrained str type (#189).

  • Performance benchmarks for parsing, remediation, and iteration (#202). Skipped by default; run with poetry run pytest -m benchmark -v -s.

  • Added support for Huawei VRP with a new driver and test suite (#238).

Fixed

  • DuplicateChildError raised when parsing IOS-XR configs with indented ! section separators (e.g., !, !). The per_line_sub regex was changed from ^!\s*$ to ^\s*!\s*$ so bare ! lines at any indentation level are stripped, restoring v3.4.2 behavior (#231).

  • __hash__ and __eq__ inconsistency in HConfigChild: __hash__ included new_in_config and order_weight but __eq__ excluded them, and __eq__ checked tags but __hash__ did not, violating the Python invariant that a == b implies hash(a) == hash(b). Both methods now use the same fields: text, tags, and children (#185).

3.5.0 - 2026-03-19

Added

  • Unused object detection framework: UnusedObjectRule, ReferenceLocation models, and unused_objects() method on HConfig. Not enabled in any driver by default — must be explicitly configured via driver extension or load_hconfig_v2_options (#15).
  • IOS-XR comment preservation: ! comment lines inside sections are now attached to the next sibling's comments set instead of being stripped. Top-level ! delimiters and # comments are still removed (#30).
  • Negation regex substitution: NegationSubRule model and negation_sub step in negate() for platform-specific negation transformations such as truncating SNMP user removal commands (#101).
  • unused_objects and negation_sub processing in load_hconfig_v2_options.
  • post_load_callbacks now run in get_hconfig_fast_load for consistency with get_hconfig.
  • Idempotent command tests and improved IdempotentCommandsRule docstring (#61).
  • exit_text_parent_level on SectionalExitingRule for IOS-XR end-* exit text rendered at parent indentation level (#130).
  • CLAUDE.md for Claude Code guidance.

Fixed

  • IOS-XR: DuplicateChildError when parsing configs with multiple group blocks (#209).
  • IOS-XR: Three tests updated for exit_text_parent_level indentation change.
  • pyproject.toml: Closed author email brackets, removed duplicate pylint extension, fixed "Coverred" typos (#190).

3.4.3 - 2026-03-19

Fixed

  • IOS-XR: DuplicateChildError when parsing configs with multiple group blocks. Added SectionalExitingRule for group → end-group and a PerLineSubRule to indent end-group so it is treated as a section terminator rather than a standalone root-level child (issue #209).

3.4.2 - 2026-03-17

Fixed

  • IOS-XR: DuplicateChildError on nested if/endif blocks inside route-policy sections. Added a parent_allows_duplicate_child rule at depth 2 (route-policy -> if) so duplicate endif children are permitted (issue #206).
  • IOS-XR: indent_adjust rule for template incorrectly triggered on template timeout leaf parameters inside flow exporter-map blocks, corrupting indentation for all subsequent top-level sections. Narrowed the start expression with a negative lookahead ((?!\s+timeout)) to exclude leaf uses (issue #205).

3.4.1 - 2026-01-28

Added

  • negation_negate_with support in load_hconfig_v2_options utility, allowing v2-style option dictionaries to express custom negation strings when migrating to v3 drivers (issue #182).

Changed

  • Updated poetry.lock to resolve dependency version pins.

3.4.0 - 2026-01-10

Added

  • Structural idempotency matching — _future() now derives an identity key from a command's full lineage before comparing it against idempotency rules. This prevents unrelated lines that share a common prefix (e.g. distinct BGP neighbour descriptions) from being collapsed into a single entry during future() predictions.
  • Fortinet FortiOS driver documentation.

Fixed

  • BGP neighbour descriptions with different peer addresses no longer merge into one entry when future() is called.
  • Resolved issue #169.

Changed

  • Internal type annotations updated to PEP 604 union syntax (X | Y).

3.3.0 - 2025-11-05

Added

  • Config view abstraction — new HConfigViewBase and ConfigViewInterfaceBase abstract classes providing a structured, typed API over configuration trees without modifying the underlying HConfig objects.
  • Platform-specific view implementations for Cisco IOS, Cisco NX-OS, Cisco IOS XR, Arista EOS, and HP ProCurve.

3.2.2 - 2025-01-14

Changed

  • Removed snmp-server community from built-in driver idempotency rules to avoid unintended matching across platforms.
  • Linting and type annotation cleanup.

3.2.1 - 2024-12-19

Fixed

  • Corrected an incorrect parent assignment when building a delta subtree during config_to_get_to(), which could cause child nodes to appear under the wrong parent in the remediation output.

Changed

  • Updated poetry.lock.

3.2.0 - 2024-12-18

Added

  • RemediationReporter — aggregates remediation configs from multiple devices, exposing summary statistics, tag-based filtering, and JSON/CSV export (issue #34).

3.1.1 - 2024-12-11

Added

  • py.typed marker file, enabling downstream packages to perform PEP 561 type-checking against hier_config without additional configuration.

3.1.0 - 2024-12-09

Added

  • fast_load utility for high-performance bulk config loading.
  • get_hconfig_from_dump — reconstruct an HConfig tree from a serialised Dump object, enabling round-trip serialisation.
  • HP ProCurve (Aruba AOSS) driver with post-load callbacks that normalise VLAN membership and port-access range expansion.
  • HP Comware5 driver with undo negation prefix.

3.0.0 - 2024-11-18

Breaking Changes

  • Host class removed. The Host class that existed in v2 has been deleted. Use get_hconfig(platform, config_text) and get_hconfig_driver(platform) instead.
  • Driver system introduced. OS-specific behaviour is now encoded in typed Pydantic driver classes (HConfigDriverBase subclasses) rather than plain dictionaries. Each platform has a dedicated module under hier_config/platforms/.
  • Pydantic v2. All internal models use Pydantic v2 (model_config, ConfigDict, etc.). Third-party code that accessed internal model fields directly may need updating.
  • options / hconfig_options dictionaries removed. Use driver classes with HConfigDriverRules instead.

Added

  • get_hconfig(platform, text) — primary constructor function.
  • get_hconfig_driver(platform) — retrieve a standalone driver instance.
  • hier_config.utils — migration helpers including load_hconfig_v2_options to convert v2 option dicts to v3 driver rule objects.
  • WorkflowRemediation — replaces the old Host-level remediation API.
  • Fortinet FortiOS driver.
  • Juniper JunOS driver (experimental, set/delete syntax).
  • VyOS driver (experimental, set/delete syntax).
  • Platform enum for type-safe platform selection.

Changed

  • All rule definitions now use immutable Pydantic models (MatchRule, SectionalExitingRule, IdempotentCommandsRule, etc.).
  • HConfig and HConfigChild now use __slots__ for lower memory overhead.