Deprecate case randomization feature #206
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This feature has always been experimental and seems to have been implemented a long time ago to test Zonemaster::LDNS internals. However, there are better ways to ensure that. This commit introduces deprecation warnings in three places: * in the documentation; * when executing Makefile.PL; * and during compilation of the C and XS code. Hopefully, having the same warning in three different places will be enough to alert end users.
Case in point (heh) of how little use the experimental case randomization feature had: one unit tests broke without anyone noticing it. We can reverse this patch later when the feature is actually removed.
marc-vanderwal
requested review from
mattias-p,
matsduf,
tgreenx and
MichaelTimbert
matsduf
approved these changes
Sep 2, 2024
tgreenx
approved these changes
Sep 4, 2024
tgreenx
added
the
V-Patch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
This PR adds deprecation warnings for the experimental (and thus also seemingly untested) case randomization feature that can be optionally compiled in Zonemaster::LDNS.
Context
See issue #160.
Changes
Warn end users about the upcoming removal of this feature in three places:
Makefile.PLscript;How to test this PR
In the root of the source tree of Zonemaster::LDNS, run
cpanm -v --configure-args="--random" ..In the first 30 lines of the console output, expect:
During the build stage, also expect a compiler-generated warning like so:
Expect unit tests to pass.
Then, run
cpanm -v .. Expect none of the aforementioned deprecation warnings to appear in the output, and expect unit tests to pass.