Aggiorna README.md

Add UPnP example in configuration file

.autom4te.cfg

@@ -0,0 +1,6 @@
+# Disable autom4te cache to ensure that any change to ddclient.in triggers a
+# rebuild of the configure script (which gets the version of ddclient from
+# ddclient.in).  See <https://lists.gnu.org/r/automake/2019-10/msg00002.html>.
+begin-language: "Autoconf-without-aclocal-m4"
+args: --no-cache
+end-language: "Autoconf-without-aclocal-m4"

.envrc

@@ -0,0 +1,5 @@
+if has lorri; then
+  eval "$(lorri direnv)"
+else
+  use nix
+fi

.github/workflows/ci.yml

@@ -0,0 +1,111 @@
+name: CI
+on:
+  push:
+  pull_request:
+
+jobs:
+  test-debian-like:
+    strategy:
+      fail-fast: false
+      matrix:
+        image:
+          - ubuntu:latest
+          - ubuntu:20.04
+          - debian:testing
+          - debian:stable
+          - debian:oldstable
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ matrix.image }}
+    steps:
+      - name: install dependencies
+        run: |
+          apt-get update &&
+          DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
+              automake \
+              ca-certificates \
+              git \
+              curl \
+              libhttp-daemon-perl \
+              libhttp-daemon-ssl-perl \
+              libplack-perl \
+              libtest-mockmodule-perl \
+              libtest-tcp-perl \
+              libtest-warnings-perl \
+              liburi-perl \
+              libwww-perl \
+              net-tools \
+              make \
+              ;
+      - uses: actions/checkout@v4
+      - name: autogen
+        run: ./autogen
+      - name: configure
+        run: ./configure
+      - name: check
+        run: make VERBOSE=1 AM_COLOR_TESTS=always check
+      - name: distcheck
+        run: make VERBOSE=1 AM_COLOR_TESTS=always distcheck
+      - name: distribution tarball is complete
+        run: ./.github/workflows/scripts/dist-tarball-check
+      - if: ${{ matrix.image == 'debian:testing' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: distribution-tarball
+          path: ddclient-*.tar.gz
+
+  test-fedora-like:
+    strategy:
+      fail-fast: false
+      matrix:
+        image:
+          - fedora:39
+          - fedora:latest
+          - fedora:rawhide
+          - almalinux:8
+          - almalinux:latest
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ matrix.image }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: enable repositories (AlmaLinux 8)
+        if: ${{ matrix.image == 'almalinux:8' }}
+        run: |
+          dnf --refresh install -y 'dnf-command(config-manager)' epel-release &&
+          dnf config-manager --set-enabled powertools
+      - name: enable repositories (AlmaLinux latest)
+        if: ${{ matrix.image == 'almalinux:latest' }}
+        run: |
+          dnf --refresh install -y 'dnf-command(config-manager)' epel-release &&
+          dnf config-manager --set-enabled crb
+      - name: install dependencies
+        # The --skip-broken argument works around missing packages.  (They're
+        # only used for testing, so it's OK to not install them.)
+        run: |
+          dnf --refresh install --skip-broken -y \
+              automake \
+              findutils \
+              iproute \
+              make \
+              curl \
+              perl \
+              perl-HTTP-Daemon \
+              perl-HTTP-Daemon-SSL \
+              perl-IO-Socket-INET6 \
+              perl-Plack \
+              perl-Test-MockModule \
+              perl-Test-TCP \
+              perl-Test-Warnings \
+              perl-core \
+              perl-libwww-perl \
+              net-tools \
+              ;
+      - name: autogen
+        run: ./autogen
+      - name: configure
+        run: ./configure
+      - name: check
+        run: make VERBOSE=1 AM_COLOR_TESTS=always check
+      - name: distcheck
+        run: make VERBOSE=1 AM_COLOR_TESTS=always distcheck

.github/workflows/pr.yml

@@ -0,0 +1,49 @@
+name: Pull Request
+on:
+  pull_request:
+    types:
+      - labeled
+      - opened
+      - reopened
+      - synchronize
+      - unlabeled
+
+jobs:
+  linear-history:
+    if: ${{ !contains(github.event.pull_request.labels.*.name, 'pr-permit-nonlinear') }}
+    name: Linear History
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: No new merge commits
+        run: |
+          log() { printf %s\\n "$*" >&2; }
+          error() { log "ERROR: $@"; }
+          fatal() { error "$@"; exit 1; }
+          try() { log "Running command $@"; "$@" || fatal "'$@' failed"; }
+          out=$(try git rev-list -n 1 --merges '${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }}') || exit 1
+          [ -z "${out}" ] || {
+              error "pull request includes a merge commit and does not have the 'pr-permit-nonlinear' label"
+              git show "${out}" >&2
+              exit 1
+          }
+  no-autosquash:
+    if: ${{ !contains(github.event.pull_request.labels.*.name, 'pr-permit-autosquash') }}
+    name: No --autosquash commits
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: 'No commits with messages starting with "fixup!", "squash!", or "amend!"'
+        run: |
+          log() { printf %s\\n "$*" >&2; }
+          error() { log "ERROR: $@"; }
+          fatal() { error "$@"; exit 1; }
+          try() { log "Running command $@"; "$@" || fatal "'$@' failed"; }
+          out=$(try git log --oneline '${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }}') || exit 1
+          ! grep -E '^[^ ]* (fixup|squash|amend)!' <<EOF || fatal "--autosquash commits not allowed without the 'pr-permit-autosquash' label"
+          ${out}
+          EOF

.github/workflows/scripts/dist-tarball-check

@@ -0,0 +1,72 @@
+#!/bin/sh
+
+pecho() { printf %s\\n "$*"; }
+log() { pecho "$@"; }
+warning() { log "::warning::$@"; }
+error() { log "::error::$@"; }
+fatal() { error "$@"; exit 1; }
+try() { "$@" || fatal "'$@' failed"; }
+
+# actions/checkout@v2 only makes a clone if Git is v2.18 or later, and this
+# test requires a clone.
+git_ver=$(try dpkg-query -f '${Version}' -W git) || exit 1
+dpkg --compare-versions "${git_ver}" ge '1:2.18~' || {
+    warning "This test requires Git v2.18 or later"
+    exit 0
+}
+
+dist_tarball=$(ls ddclient-*.tar.gz) \
+    || fatal "'make dist' must be run before this test"
+
+tmpdir=$(try mktemp -d) || exit 1
+# newer git versions are particular about file ownership which can be ignored here
+git config --global --add safe.directory /__w/ddclient/ddclient || true
+
+log "Copying contents of Git repository..."
+try git archive --format=tar --prefix=git-repo/ HEAD \
+    | try tar -C "${tmpdir}" -xv || exit 1
+(
+    try cd "${tmpdir}"/git-repo
+    # Delete files checked into Git that shouldn't be in the distribution
+    # tarball.
+    try rm -rf \
+        .envrc \
+        .github \
+        .gitignore \
+        docs/ipv6-design-doc.md \
+        docs/ProviderGuidelines.md \
+        shell.nix \
+        ;
+    # TODO: Delete this next line once support for Automake 1.11 is dropped and
+    # tap-driver.sh is removed from the Git repository. It is deleted here to
+    # avoid a spurious diff.
+    try rm -f build-aux/tap-driver.sh
+) || exit 1
+
+log "Extracting distribution tarball..."
+try tar -C "${tmpdir}" -xvzf "${dist_tarball}"
+try mv "${tmpdir}/${dist_tarball%.tar.gz}" "${tmpdir}"/dist-tarball
+(
+    try cd "${tmpdir}"/dist-tarball
+    # Delete generated files
+    try rm -rf \
+        Makefile.in \
+        aclocal.m4 \
+        build-aux/install-sh \
+        build-aux/missing \
+        build-aux/tap-driver.sh \
+        configure \
+        ;
+) || exit 1
+
+log "Comparing Git repository with distribution tarball..."
+cd "${tmpdir}"
+diff -qNr git-repo dist-tarball >/dev/null || {
+    error "Unexpected diff between the repo and the distribution tarball."
+    error "You may need to add a file to EXTRA_DIST in Makefile.am."
+    error "Diff output:"
+    diff -uNr git-repo dist-tarball \
+        | while IFS= read -r line; do error "${line}"; done
+    exit 1
+}
+log "No difference"

.gitignore

@@ -3,3 +3,23 @@ release
 .svn
 .cvsignore
 *~
+/Makefile
+/Makefile.in
+/aclocal.m4
+/autom4te.cache/
+/build-aux/config.guess
+/build-aux/config.sub
+/build-aux/install-sh
+/build-aux/missing
+/build-aux/tap-driver.sh
+/config.log
+/config.status
+/configure
+/ddclient
+/ddclient-*.tar.gz
+/ddclient.conf
+/t/*.log
+/t/*.trs
+/t/geturl_connectivity.pl
+/t/version.pl
+/test-suite.log

CONTRIBUTING.md

@@ -0,0 +1,294 @@
+# How to Contribute
+
+Thank you for your interest in making ddclient better! This document
+provides guidelines to make the contribution process as smooth as
+possible.
+
+To contribute changes, please open a pull request against the
+[ddclient GitHub project](https://github.com/ddclient/ddclient/pulls).
+
+## Developer Certificate of Origin
+
+All contributions are subject to the [Developer Certificate of Origin
+v1.1](https://developercertificate.org/), copied below. A
+`Signed-off-by` line in each commit message is **not** required.
+
+```
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+1 Letterman Drive
+Suite D4700
+San Francisco, CA, 94129
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.
+```
+
+## Style
+
+  * Above all else, try to match the existing style surrounding your
+    edits.
+  * No trailing whitespace.
+  * Use spaces, not tabs.
+  * Indentation level is 4 spaces.
+  * Use parentheses for Perl function invocations: `print($fh "foo")`
+    not `print $fh "foo"`
+  * When reasonable, break lines longer than 99 characters. Rationale:
+    - Imposing a limit makes it practical to open many side-by-side
+      files or terminals without worrying about horizontal scrolling.
+    - 99 is used instead of 100 so that the +/- column added by
+      unified diff does not cause wrapping in 100 column wide
+      terminals.
+  * Add spaces to vertically align adjacent lines of code when doing
+    so improves readability.
+
+The following [perltidy](https://metacpan.org/pod/perltidy) command is
+not perfect but it can get you close to our preferred style:
+
+```shell
+perltidy -l=99 -conv -ci=4 -ola -ce -nbbc -kis -pt=2 -b ddclient
+```
+
+## Git Hygiene
+
+  * Please keep your pull request commits rebased on top of `main`.
+  * Please use `git rebase -i` to make your commits easy to review:
+    - Put unrelated changes in separate commits
+    - Squash your fixup commits
+  * Write your commit message in imperative mood, and explain *why*
+    the change is made (unless obvious) in addition to *what* is
+    changed.
+
+If you are not very comfortable with Git, we encourage you to read
+[Pro Git](https://git-scm.com/book) by Scott Chacon and Ben Straub
+(freely available online).
+
+## Unit tests
+
+Always add tests for your changes when feasible.
+
+To run the ddclient test suite:
+
+  1. Install GNU Autoconf and Automake
+  2. Run: `./autogen && ./configure && make VERBOSE=1 check`
+
+To add a new test script:
+
+  1. Create a new `t/*.pl` file with contents like this:
+
+     ```perl
+     use Test::More;
+     # Your test dependencies go here.
+
+     SKIP: { eval { require Test::Warnings; } or skip($@, 1); }
+     eval { require 'ddclient'; } or BAIL_OUT($@);
+
+     # Your tests go here.
+
+     done_testing();
+     ```
+
+     See the documentation for
+     [Test::More](https://perldoc.perl.org/Test/More.html) for
+     details.
+
+  2. Add your script to the `handwritten_tests` variable in
+     `Makefile.am`.
+
+  3. If your test script requires 3rd party modules, add the modules
+     to the list of test modules in `configure.ac` and re-run
+     `./autogen && ./configure`. Be sure to skip the tests if the
+     module is not available. For example:
+
+     ```perl
+     eval { require Foo::Bar; } or plan(skip_all => $@);
+     ```
+
+## Compatibility
+
+We strive to find the right balance between features, code
+maintainability, and broad platform support. To that end, please limit
+yourself to Perl language features and modules available on the
+following platforms:
+
+  * Debian oldstable and newer
+  * Ubuntu, [all maintained
+    releases](https://ubuntu.com/about/release-cycle)
+  * Fedora, [all maintained
+    releases](https://fedoraproject.org/wiki/Fedora_Release_Life_Cycle)
+  * CentOS, [all maintained
+    releases](https://wiki.centos.org/About/Product)
+  * Red Hat Enterprise Linux, [all maintained
+    releases](https://access.redhat.com/support/policy/updates/errata/)
+
+See https://pkgs.org for available modules and versions.
+
+Exceptions:
+  * You may depend on modern language features or modules for new
+    functionality when no feasible alternative exists, as long as the
+    new dependency does not break existing functionality on old
+    plaforms.
+  * Test scripts may depend on arbitrary modules as long as the tests
+    are skipped if the modules are not available. Effort should be
+    taken to only use modules that are broadly available.
+
+You may use any core Perl module as long as it is available in all
+versions of Perl we support. (Though please make sure it is listed in
+the appropriate `configure.ac` check.) Stated another way: We are not
+interested in supporting platforms that lack some core Perl modules,
+unless doing so is trivial.
+
+All shell scripts should conform with [POSIX Issue 7 (2018
+edition)](https://pubs.opengroup.org/onlinepubs/9699919799/) or later.
+
+## Prefer Revert and Redo, Not Fix
+
+Suppose a recent change broke something or otherwise needs
+refinement. It is tempting to simply push a fix, but it is usually
+better to revert the original change then redo it:
+
+  * There is less subjectivity with a revert, so you are more likely
+    to get a quick approval and merge. You can quickly "stop the
+    bleeding" while you and the project maintainers debate about the
+    best way to fix the problem with the original commit.
+  * It is easier and less mistake-prone to cherry-pick a single commit
+    (the redo commit) than two commits (the original commit plus the
+    required fix).
+  * Someone using blame to review the history will see the redo
+    commit, not the buggy original commit.
+
+## For ddclient Project Maintainers
+
+### Merging Pull Requests
+
+To facilitate reviews and code archaeology, `main` should have a
+semi-linear commit history like this:
+
+```
+*   f4e6e90 sandro.jaeckel@gmail.com 2020-05-31 07:29:51 +0200 (main)
+|\          Merge pull request #142 from rhansen/config-line-format
+| * 30180ed rhansen@rhansen.org 2020-05-30 13:09:38 -0400
+|/          Expand comment documenting config line format
+*   01a746c rhansen@rhansen.org 2020-05-30 23:47:54 -0400
+|\          Merge pull request #138 from rhansen/dyndns-za-net
+| * 08c2b6c rhansen@rhansen.org 2020-05-29 14:44:57 -0400
+|/          Replace dydns.za.net with dyndns.za.net
+*   d65805b rhansen@rhansen.org 2020-05-30 22:30:04 -0400
+|\          Merge pull request #140 from ddclient/fix-interpolation
+| * babbef1 sandro.jaeckel@gmail.com 2020-05-30 04:03:44 +0200
+|/          Fix here doc interpolation
+*   6ae69a1 rhansen@rhansen.org 2020-05-30 22:23:57 -0400
+|\          Merge pull request #141 from ddclient/show-debug-ssl
+| * 096288e sandro.jaeckel@gmail.com 2020-05-30 04:42:27 +0200
+| |         Expand tabs to spaces in vim
+| * 0206262 sandro.jaeckel@gmail.com 2020-05-30 04:40:58 +0200
+|/          Show debug connection settings after evaluating use-ssl
+...
+```
+
+See https://stackoverflow.com/a/15721436 for an explanation of the
+benefits.
+
+This semi-linear style is mostly useful for multi-commit pull
+requests. For single-commit pull requests, GitHub's "Squash and merge"
+and "Rebase and merge" options are fine, though this approach still
+has value:
+
+  * The merge commit's commit message can link to the pull request
+    or contain other contextual information.
+  * It's easier to see who merged the PR (just look at the merge
+    commit author.)
+  * You can easily see both the original author timestamp (when the
+    change was made) and the merge timestamp (when it went live).
+
+To achieve a history like the above, the pull request must be rebased
+onto `main` before merging. Unfortunately, GitHub does not have a
+one-click way to do this (the "Rebase and merge" option does a
+fast-forward merge, which is not what we want). See
+[isaacs/github#1143](https://github.com/isaacs/github/issues/1143) and
+[isaacs/github#1017](https://github.com/isaacs/github/issues/1017). Until
+GitHub adds that feature, it has to be done manually:
+
+```shell
+# Set this to the name of the GitHub user or project that owns the
+# fork used for the pull request:
+PR_USER=
+
+# Set this to the name of the branch in the fork used for the pull
+# request:
+PR_BRANCH=
+
+# The commands below assume that `origin` refers to the
+# ddclient/ddclient repository
+git remote set-url origin git@github.com:ddclient/ddclient.git
+
+# Add a remote for the fork used in the PR
+git remote add "${PR_USER:?}" git@github.com:"${PR_USER:?}"/ddclient
+
+# Fetch the latest commits for the PR and ddclient main
+git remote update -p
+
+# Switch to the pull request branch
+git checkout -b "${PR_USER:?}-${PR_BRANCH:?}" "${PR_USER:?}/${PR_BRANCH:?}"
+
+# Rebase the commits (optionally using -i to clean up history) onto
+# the current ddclient main branch
+git rebase origin/main
+
+# Force update the contributor's fork. This will only work if the
+# contributor has checked the "Allow edits by maintainers" box in the
+# PR. If not, you will have to manually merge the rebased commits.
+git push -f
+
+# If the force push was successful, you can now go into the GitHub UI
+# and merge using the "Create a merge request" option.
+#
+# If the force push failed because the contributor did not check
+# "Allow edits by maintainers", or if you prefer to merge manually,
+# continue with the next steps.
+
+# Switch to the local main branch
+git checkout main
+
+# Make sure the local main branch is up to date
+git merge --ff-only origin/main
+
+# Merge in the rebased pull request branch **WITHOUT DOING A
+# FAST-FORWARD MERGE**
+git merge --no-ff "${PR_USER:?}-${PR_BRANCH:?}"
+
+# Review the commits before pushing
+git log --graph --oneline --decorate origin/main..
+
+# Push to ddclient main
+git push origin main
+```

COPYING

@@ -2,7 +2,7 @@
 		       Version 2, June 1991
 
  Copyright (C) 1989, 1991 Free Software Foundation, Inc.
-                       59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 

ChangeLog

@@ -1,560 +0,0 @@
-2015-05-28  wimpunk
-
-	* [r183] ., release: Removing unneeded release directory
-
-2015-03-23  wimpunk
-
-	* [r182] ddclient: Reverting to the old perl requirements like
-	  suggested in #75
-
-		The new requirements were added when adding support for cloudflare. By the
-		simple fix suggested by Roy Tam we could revert the requirements which make
-		ddclient back usable on CentOS and RHEL.
-
-	* [r181] ddclient: ddclient: made json optional
-
-	  As suggested in pull 7 on github by @abelbeck and @Bugsbane it is
-	  better to make the
-	  use of JSON related to the use of cloudflare.
-
-	* [r180] ddclient: ddclient: reindenting cloudflare
-
-	  Indenting cloudflare according to the vim tags
-
-	* [r179] ddclient: ddclient: correction after duckdns merge
-
-	  Correcting duckdns configuration after commit r178
-
-	* [r178] ddclient: Added simple support for Duckdns www.duckdns.org
-
-	  Patch provided by gkranis on github.
-	  Merge branch 'gkranis'
-
-2015-03-21  wimpunk
-
-	* [r177] README.md: Added duckDNS to the README.md
-	* [r176] sample-etc_rc.d_init.d_ddclient.ubuntu: update ubuntu init.d script
-
-	  Merge pull request #9 from gottaloveit/master
-
-	* [r175] Changelog, Changelog.old: Renamed Changelog to
-	  Changelog.old
-
-	  Avoiding conflicts on case insensitive filesystems
-
-	* [r174] ddclient: Add missing config line for CloudFlare
-
-	  Merge pull request #19 from shikasta-net/fixes
-
-	* [r173] ddclient: Merge pull request #22 from reddyr/patch-1
-
-	  loopia.se changed the "Current Address:" output string to "Current IP
-		Address:"
-
-	* [r172] ddclient: fixed missing ) for cloudflare service hash
-
-	  Merge pull request #16 from adepretis/master
-
-2015-01-20  wimpunk
-
-	* [r171] README.md, ddclient, sample-etc_ddclient.conf: Adding
-	  support for google domain
-
-	  Patch gently provided through github on
-	  https://github.com/wimpunk/ddclient/pull/13
-
-2014-10-08  wimpunk
-
-	* [r170] README.md, ddclient, sample-etc_ddclient.conf: Added
-	  support for Cloudflare and multi domain support for namecheap
-
-	  Pull request #7 from @roberthawdon
-	  See https://github.com/wimpunk/ddclient/pull/7 for more info.
-
-2014-09-09  wimpunk
-
-	* [r169] ddclient: Bugfix: allowing long username-password
-	  combinations
-
-	  Patch provided by @dirdi through github.
-
-2014-08-20  wimpunk
-
-	* [r166] ddclient: Fixing bug #72: Account info revealed during
-	  noip update
-
-	* [r165] ddclient: Interfaces can be named almost anything on
-	  modern systems.
-
-	  Patch provided by Stephen Couchman through github
-
-2014-06-30  wimpunk
-
-	* [r164] ddclient: Only delete A RR, not any RR for the FQDN
-
-	  Make the delete command specific to A RRs. This prevents ddclient
-	  from deleting other RRs unrelated to the dynamic address, but on the
-	  same FQDN. This can be specifically a problem with KEY RRs when using
-	  SIG(0) instead of symmetric keys.
-
-	  Reported by: Wellie Chao
-	  Bug report: http://sourceforge.net/p/ddclient/bugs/71/
-
-	  Fixes #71
-
-2014-06-02  wimpunk
-
-	* [r163] README.md, ddclient: Adding support for nsupdate.
-
-	  Patch provided by Daniel Roethlisberger <daniel@roe.ch> through
-	  github.
-
-2014-04-29  wimpunk
-
-	* [r162] README.md, README.ssl, ddclient: Removed revision
-	  information
-
-	  Revision information isn't very usable when switching to git.
-
-2014-03-20  wimpunk
-
-	* [r161] README.md, README.ssl, ddclient,
-	  sample-etc_rc.d_init.d_ddclient.alpine: Added Alpine Linux init
-	  script
-
-	  Patch send by Tal on github.
-
-	* [r160] RELEASENOTE: Corrected release note
-
-2013-12-26  wimpunk
-
-	* [r159] release/readme.txt: Commiting updated release information
-	* [r158] README.md, RELEASENOTE: Committing release notes and
-	  readme information to trunk
-
-2013-11-05  wimpunk
-
-	* [r156] patches: Moving patching to the root of the repository.
-
-	  The patches are mostly there for historical reasons. They've been
-	  moved away to make cleaning easier. I think the applied patches should
-	  even be removed.
-
-2013-10-28  wimpunk
-
-	* [r155] ddclient: Fallback to iproute if ifconfig doesn't work.
-
-	  This fix applies the patch provided by Maccied Grela in [bugs:#26]
-
-	* [r154] ddclient: preventing deep sleep - see [bugs:#46]
-
-	  Fixing [bugs:#46] by applying the provided patch.
-
-2013-07-08  wimpunk
-
-	* [r153] ddclient: Applying patch from [fb1ad014] fixing bug [#14]
-
-	  More info can be found on [fb1ad014] and has been discussed in
-	  the mailinglist:
-	  http://article.gmane.org/gmane.network.dns.ddclient.user/71. The
-	  patch was send by Rodrigo Araujo.
-
-2013-05-14  wimpunk
-
-	* [r152] ddclient: Adding sha1-patch provided by pirast in
-	  [9742ac09]
-
-2013-04-28  wimpunk
-
-	* [r150] README.md, ddclient, sample-etc_ddclient.conf: Adding
-	  support for ChangeIP based on the patch from Michele Giorato
-	  http://sourceforge.net/p/ddclient/discussion/399428/thread/e85661ad/
-	* [r148] README.md: Updated README file
-	* [r147] ., README, README.md: Applying markdown syntax to README
-
-2011-07-11  wimpunk
-
-	* [r131] release/readme.txt: Updates after releasing 3.8.1
-	* [r129] release/readme.txt: Corrected release/readme.txt
-	* [r128] sample-etc_ppp_ip-up.local: Applied ip-up_run-parts.diff
-	  from ubuntu
-	* [r127] ddclient: Applied smc-barricade-fw-alt.diff from ubuntu
-
-2011-07-03  wimpunk
-
-	* [r126] ddclient: Fixing #28: FreeDNS.afraid.org changed api
-	  slightly
-
-2011-05-19  wimpunk
-
-	* [r125] ddclient, sample-etc_ddclient.conf: Added patch for
-	  dtdns-support (#39)
-
-2011-03-09  wimpunk
-
-	* [r124] ddclient: Patching with nic_updateable-warning patch
-	  provided by antespi in ticket #2
-
-2011-03-08  wimpunk
-
-	* [r123] ddclient: Patching with zoneedit patch provided by
-	  killer-jk in ticket #15
-
-2010-12-07  wimpunk
-
-	* [r122] ddclient: Added longer password support, sended by Ingo
-	  Schwarze (#3130634)
-
-2010-10-13  wimpunk
-
-	* [r121] ddclient: Fixing bug #13: multiple fetch-ip but
-	  introducing a multiple ip bug
-
-2010-09-14  wimpunk
-
-	* [r120] ddclient: patch for #10: invalid value for keyword ip
-
-2010-09-13  wimpunk
-
-	* [r119] ddclient: Applied patch from ticket #8, patch for cache
-	  content leaks to global
-	* [r118] ddclient: Applied patch from ticket #7, provided by Chris
-	  Carr
-
-2010-07-01  wimpunk
-
-	* [r117] ddclient: Fixed #6: Add Red Hat package name to Perl
-	  module IO::Socket::SSL error message
-
-2010-02-24  wimpunk
-
-	* [r116] ddclient: Subversion revision added
-
-2009-11-09  wimpunk
-
-	* [r115] ddclient, patches/cisco-asa.patch: Added cisco-asa patch
-	  (2891001) submitted by Philip Gladstone
-	* [r114] ddclient, patches/prevent-hang.patch: Added prevent-hang
-	  patch (2880462) submitted by Panos
-
-2009-10-19  wimpunk
-
-	* [r113] ddclient, patches/foreground.patch: Added foreground patch
-	  (1893144) submitted by John Palkovic
-
-2009-09-10  wimpunk
-
-	* [r112] README, ddclient, patches/loopia.patch,
-	  sample-etc_ddclient.conf: #1609799 Support for LoopiaDNS
-	  (submitted by scilence)
-
-2009-08-05  wimpunk
-
-	* [r111] ddclient, patches/freedns-patch: applied freedns patch
-	  (patch 2832129)
-
-2009-05-16  wimpunk
-
-	* [r110] ddclient: Bug 2792436: fixed abuse message of dyndns
-
-2009-02-27  wimpunk
-
-	* [r109] sample-etc_ddclient.conf: Added warning about the update
-	  interval (#2619505)
-
-2009-01-27  wimpunk
-
-	* [r108] .cvsignore, RELEASENOTE, ddclient, release,
-	  release/readme.txt: Modified during the release of ddclient-3.8.0
-
-2008-12-04  wimpunk
-
-	* [r106] ddclient: help about postscript added
-
-2008-11-19  wimpunk
-
-	* [r105] ddclient, patches/password.patch: Added better password
-	  handling sended by Ingo Schwarze
-	* [r104] TODO, sample-ddclient-wrapper.sh: Added ddclient wrapper
-	  script
-	* [r103] ddclient: Extra fix for multiple IP's
-
-2008-11-01  wimpunk
-
-	* [r102] sample-etc_ddclient.conf: Added some remarks concerning
-	  the postscript. See
-	  https://sourceforge.net/forum/message.php?msg_id=5550545
-
-2008-09-30  wimpunk
-
-	* [r101] ddclient, patches/multiple-ip.patch: Added support for
-	  multiple IP adresses. See
-	  http://permalink.gmane.org/gmane.network.dns.ddclient.user/17
-	* [r100] patches/namecheap.patch: extra comments added to namecheap
-	  patch
-
-2008-07-04  wimpunk
-
-	* [r99] patches/namecheap.patch: namecheap patch added to patches
-	  section
-
-2008-06-13  wimpunk
-
-	* [r98] .: New trunk created based on the old trunk/svn
-	* [r96] svn: Moved old trunk/svn to ddclient and it will be the new
-	  trunk
-	* [r95] svn: Ignoring test configuration
-	* [r94] svn/.cvsignore, svn/RELEASENOTE, svn/UPGRADE: Added some
-	  release related files
-	* [r93] svn/patches/no-host.patch: Added not used no-host patch to
-	  patches section
-
-2008-06-05  wimpunk
-
-	* [r90] svn/ddclient: Added more info about the daemon interval
-	* [r89] svn/ddclient: Preventing error while reading cache when ip
-	  wasn't set correctly before
-	* [r88] svn/ddclient: Preventing an error when trying to send a
-	  message on mail-failure
-
-2008-06-02  wimpunk
-
-	* [r87] svn/ddclient, svn/sample-etc_ddclient.conf: Modified
-	  documentation about zoneedit based on the comments from Oren Held
-
-2008-03-04  wimpunk
-
-	* [r86] svn/patches/ddclient.daemon-timeout.patch: Added patch
-	  which was applied to rev 27 (posted by James deBoer)
-
-2008-02-19  wimpunk
-
-	* [r85] svn/patches/eurodns.patch: Patch modified to apply on
-	  ddclient 3.7.3
-
-2008-02-08  wimpunk
-
-	* [r84] svn/patches/mail-on-kill.patch: Added mail-on-kill patch to
-	  patches section
-
-2008-02-05  wimpunk
-
-	* [r83] svn/ddclient: Sending mail when killed, not after
-	  TERM-signal
-	* [r82] svn/README: Added creation of cache dir
-
-2007-10-29  wimpunk
-
-	* [r81] svn/ddclient, svn/patches/ubuntu/default-timeout.patch:
-	  Added and applied default timeout patch from
-	  https://bugs.launchpad.net/ubuntu/+source/ddclient/+bug/116066
-
-2007-08-29  wimpunk
-
-	* [r80] svn/ddclient, svn/patches/ddclient-noip.patch: Added
-	  ddclient-noip.patch send by Kurt Bussche.
-
-2007-08-07  wimpunk
-
-	* [r78] svn/ddclient: Updated version number to 3.7.3
-
-2007-08-01  wimpunk
-
-	* [r77] svn/ddclient, svn/patches/typo_dnspark.patch: Applied
-	  typo_dnspark.patch send by Marco
-
-2007-07-31  wimpunk
-
-	* [r76] svn/README.ssl: Renamed dyndns.org to dyndns.com
-	* [r75] svn/README: Removed ^M at line 37
-	* [r74] svn/ddclient: Removed line 183, comments on Vigor 2200 USB
-
-2007-07-30  wimpunk
-
-	* [r73] svn: Ignoring ChangeLog since autogenerated
-	* [r72] svn/Changelog: Notification about changed ChangeLog
-	  configuration
-	* [r71] svn/patches/ubuntu/dyndns_com.diff: Removed patch since
-	  it's invalid
-	* [r70] svn/patches/opendns.patch: Added not applied opendns.patch,
-	  see tracker #1758564
-	* [r69] svn/patches/debianpatches,
-	  svn/patches/debianpatches/abuse_msg.diff,
-	  svn/patches/debianpatches/cachedir.diff,
-	  svn/patches/debianpatches/cisco_fw.diff,
-	  svn/patches/debianpatches/config_path.diff,
-	  svn/patches/debianpatches/daemon_check.diff,
-	  svn/patches/debianpatches/daemon_interval.diff,
-	  svn/patches/debianpatches/help_nonroot(2).diff,
-	  svn/patches/debianpatches/help_nonroot.diff,
-	  svn/patches/debianpatches/ip-up_run-parts.diff,
-	  svn/patches/debianpatches/maxinterval.diff,
-	  svn/patches/debianpatches/readme.txt,
-	  svn/patches/debianpatches/sample_path.diff,
-	  svn/patches/debianpatches/smc-barricade-7401bra.patch,
-	  svn/patches/debianpatches/smc-barricade-fw-alt.diff,
-	  svn/patches/debianpatches/update-new-config.patch,
-	  svn/patches/ubuntu, svn/patches/ubuntu/checked_ssl_load.diff,
-	  svn/patches/ubuntu/config_path.diff,
-	  svn/patches/ubuntu/daemon_interval.diff,
-	  svn/patches/ubuntu/dyndns_com.diff,
-	  svn/patches/ubuntu/sample_ubuntu.diff, svn/patches/ubuntu/series,
-	  svn/patches/ubuntu/smc-barricade-fw-alt.diff: Added debian and
-	  ubuntu patches
-
-2007-07-29  wimpunk
-
-	* [r68] svn/TODO: Added url to feature request dyndns
-
-2007-07-12  wimpunk
-
-	* [r67] svn/README, svn/patches/readme.patch: Run dos2unix on
-	  readme and it's patch which Marco Rodrigues submitted.
-	* [r66] svn/README, svn/patches/readme.patch: Partial applied
-	  readme.patch. See tracker #1752931
-
-2007-07-10  wimpunk
-
-	* [r65] svn/ddclient: signature modified
-	* [r64] svn/ddclient: Added website to ddclient comments
-	* [r63] svn/patches/regex_vlan.patch: Added extra comments to the
-	  patch.
-	* [r62] svn/ddclient, svn/patches/create_patch.sh,
-	  svn/patches/regex_vlan.patch,
-	  svn/patches/typo_namecheap_patch.diff.new: Added patches and
-	  applied regex_vlan.patch. See bug #1747337
-	* [r61] svn/ddclient: Applied typo_namecheap_patch.diff send by
-	  Marco Rodrigues
-
-2007-07-07  wimpunk
-
-	* [r60] svn/sample-etc_ppp_ip-up.local: Reverted the patch from
-	  torsten. See [ 1749470 ] Bug in Script sample-etc_ppp_ip-up.local
-
-2007-07-04  wimpunk
-
-	* [r59] svn/release, svn/release/readme.txt: Adding some release
-	  documentation
-
-2007-06-14  wimpunk
-
-	* [r57] svn/Changelog, svn/ddclient: Changed version number
-	* [r55] svn/patches, svn/patches/3com-oc-remote812.patch,
-	  svn/patches/easydns.patch, svn/patches/eurodns.patch: Patches
-	  directory added
-
-2007-06-12  wimpunk
-
-	* [r54] svn/ddclient: 3com-oc-remote812 patch by The_Beast via IRC:
-	  see patches/3com-oc-remote812.patch
-
-2007-06-05  wimpunk
-
-	* [r53] svn/ddclient: Applied easydns.patch, patch 117054
-
-2007-05-28  wimpunk
-
-	* [r52] svn/ddclient: Changed nic_namecheap_update following the
-	  suggestion of edmdude on the forum
-	  (https://sourceforge.net/forum/message.php?msg_id=4316938)
-
-2007-05-19  wimpunk
-
-	* [r48] svn/ddclient: Cosmetic change about checkip
-	* [r47] svn/ddclient: Applied checked_ssl_load.diff from ubuntu
-	* [r46] svn/ddclient: Removed the two empty lines at the end of
-	  ddclient
-
-2007-02-26  wimpunk
-
-	* [r44] svn/TODO: added a TODO list
-
-2007-02-21  wimpunk
-
-	* [r43] svn/Changelog, svn/ddclient: Preventing unitialized values,
-	  check https://sourceforge.net/forum/message.php?msg_id=4167772
-
-2007-01-24  wimpunk
-
-	* [r40] svn/Changelog, svn/ddclient: Changed max-interval to
-	  25days. See https://www.dyndns.com/services/dns/dyndns/faq.html
-
-2006-12-03  wimpunk
-
-	* [r39] svn/Changelog, svn/ddclient: Applied maxinterval.diff:
-	  Increase max interval for updates.
-	  See http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=129370
-	  http://www.dyndns.com/support/services/dyndns/faq.html#q15
-	* [r38] svn/ddclient: Applied cisco_fw.diff: Use configured
-	  hostname for firewall access with
-	  -use=cisco (closes: #345712). Thanks to Per Carlson for the
-	  patch!
-	  See http://bugs.debian.org/345712.
-
-2006-12-02  wimpunk
-
-	* [r37] svn/Changelog, svn/ddclient: Applied
-	  smc-barricade-7401bra.patch: Support for SMC Barricade 7401BRA FW
-	  firewall (submitted by Torsten)
-	  Changelog modified for all previous patches from Torsten
-	* [r36] svn/ddclient: Applied update-new-config.patch: Force update
-	  if config has changed
-	  (submitted by Torsten)
-	* [r35] svn/sample-etc_ppp_ip-up.local: Applied
-	  ip-up_run-parts.diff: Fix parameter in ip-up script.
-	  (submitted by Torsten)
-	* [r34] svn/ddclient: Applied help_nonroot.diff: Allow calling the
-	  help function as non-root.
-	  (submitted by Torsten)
-	* [r33] svn/ddclient: Applied cachedir.diff: Original ddclient
-	  stores a cache file in /etc which
-	  would belong in /var/cache in my opinion and according to the
-	  FHS. Patch
-	  changes that. (submitted by Torsten)
-	* [r32] svn/ddclient: Applied abuse_msg.diff: ddclient still
-	  reports the email to contact dyndns.org
-	  but they prefer a web form today (IIRC). This patch adjusts the
-	  abuse warning
-	  printed by ddclient. (submitted by Torsten)
-	* [r31] svn/Changelog: Changed Changelog syntax
-
-2006-11-27  wimpunk
-
-	* [r30] svn/Changelog, svn/ddclient: Don't send any mail when in
-	  not running daemon mode (patch submitted by Daniel Thaler)
-
-2006-11-03  wimpunk
-
-	* [r28] svn/Changelog, svn/ddclient: Added patch "Patch: Treat
-	  --daemon values as intervals"
-	  (submitted by James deBoer)
-
-2006-09-30  wimpunk
-
-	* [r22] svn/Changelog, svn/sample-etc_rc.d_init.d_ddclient.ubuntu:
-	  Added initscript for Ubuntu (posted by Paolo Martinelli)
-
-2006-09-14  wimpunk
-
-	* [r21] svn/Changelog, svn/ddclient: URL of zoneedit has changed
-	  (see bug #1558483)
-
-2006-06-14  wimpunk
-
-	* [r11] svn/Changelog, svn/ddclient: Changed version number
-	* [r8] ., html, svn, xml: Created trunk and tags, moved directories
-	  to it
-	* [r6] Changed the order of perl and update of README.ssl
-
-2006-06-11  ddfisher
-
-	* [r5] see Changelog
-
-2006-06-10  ddfisher
-
-	* [r4] updated changelog
-	* [r3] See Changelog
-
-2006-05-22  wimpunk
-
-	* [r2] Reorganise

Changelog.old

@@ -1,304 +0,0 @@
-Changelog
-3.7.3
-	* Changelog moved to more correct ChangeLog
-	  generated by svn2cl --group-by-day -i 
-	  See http://tinyurl.com/2fzhc6
-
-3.7.2
-	* Preventing unitialized values, check
-	https://sourceforge.net/forum/message.php?msg_id=4167772
-	* added a TODO list
-	* Removed the two empty lines at the end of ddclient
-	* Applied checked_ssl_load.diff from Ubuntu
-	* Cosmetic change about checkip
-	* Changed nic_namecheap_update following the suggestion of edmdude
-	on the forum (https://sourceforge.net/forum/message.php?msg_id=4316938)
-	* Applied easydns.patch
-	* 3com-oc-remote812 patch by The_Beast via IRC.
-	* Applied eurodns.patch
-
-3.7.1
-	* URL of zoneedit has changed (see bug #1558483)
-	* Added initscript for Ubuntu (posted by Paolo Martinelli)
-	* Added patch "Patch: Treat --daemon values as intervals"
-	(submitted by James deBoer)
-	* Don't send any mail when in not running daemon mode 
-	(patch submitted by Daniel Thaler)
-	* Changed Changelog syntax
-	* Applied patches submitted by Torsten:
-	abuse_msg.diff: ddclient still reports the email to contact dyndns.org
-	but they prefer a web form today (IIRC). This patch adjusts the abuse
-	warning printed by ddclient.
-	cachedir.diff: Original ddclient stores a cache file in /etc which
-	would belong in /var/cache in my opinion and according to the FHS.
-	help_nonroot.diff: Allow calling the help function as non-root.
-	update-new-config.patch: Force update if config has changed
-	smc-barricade-7401bra.patch: Support for SMC Barricade 7401BRA FW
-	firewall
-	cisco_fw.diff: Use configured hostname for firewall access
-	with -use=cisco (closes: #345712). Thanks to Per Carlson for the
-	patch!  See http://bugs.debian.org/345712.
-	maxinterval.diff: Increase max interval for updates.
-	See http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=129370
-	http://www.dyndns.com/support/services/dyndns/faq.html#q15
-	* Changed max-interval to 25days.  See
-	https://www.dyndns.com/services/dns/dyndns/faq.html
-
-
-3.7.0
-- Added vi tag
-- Added support for 2Wire 1701HG Gateway (see 
-  https://sourceforge.net/forum/message.php?msg_id=3496041 submitted by hemo)
-- added ssl-support by perlhaq
-- updated cvs version to 3.7.0-pre
-- added support for Linksys RV042, see feature requests #1501093, #1500877
-- added support for netgear-rp614, see feature request #1237039
-- added support for watchguard-edge-x, patch #1468981
-- added support for dlink-524, see patch #1314272
-- added support for rtp300
-- added support for netgear-wpn824
-- added support for linksys-wcg200, see patch #1280713
-- added support for netgear-dg834g, see patch #1176425
-- added support for netgear-wgt624, see patch #1165209
-- added support for sveasoft, see patch #1102432
-- added support for smc-barricade-7004vbr, see patch #1087989
-- added support for sitecom-dc202, see patch #1060119
-- fixed the error of stripping out '#' in the middle of password, bug #1465932
-- fixed a couple bugs in sample-etc_rc.d_init.d_ddclient and added some extra auto distro detection
-- added the validation of values when reading the configuration value.
-- this fixes a bug when trying to use periods/intervals in the daemon check times, bug #1209743
-- added timeout option to the IO::Socket call for timing out the initial connection, bug: #1085110
-
-3.6.7
-- modified sample-etc_rc.d_init.d_ddclient.lsb (bug #1231930)
-- support for ConCont Protocol (patch #1265128) submitted by seather_misery
-- problem with sending mail should be solved
-- corrected a few writing mistakes
-- support for 'NetComm NB3' adsl modem (submitted by crazyprog)
-- Added Sitelutions DynDNS, fixed minor Namecheap bug (patch #1346867)
-
-3.6.6
-- support for olitec-SX200 
-- added sample-etc_rc.d_init.d_ddclient.lsb as a sample script for lsb-compliant systems.
-- support for linksys wrt854g (thanks to Nick Triantos)
-- support for linksys ver 3 
-- support for Thomson (Alcatel) SpeedTouch 510 (thanks to Aldoir)
-- Cosmetic fixes submitted by John Owens
-
-3.6.5
-- there was a bug in the linksys-ver2
-- support for postscript (thanks to Larry Hendrickson)
-- Changelog out of README
-- modified all documentation to use /etc/ddclient/ddclient.conf (notified by 	nicolasmartin in bug [1070646]) 
-
-3.6.4
-- added support for NameCheap service (thanks to Dan Boardman)
-- added support for linksys ver2 (thanks to Dan Perik)
-
-3.6.3
-- renamed sample-etc_dhclient-enter-hooks to sample-etc_dhclient-exit-hooks
-- add support for the Allnet 1298 Router
-- add -a to ifconfig to query all interfaces (for Solaris and OpenBSD)
-- update the process status to reflect what is happening.
-- add a To: line when sending e-mail
-- add mail-failure to send mail on failures only
-- try all addresses for multihomed hosts (like check.dyndns.org)
-- add support for dnspark
-- add sample for OrgDNS.org
-
-3.6.2
-- add support for Xsense Aero
-- add support for Alcatel Speedtouch Pro
-- do authentication when either the login or password are defined.
-- fix parsing of web status pages
-
-- 3.6
-- add support for EasyDNS (see easydns.com)
-- add warning for possible incorrect continuation lines in the .conf file.
-- add if-skip with the default as was used before.
-- add cmd-skip. 
-
-- 3.5.4
-- added !active result code for DynDNS.org
-
-- 3.5.2
-- avoid undefined variable in get_ip
-
-- 3.5.1
-- fix parsing of quoted strings in .conf file
-- add filename and line number to any warnings regarding files.
-
-- 3.5
-- allow any url to be specified for -fw {address|url}
-  use -fw-skip {pattern} to specify a string preceding the IP address at the URL's page
-- allow any url to be specified for -web {address|url}
-  use -web-skip {pattern} to specify a string preceding the IP address at the URL's page
-- modify -test to display any IP addresses that could be obtained from 
-  any interfaces, builtin fw definitions, or web status pages.
-
-- 3.4.6 (not released)
-- fix errors in -help
-- allow non-FQDNs as hosts; dslreports requires this.
-- handle german ifconfig output
-- try to get english messages from ifconfig so other languages are handled too.
-- added support for com 3c886a 56k Lan Modem
-
-- 3.4.5
-- handle french ifconfig output
-
-- 3.4.4
-- added support for obtaining the IP address from a Cisco DHCP interface.
-  (Thanks, Tim)
-
-- 3.4.2
-- update last modified time when nochg is returned from dyndns
-- add example regarding fw-login and fw-password's required by some
-  home routers
-
-- 3.4.1
-- add option (-pid) to record process id in a file. This option should be 
-  defined in the .conf file as it is done in the sample.
-- add detection of SIGHUP. When this signal is received, ddclient will
-  wake up immediately, reload it's configuration file, and update
-  the IP addresses if necessary.
-
-- 3.4
-- ALL PEOPLE USING THIS CLIENT ARE URGED TO UPGRADE TO 3.4 or better.
-- fixed several timer related bugs.
-- reformatted some messages.
-
-- 3.3.8
-- added support for the ISDN channels on ELSA LANCOM DSL/10 router
-
-- 3.3.7
-- suppress repeated identical e-mail messages.
-
-- 3.3.6
-- added support for the ELSA LANCOM DSL/10 router
-- ignore 0.0.0.0 when obtained from any FW/router.
-
-- 3.3.5
-- fixed sample ddclient.conf.  fw-ip= should be fw=
-- fixed problem getting status pages for some routers
-
-- 3.3.4
-- added support for the MaxGate's UGATE-3x00 routers
-
-- 3.3.3
-- sample* correct checks for private addresses
-- add redhat specific sample-etc_rc.d_init.d_ddclient.redhat
-- make daemon-mode be the default when named ddclientd
-- added support for the Linksys BEF* Internet Routers
-
-- 3.3.2
-- (sample-etc_rc.d_init.d_ddclient) set COLUMNS to a large number so that
-  'ps -aef' will not prematurely truncate the CMD.
-
-- 3.3
-- added rpm (thanks to Bo Forslund)
-- added support for the Netgear RT3xx Internet Routers
-- modified sample-etc_rc.d_init.d_ddclient to work with other Unix beside RedHat.
-- avoid rewritting the ddclient.cache file unnecessarily
-- fixed other minor bugs
-
-- 3.2.0
-- add support for DynDNS's custom domain service.
-- change suggested directory to /usr/sbin
-
-- 3.1.0
-- clean up; fix minor bugs.
-- removed -refresh
-- add min-interval       to avoid too frequent update attempts.
-- add min-error-interval to avoid too frequent update attempts when the 
-  service is unavailable.
-
-- 3.0.1
-- make all values case sensitive (ie. passwords)
-
-- 3.0
-- new release!
-- new ddclient.conf format
-- rewritten to support DynDNS's NIC2 and other dynamic DNS services
--   added Hammernode (hn.org)
--   added ZoneEdit (zoneedit.com)
--   added DSLreports (dslreports.com) host monitoring
-- added support for obtaining IP addresses from 
--	interfaces,
--	commands,
--	web,
--       external commands,
--	Watchguard's SOHO router
--   	Netopia's R910 router
--   and SMC's Barracade
-- added daemon mode
-- added logging msgs to syslog and e-mail
-
-- 2.3.7
-- add -refresh to the sample scripts so default arguments are obtained from the cache
-- added local-ip script for obtaining the address of an interface
-- added public-ip script for obtaining the ip address as seen from a public web page
-
-- 2.3.6
-- fixed bug the broke enabling retrying when members.dyndns.org was down.
-
-- 2.3.5
-- prevent warnings from earlier versions of Perl.
-
-- 2.3.4
-- added sample-etc_dhclient-enter-hooks for those using the ISC DHCP client (dhclient)
-
-- 2.3.3
-- make sure that ddclient.conf is only readable by the owner so that no one
-- else can see the password (courtesy of Steve Greenland).
--- NOTE: you will need to change the permissions on ddclient.conf to prevent
--- others from obtaining viewing your password.
---	ie. chmod go-rwx /etc/ddclient.conf
-
-- 2.3.2
-- make sure 'quiet' messages are printed when -verbose or -debug is enabled
-- fix error messages for those people using proxies.
-
-- 2.3
-- fixed a problem reading in cached entries
-
-
-- 2.2.1
-- sample-etc_ppp_ip-up.local - local ip address is $4 or $PPP_LOCAL (for debian)
-- use <CR><LF> as the line terminator (some proxies are strict about this)
-
-- 2.2
-- added support (-static) for updating static DNS (thanks Marc Sira)
-- changed ddclient.cache format (old style is still read)
-- sample-etc_ppp_ip-up.local - detect improper calling sequences
-- sample-etc_ppp_ip-up.local - local ip address is $3 or $PPP_LOCAL (for debian)
-
-- 2.1.2
-- updated README
-
-- 2.1.1
-- make sure result code reflects any failures
-- optionally (-quiet) omit messages for unnecessary updates
-- update sample-etc_cron.d_ddclient to use -quiet
-
-- 2.1
-- avoid unnecessary updates by recording the last hosts updated in a 
-  cache file (default /etc/ddclient.cache)
-
-- optionally (-force) force an update, even if it may be unnecessary. 
-
-  This can be used to prevent dyndns.org from deleting a host that has not 
-  required an update for a long period of time.
-
-- optionally (-refresh), reissue all host updates.
-
-  This can be used together with cron to periodically update DynDNS. 
-  See sample-etc-cron.d-ddclient for details.
-
-- optionally (-retry) save failed updates for future processing.
-
-  This feature can be used to reissue updates that may have failed due to
-  network connectivity problems or a DynDNS server outage
-
--------------------------------------------------------------------------------
-$Id: Changelog 96 2008-06-13 20:24:24Z wimpunk $
-------------------------------------------------------------------------

Makefile.am

@@ -0,0 +1,165 @@
+ACLOCAL_AMFLAGS = -I build-aux/m4
+EXTRA_DIST = \
+	CONTRIBUTING.md \
+	COPYING \
+	COPYRIGHT \
+	ChangeLog.md \
+	README.cisco \
+	README.md \
+	autogen \
+	sample-ddclient-wrapper.sh \
+	sample-etc_cron.d_ddclient \
+	sample-etc_dhclient-exit-hooks \
+	sample-etc_dhcpc_dhcpcd-eth0.exe \
+	sample-etc_ppp_ip-up.local \
+	sample-etc_systemd.service \
+	sample-get-ip-from-fritzbox
+CLEANFILES =
+
+subst_files = ddclient ddclient.conf
+EXTRA_DIST += $(subst_files:=.in)
+CLEANFILES += $(subst_files)
+
+$(subst_files): Makefile
+	rm -f '$@' '$@'.tmp
+	in='$@'.in; \
+		test -f "$${in}" || in='$(srcdir)/'$${in}; \
+		sed \
+			-e 's|@PACKAGE_VERSION[@]|$(PACKAGE_VERSION)|g' \
+			-e '1 s|^#\!.*perl$$|#\!$(PERL)|g' \
+			-e 's|@localstatedir[@]|$(localstatedir)|g' \
+			-e 's|@confdir[@]|$(confdir)|g' \
+			-e 's|@runstatedir[@]|$(runstatedir)|g' \
+			-e 's|@CURL[@]|$(CURL)|g' \
+			"$${in}" >'$@'.tmp && \
+		{ ! test -x "$${in}" || chmod +x '$@'.tmp; }
+	mv '$@'.tmp '$@'
+
+ddclient: $(srcdir)/ddclient.in
+ddclient.conf: $(srcdir)/ddclient.conf.in
+
+bin_SCRIPTS = ddclient
+
+conf_DATA = ddclient.conf
+
+install-data-local:
+	$(MKDIR_P) '$(DESTDIR)$(localstatedir)'/cache/ddclient
+
+AM_TESTS_ENVIRONMENT = \
+	abs_top_srcdir='$(abs_top_srcdir)'; export abs_top_srcdir;
+LOG_DRIVER = env AM_TAP_AWK='$(AWK)' $(SHELL) \
+	$(top_srcdir)/build-aux/tap-driver.sh
+TEST_EXTENSIONS = .pl
+PL_LOG_DRIVER = $(LOG_DRIVER)
+PL_LOG_COMPILER = $(PERL)
+AM_PL_LOG_FLAGS = -Mstrict -w \
+	-I'$(abs_top_builddir)' \
+	-I'$(abs_top_srcdir)'/t/lib \
+	-MDevel::Autoflush
+handwritten_tests = \
+	t/builtinfw_query.pl \
+	t/check_value.pl \
+	t/get_ip_from_if.pl \
+	t/geturl_connectivity.pl \
+	t/geturl_response.pl \
+	t/group_hosts_by.pl \
+	t/header_ok.pl \
+	t/interval_expired.pl \
+	t/is-and-extract-ipv4.pl \
+	t/is-and-extract-ipv6.pl \
+	t/is-and-extract-ipv6-global.pl \
+	t/logmsg.pl \
+	t/parse_assignments.pl \
+	t/protocol_directnic.pl \
+	t/protocol_dnsexit2.pl \
+	t/protocol_dyndns2.pl \
+	t/read_recap.pl \
+	t/skip.pl \
+	t/ssl-validate.pl \
+	t/update_nics.pl \
+	t/use_cmd.pl \
+	t/use_web.pl \
+	t/variable_defaults.pl \
+	t/write_recap.pl
+generated_tests = \
+	t/version.pl
+TESTS = $(handwritten_tests) $(generated_tests)
+$(TESTS): ddclient
+EXTRA_DIST += $(handwritten_tests) \
+	.autom4te.cfg \
+	t/lib/Devel/Autoflush.pm \
+	t/lib/Test/Builder.pm \
+	t/lib/Test/Builder/Formatter.pm \
+	t/lib/Test/Builder/IO/Scalar.pm \
+	t/lib/Test/Builder/Module.pm \
+	t/lib/Test/Builder/Tester.pm \
+	t/lib/Test/Builder/Tester/Color.pm \
+	t/lib/Test/Builder/TodoDiag.pm \
+	t/lib/Test/More.pm \
+	t/lib/Test/Simple.pm \
+	t/lib/Test/Tester.pm \
+	t/lib/Test/Tester/Capture.pm \
+	t/lib/Test/Tester/CaptureRunner.pm \
+	t/lib/Test/Tester/Delegate.pm \
+	t/lib/Test/use/ok.pm \
+	t/lib/Test2.pm \
+	t/lib/Test2/API.pm \
+	t/lib/Test2/API/Breakage.pm \
+	t/lib/Test2/API/Context.pm \
+	t/lib/Test2/API/Instance.pm \
+	t/lib/Test2/API/Stack.pm \
+	t/lib/Test2/Event.pm \
+	t/lib/Test2/Event/Bail.pm \
+	t/lib/Test2/Event/Diag.pm \
+	t/lib/Test2/Event/Encoding.pm \
+	t/lib/Test2/Event/Exception.pm \
+	t/lib/Test2/Event/Fail.pm \
+	t/lib/Test2/Event/Generic.pm \
+	t/lib/Test2/Event/Note.pm \
+	t/lib/Test2/Event/Ok.pm \
+	t/lib/Test2/Event/Pass.pm \
+	t/lib/Test2/Event/Plan.pm \
+	t/lib/Test2/Event/Skip.pm \
+	t/lib/Test2/Event/Subtest.pm \
+	t/lib/Test2/Event/TAP/Version.pm \
+	t/lib/Test2/Event/V2.pm \
+	t/lib/Test2/Event/Waiting.pm \
+	t/lib/Test2/EventFacet.pm \
+	t/lib/Test2/EventFacet/About.pm \
+	t/lib/Test2/EventFacet/Amnesty.pm \
+	t/lib/Test2/EventFacet/Assert.pm \
+	t/lib/Test2/EventFacet/Control.pm \
+	t/lib/Test2/EventFacet/Error.pm \
+	t/lib/Test2/EventFacet/Hub.pm \
+	t/lib/Test2/EventFacet/Info.pm \
+	t/lib/Test2/EventFacet/Info/Table.pm \
+	t/lib/Test2/EventFacet/Meta.pm \
+	t/lib/Test2/EventFacet/Parent.pm \
+	t/lib/Test2/EventFacet/Plan.pm \
+	t/lib/Test2/EventFacet/Render.pm \
+	t/lib/Test2/EventFacet/Trace.pm \
+	t/lib/Test2/Formatter.pm \
+	t/lib/Test2/Formatter/TAP.pm \
+	t/lib/Test2/Hub.pm \
+	t/lib/Test2/Hub/Interceptor.pm \
+	t/lib/Test2/Hub/Interceptor/Terminator.pm \
+	t/lib/Test2/Hub/Subtest.pm \
+	t/lib/Test2/IPC.pm \
+	t/lib/Test2/IPC/Driver.pm \
+	t/lib/Test2/IPC/Driver/Files.pm \
+	t/lib/Test2/Tools/Tiny.pm \
+	t/lib/Test2/Util.pm \
+	t/lib/Test2/Util/ExternalMeta.pm \
+	t/lib/Test2/Util/Facets2Legacy.pm \
+	t/lib/Test2/Util/HashBase.pm \
+	t/lib/Test2/Util/Trace.pm \
+	t/lib/ddclient/Test/Fake/HTTPD.pm \
+	t/lib/ddclient/Test/Fake/HTTPD/dummy-ca-cert.pem \
+	t/lib/ddclient/Test/Fake/HTTPD/dummy-server-cert.pem \
+	t/lib/ddclient/Test/Fake/HTTPD/dummy-server-key.pem \
+	t/lib/ddclient/Test/Fake/HTTPD/other-ca-cert.pem \
+	t/lib/ddclient/t.pm \
+	t/lib/ddclient/t/HTTPD.pm \
+	t/lib/ddclient/t/Logger.pm \
+	t/lib/ddclient/t/ip.pm \
+	t/lib/ok.pm

README.cisco

@@ -1,4 +1,3 @@
-$Id: README.cisco 96 2008-06-13 20:24:24Z wimpunk $
 Method 1 ------------------------------------------------------
 
 The following config will allow the Linux machine (10.1.1.2) to read

README.md

@@ -1,128 +1,254 @@
-===============================================================================
-# DDCLIENT v3.8.2
+# DDCLIENT
 
-ddclient is a Perl client used to update dynamic DNS entries for accounts
-on many dynamic DNS services.
+`ddclient` is a Perl client used to update dynamic DNS entries for accounts
+on many dynamic DNS services. It uses `curl` for internet access.
 
-===============================================================================
+on docker compose
+```docker-compose
+services:
+  ddclient:
+    image: lscr.io/linuxserver/ddclient:latest
+    container_name: ddclient
+    environment:
+      - PUID=1000
+      - PGID=1000
+      - TZ=Europe/Rome
+    volumes:
+      - /home/orangepi/dockerfiles/ddclient/config:/config
+    restart: unless-stopped
+```
+file ddclient.conf per servizio DDNS di dynu.com da mettere nel folder config
+```file
+daemon=60                               # check every 300 seconds
+syslog=yes                              # log update msgs to syslog
+mail=root                               # mail all msgs to root#mail-failure=root           # mail failed update msgs to root
+pid=/var/run/ddclient/ddclient.pid      # record PID in file.
+use=web, web=checkip.dynu.com/, web-skip='IP Address'
+protocol=dyndns2                        # default protocol
+server=api.dynu.com
+# default login
+login=FabioMich66                       # your default user
+password=Master66!                      # your default password
+wildcard=yes   
+patachina.casacam.net
+```
+
+## Alternatives
+
+You might also want to consider using one of the following, if they support
+your dynamic DNS provider(s): <https://github.com/troglobit/inadyn> or
+<https://github.com/lopsided98/dnsupdate>.
+
+## Supported services
 
 Dynamic DNS services currently supported include:
 
-    DynDNS.com  - See http://www.dyndns.com for details on obtaining a free account.
-    Hammernode  - See http://www.hn.org for details on obtaining a free account.
-    Zoneedit    - See http://www.zoneedit.com for details.
-    EasyDNS     - See http://www.easydns.com for details.
-    NameCheap   - See http://www.namecheap.com for details
-    ConCont     - See http://www.dydns.za.net for details
-    DnsPark     - See http://www.dnspark.com for details
-    DslReports  - See http://www.dslreports.com for details
-    Sitelutions - See http://www.sitelutions.com for details
-    Loopia      - See http://www.loopia.se for details
-    Noip        - See http://www.noip.com/ for details
-    Freedns     - See http://freedns.afraid.org/ for details
-    ChangeIP    - See http://www.changeip.com/ for details
-    dtdns       - See http://www.dtdns.com/ for details
-    nsupdate    - See nsupdate(1) and ddns-confgen(8) for details
-    CloudFlare  - See https://www.cloudflare.com/ for details
-    Google      - See http://www.google.com/domains for details
-    Duckdns      - See https://duckdns.org/ for details
+  * [1984.is](https://www.1984.is/product/freedns)
+  * [ChangeIP](https://www.changeip.com)
+  * [CloudFlare](https://www.cloudflare.com)
+  * [ClouDNS](https://www.cloudns.net)
+  * [DDNS.fm](https://www.ddns.fm/)
+  * [DigitalOcean](https://www.digitalocean.com/)
+  * [dinahosting](https://dinahosting.com)
+  * [Directnic](https://directnic.com)
+  * [DonDominio](https://www.dondominio.com)
+  * [DNS Made Easy](https://dnsmadeeasy.com)
+  * [DNSExit](https://dnsexit.com/dns/dns-api)
+  * [dnsHome.de](https://www.dnshome.de)
+  * [Domeneshop](https://api.domeneshop.no/docs/#tag/ddns/paths/~1dyndns~1update/get)
+  * [DslReports](https://www.dslreports.com)
+  * [Duck DNS](https://duckdns.org)
+  * [DynDNS.com](https://account.dyn.com)
+  * [EasyDNS](https://www.easydns.com )
+  * [Enom](https://www.enom.com)
+  * [Freedns](https://freedns.afraid.org)
+  * [Freemyip](https://freemyip.com)
+  * [Gandi](https://gandi.net)
+  * [GoDaddy](https://www.godaddy.com)
+  * [Hurricane Electric](https://dns.he.net)
+  * [Infomaniak](https://faq.infomaniak.com/2376)
+  * [INWX](https://www.inwx.com/)
+  * [Loopia](https://www.loopia.se)
+  * [Mythic Beasts](https://www.mythic-beasts.com/support/api/dnsv2/dynamic-dns)
+  * [NameCheap](https://www.namecheap.com)
+  * [NearlyFreeSpeech.net](https://www.nearlyfreespeech.net/services/dns)
+  * [Njalla](https://njal.la/docs/ddns)
+  * [Noip](https://www.noip.com)
+  * nsupdate - see nsupdate(1) and ddns-confgen(8)
+  * [OVH](https://www.ovhcloud.com)
+  * [Porkbun](https://porkbun.com)
+  * [regfish.de](https://www.regfish.de/domains/dyndns)
+  * [Sitelutions](https://www.sitelutions.com)
+  * [Yandex](https://dns.yandex.com)
+  * [Zoneedit](https://www.zoneedit.com)
 
-DDclient now supports many of cable/dsl broadband routers. 
+`ddclient` supports finding your IP address from many cable and DSL
+broadband routers.
 
-Comments, suggestions and requests: use the forums on 
-	http://sourceforge.net/projects/ddclient/
+Comments, suggestions and requests: please file an issue at
+https://github.com/ddclient/ddclient/issues/new
 
-The code was originally written by Paul Burry and is now hosted and maintained  
-through sourceforge.net. Please check out http://ddclient.sf.net
+The code was originally written by Paul Burry and is now hosted and
+maintained through github.com. Please check out https://ddclient.net
 
--------------------------------------------------------------------------------
-REQUIREMENTS:
+## REQUIREMENTS
 
-- one or more accounts from one of the dynamic DNS services
+  * An account from a supported dynamic DNS service provider
+  * Perl v5.10.1 or later
+      * `JSON::PP` perl library for JSON support
+  * Linux, macOS, or any other Unix-ish system
+  * An implementation of `make` (such as [GNU
+    Make](https://www.gnu.org/software/make/))
+  * If you are installing from a clone of the Git repository, you will
+    also need [GNU Autoconf](https://www.gnu.org/software/autoconf/)
+    and [GNU Automake](https://www.gnu.org/software/automake/).
 
-- Perl 5.014 or later
-  (you need the IO::Socket::SSL perl library for ssl-support
-  and JSON::Any perl library for JSON support)
+## DOWNLOAD
 
-- Linux or probably any common Unix system
+See https://github.com/ddclient/ddclient/releases
 
--------------------------------------------------------------------------------
-INSTALLATION:
+## INSTALLATION
 
-    cp ddclient /usr/sbin/
-    mkdir /etc/ddclient
-    mkdir /var/cache/ddclient
-    cp sample-etc_ddclient.conf /etc/ddclient/ddclient.conf
-    vi /etc/ddclient/ddclient.conf
-    -- and change hostnames, logins, and passwords appropriately
+### Distribution Package
 
-    ## For those using Redhat style rc files and using daemon-mode:
-    cp sample-etc_rc.d_init.d_ddclient /etc/rc.d/init.d/ddclient
-    ## enable automatic startup when booting
-    ## check your distribution
-    /sbin/chkconfig --add ddclient
-    ## start the first time by hand
-    /etc/rc.d/init.d/ddclient start
+<a href="https://repology.org/project/ddclient/versions">
+  <img src="https://repology.org/badge/vertical-allrepos/ddclient.svg" alt="Packaging status" align="right">
+</a>
+The easiest way to install ddclient is to install a package offered by your
+operating system. See the image to the right for a list of distributions with a ddclient package.
 
-    ## For those using Alpine style rc files and using daemon-mode:
-    cp sample-etc_rc.d_init.d_ddclient.alpine /etc/init.d/ddclient
-    ## enable automatic startup when booting
-    rc-update add ddclient
-    ## make sure you have perl installed 
-    apk add perl
-    ## start the first time by hand
-    rc-service ddclient start
+### Manual Installation
 
-    ## If you are not using daemon-mode, configure cron and dhcp or ppp
-    ## as described below.
+  1. Extract the distribution tarball (`.tar.gz` file) and `cd` into
+     the directory:
 
--------------------------------------------------------------------------------
-TROUBLESHOOTING:
+     ```shell
+     tar xvfa ddclient-3.XX.X.tar.gz
+     cd ddclient-3.XX.X
+     ```
 
-  1. enable debugging and verbose messages.
-	 ``$ ddclient -daemon=0 -debug -verbose -noquiet``
+     (If you are installing from a clone of the Git repository, you
+     must run `./autogen` before continuing to the next step.)
 
-  2. Do you need to specify a proxy?
-     If so, just add a
-	``proxy=your.isp.proxy``
-     to the ddclient.conf file.
+  2. Run the following commands to build and install:
 
-  3. Define the IP address of your router with ``fw=xxx.xxx.xxx.xxx`` in
-     ``/etc/ddclient/ddclient.conf`` and then try
-    	``$ ddclient -daemon=0 -query``
-     to see if the router status web page can be understood.
+     ```shell
+     ./configure \
+         --prefix=/usr \
+         --sysconfdir=/etc \
+         --localstatedir=/var
+     make
+     make VERBOSE=1 check
+     sudo make install
+     ```
 
-  4. Need support for another router/firewall?
-     Define the router status page yourself with:
-	``fw=url-to-your-router``'s-status-page
-	``fw-skip=any-string-preceding-your-IP-address``
+  3. Edit `/etc/ddclient/ddclient.conf`.
 
-     ddclient does something like this to provide builtin support for 
-     common routers.
-     For example, the Linksys routers could have been added with:
-     
-        fw=192.168.1.1/Status.htm
-	    fw-skip=WAN.*?IP Address
+#### systemd
 
-     OR
-     Send me the output from:
-      $ ddclient -geturl {fw-ip-status-url} [-login login [-password password]]
-     and I'll add it to the next release!
+    cp sample-etc_systemd.service /etc/systemd/system/ddclient.service
 
-     ie. for my fw/router I used:
-	$ ddclient -geturl 192.168.1.254/status.htm
+enable automatic startup when booting
 
-  5. Some broadband routers require the use of a password when ddclient
-     accesses its status page to determine the router's WAN IP address.
-     If this is the case for your router, add
-	fw-login=your-router-login
-	fw-password=your-router-password
-     to the beginning of your ddclient.conf file.
-     Note that some routers use either 'root' or 'admin' as their login
-     while some others accept anything.
+    systemctl enable ddclient.service
 
--------------------------------------------------------------------------------
-USING DDCLIENT WITH ppp
+start the first time by hand
+
+    systemctl start ddclient.service
+
+## Known issues
+This is a list for quick referencing of known issues. For further details check out the linked issues and the changelog.
+
+Note that any issues prior to version v3.9.1 will not be listed here.
+If a fix is committed but not yet part of any tagged release, the notes here will reference the not-yet-released version number.
+
+### v3.11.2 - v3.9.1: SSL parameter breaks HTTP-only IP acquisition
+
+The `ssl` parameter forces all connections to use HTTPS.  While technically
+working as expected, this behavior keeps coming up as a pain point when using
+HTTP-only IP querying sites such as http://checkip.dyndns.org.  Starting with
+v4.0.0, the behavior is changed to respect `http://` in a URL.  A separate
+parameter to disallow all HTTP connections or warn about them may be added
+later.
+
+**Fix**: v4.0.0 uses HTTP to connect to URLs starting with `http://`.  See
+[here](https://github.com/ddclient/ddclient/pull/608) for more info.
+
+**Workaround**: Disable the SSL parameter
+
+### v3.10.0: Chunked encoding not corretly supported in IO::Socket HTTP code
+Using the IO::Socket HTTP code will break in various ways whenever the server responds using HTTP 1.1 chunked encoding. Refer to [this issue](https://github.com/ddclient/ddclient/issues/548) for more info.
+
+**Fix**: v3.11.0 - IO::Socket has been deprecated there and curl has been made the standard.
+
+**Workaround**: Use curl for transfers by either setting `-curl` in the command line or by adding `curl=yes` in the config
+
+### v3.10.0: Spammed updates to some providers
+This issue arises when using the `use` parameter in the config and using one of these providers:
+- Cloudflare
+- Hetzner
+- Digitalocean
+- Infomaniak
+
+**Fix**: v3.11.2
+
+**Workaround**: Use the `usev4`/`usev6` parameters instead of `use`.
+
+
+## TROUBLESHOOTING
+
+  * Enable debugging and verbose messages: `ddclient --daemon=0 --debug --verbose`
+
+  * Do you need to specify a proxy?
+    If so, just add a `proxy=your.isp.proxy` to the `ddclient.conf` file.
+
+  * Define the IP address of your router with `fwv4=xxx.xxx.xxx.xxx` in
+    `/etc/ddclient/ddclient.conf` and then try `$ ddclient --daemon=0 --query`
+    to see if the router status web page can be understood.
+
+  * Need support for another router/firewall?
+    Define the router yourself with:
+
+    ```
+    usev4=fwv4
+    fwv4=url-to-your-router-status-page
+    fwv4-skip="regular expression matching any string preceding your IP address, if necessary"
+    ```
+
+    ddclient does something like this to provide builtin support for common
+    routers.
+    For example, the Linksys routers could have been added with:
+
+    ```
+    usev4=fwv4
+    fwv4=192.168.1.1/Status.htm
+    fwv4-skip=WAN.*?IP Address
+    ```
+
+    OR [create a new issue](https://github.com/ddclient/ddclient/issues/new)
+    containing the output from:
+
+    ```
+    curl --include --location http://url.of.your.firewall/ip-status-page
+    ```
+
+    so that we can add a new firewall definition to a future release of
+    ddclient.
+
+  * Some broadband routers require the use of a password when ddclient accesses
+    its status page to determine the router's WAN IP address.
+    If this is the case for your router, add
+
+    ```
+    fw-login=your-router-login
+    fw-password=your-router-password
+    ```
+
+    to the beginning of your ddclient.conf file.
+    Note that some routers use either 'root' or 'admin' as their login while
+    some others accept anything.
+
+## USING DDCLIENT WITH `ppp`
 
 If you are using a ppp connection, you can easily update your DynDNS
 entry with each connection, with:
@@ -133,8 +259,7 @@ entry with each connection, with:
 Alternatively, you may just configure ddclient to operate as a daemon
 and monitor your ppp interface.
 
--------------------------------------------------------------------------------
-USING DDCLIENT WITH cron
+## USING DDCLIENT WITH `cron`
 
 If you have not configured ddclient to use daemon-mode, you'll need to
 configure cron to force an update once a month so that the dns entry will
@@ -144,43 +269,41 @@ not become stale.
     cp sample-etc_cron.d_ddclient /etc/cron.d/ddclient
     vi /etc/cron.d/ddclient
 
--------------------------------------------------------------------------------
-USING DDCLIENT WITH dhcpcd-1.3.17
+## USING DDCLIENT WITH `dhcpcd`
 
 If you are using dhcpcd-1.3.17 or thereabouts, you can easily update
 your DynDNS entry automatically every time your lease is obtained
 or renewed by creating an executable file named:
-    /etc/dhcpc/dhcpcd-{your-interface}.exe
+    ``/etc/dhcpc/dhcpcd-{your-interface}.exe``
 ie.:
-    cp sample-etc_dhcpc_dhcpcd-eth0.exe /etc/dhcpc/dhcpcd-{your-interface}.exe
+    ``cp sample-etc_dhcpc_dhcpcd-eth0.exe /etc/dhcpc/dhcpcd-{your-interface}.exe``
 
 In my case, it is named dhcpcd-eth0.exe and contains the lines:
 
-    #!/bin/sh
-    PATH=/usr/sbin:/root/bin:${PATH}
-    logger -t dhcpcd IP address changed to $1
-    ddclient -proxy fasthttp.sympatico.ca -wildcard -ip $1 | logger -t ddclient 
-    exit 0
+```shell
+#!/bin/sh
+PATH=/usr/bin:/root/bin:${PATH}
+logger -t dhcpcd IP address changed to $1
+ddclient --proxy fasthttp.sympatico.ca --wildcard --ip $1 | logger -t ddclient
+exit 0
+```
 
 Other DHCP clients may have another method of calling out to programs
-for updating DNS entries. 
+for updating DNS entries.
 
 Alternatively, you may just configure ddclient to operate as a daemon
 and monitor your ethernet interface.
 
--------------------------------------------------------------------------------
-USING DDCLIENT WITH dhclient
+## USING DDCLIENT WITH `dhclient`
 
-If you are using the ISC DHCP client (dhclient), you can update 
+If you are using the ISC DHCP client (dhclient), you can update
 your DynDNS entry automatically every time your lease is obtained
 or renewed by creating an executable file named:
-    /etc/dhclient-exit-hooks
+    ``/etc/dhclient-exit-hooks``
 ie.:
-    cp sample-etc_dhclient-exit-hooks /etc/dhclient-exit-hooks
+    ``cp sample-etc_dhclient-exit-hooks /etc/dhclient-exit-hooks``
 
-Edit /etc/dhclient-exit-hooks to change any options required.
+Edit ``/etc/dhclient-exit-hooks`` to change any options required.
 
 Alternatively, you may just configure ddclient to operate as a daemon
 and monitor your ethernet interface.
-
--------------------------------------------------------------------------------

README.ssl

@@ -1,10 +0,0 @@
-Since 3.7.0, ddclient support ssl-updates
-To use ssl, put "ssl=yes" in your configuration and make sure
-you have IO::Socket::SSL.
-
-On debian, you need libio-socket-ssl-perl to have IO::Socket::SSL
-
-On alpine, you need perl-io-socket-ssl to have IO::Socket::SSL
-
-ssl support is tested on folowing dynamic dns providers:
-- dyndns.com

RELEASENOTE

@@ -1,12 +0,0 @@
-Yet again it's been a while but here is new release of ddclient. As usual,
-there are some important changes and some documentation is modified.
-A detailed overview can be found in ChangeLog but here's a quick overview:
-
-	* added Alpine Linux init scritp - patch send by @Tal on github.
-	* adding support for nsupdate - patch send by @droe on github
-	* allow log username-password combinations - patch send by @dirdi on github
-	* adding support for cloudflare - patch send by @roberthawdon on github
-	* adding support for duckdns - patch send by @gkranis
-
-A very big thank you for everyone who created a pull request on github and
-for everyone who helped to fix the little issues caused by the new providers.

TODO

@@ -1,14 +0,0 @@
-* ssl: 
-	- check if the library can be used
-	- ssl on routers
-	- ssl on other providers
-
-* notice about irc: there's almost always someone there but we're sometimes idle
-or at work...
-* adding router: halted, only in patches section.
-* add doc postscript 
-* FAQ: bad hostname (checkip)
-* note about init-scripts.
-* request from dyndns: http://tinyurl.com/2l3twf
-
-* check bugs

autogen

@@ -0,0 +1,22 @@
+#!/bin/sh
+
+pecho() { printf %s\\n "$*"; }
+log() { pecho "$@"; }
+error() { log "ERROR: $@" >&2; }
+fatal() { error "$@"; exit 1; }
+try() { "$@" || fatal "'$@' failed"; }
+
+try cd "${0%/*}"
+# aclocal complains if a directory passed to AC_CONFIG_MACRO_DIR doesn't exist.
+try mkdir -p build-aux/m4
+# autoreconf's '--force' option doesn't affect any of the files installed by the '--install' option.
+# Remove the files to truly force them to be updated.
+try rm -f \
+    aclocal.m4 \
+    build-aux/config.guess \
+    build-aux/config.sub \
+    build-aux/install-sh \
+    build-aux/missing \
+    build-aux/tap-driver.sh \
+    ;
+try autoreconf -fviW all

build-aux/m4/ax_compare_version.m4

@@ -0,0 +1,177 @@
+# ===========================================================================
+#    https://www.gnu.org/software/autoconf-archive/ax_compare_version.html
+# ===========================================================================
+#
+# SYNOPSIS
+#
+#   AX_COMPARE_VERSION(VERSION_A, OP, VERSION_B, [ACTION-IF-TRUE], [ACTION-IF-FALSE])
+#
+# DESCRIPTION
+#
+#   This macro compares two version strings. Due to the various number of
+#   minor-version numbers that can exist, and the fact that string
+#   comparisons are not compatible with numeric comparisons, this is not
+#   necessarily trivial to do in a autoconf script. This macro makes doing
+#   these comparisons easy.
+#
+#   The six basic comparisons are available, as well as checking equality
+#   limited to a certain number of minor-version levels.
+#
+#   The operator OP determines what type of comparison to do, and can be one
+#   of:
+#
+#    eq  - equal (test A == B)
+#    ne  - not equal (test A != B)
+#    le  - less than or equal (test A <= B)
+#    ge  - greater than or equal (test A >= B)
+#    lt  - less than (test A < B)
+#    gt  - greater than (test A > B)
+#
+#   Additionally, the eq and ne operator can have a number after it to limit
+#   the test to that number of minor versions.
+#
+#    eq0 - equal up to the length of the shorter version
+#    ne0 - not equal up to the length of the shorter version
+#    eqN - equal up to N sub-version levels
+#    neN - not equal up to N sub-version levels
+#
+#   When the condition is true, shell commands ACTION-IF-TRUE are run,
+#   otherwise shell commands ACTION-IF-FALSE are run. The environment
+#   variable 'ax_compare_version' is always set to either 'true' or 'false'
+#   as well.
+#
+#   Examples:
+#
+#     AX_COMPARE_VERSION([3.15.7],[lt],[3.15.8])
+#     AX_COMPARE_VERSION([3.15],[lt],[3.15.8])
+#
+#   would both be true.
+#
+#     AX_COMPARE_VERSION([3.15.7],[eq],[3.15.8])
+#     AX_COMPARE_VERSION([3.15],[gt],[3.15.8])
+#
+#   would both be false.
+#
+#     AX_COMPARE_VERSION([3.15.7],[eq2],[3.15.8])
+#
+#   would be true because it is only comparing two minor versions.
+#
+#     AX_COMPARE_VERSION([3.15.7],[eq0],[3.15])
+#
+#   would be true because it is only comparing the lesser number of minor
+#   versions of the two values.
+#
+#   Note: The characters that separate the version numbers do not matter. An
+#   empty string is the same as version 0. OP is evaluated by autoconf, not
+#   configure, so must be a string, not a variable.
+#
+#   The author would like to acknowledge Guido Draheim whose advice about
+#   the m4_case and m4_ifvaln functions make this macro only include the
+#   portions necessary to perform the specific comparison specified by the
+#   OP argument in the final configure script.
+#
+# LICENSE
+#
+#   Copyright (c) 2008 Tim Toolan <toolan@ele.uri.edu>
+#
+#   Copying and distribution of this file, with or without modification, are
+#   permitted in any medium without royalty provided the copyright notice
+#   and this notice are preserved. This file is offered as-is, without any
+#   warranty.
+
+#serial 13
+
+dnl #########################################################################
+AC_DEFUN([AX_COMPARE_VERSION], [
+  AC_REQUIRE([AC_PROG_AWK])
+
+  # Used to indicate true or false condition
+  ax_compare_version=false
+
+  # Convert the two version strings to be compared into a format that
+  # allows a simple string comparison.  The end result is that a version
+  # string of the form 1.12.5-r617 will be converted to the form
+  # 0001001200050617.  In other words, each number is zero padded to four
+  # digits, and non digits are removed.
+  AS_VAR_PUSHDEF([A],[ax_compare_version_A])
+  A=`echo "$1" | sed -e 's/\([[0-9]]*\)/Z\1Z/g' \
+                     -e 's/Z\([[0-9]]\)Z/Z0\1Z/g' \
+                     -e 's/Z\([[0-9]][[0-9]]\)Z/Z0\1Z/g' \
+                     -e 's/Z\([[0-9]][[0-9]][[0-9]]\)Z/Z0\1Z/g' \
+                     -e 's/[[^0-9]]//g'`
+
+  AS_VAR_PUSHDEF([B],[ax_compare_version_B])
+  B=`echo "$3" | sed -e 's/\([[0-9]]*\)/Z\1Z/g' \
+                     -e 's/Z\([[0-9]]\)Z/Z0\1Z/g' \
+                     -e 's/Z\([[0-9]][[0-9]]\)Z/Z0\1Z/g' \
+                     -e 's/Z\([[0-9]][[0-9]][[0-9]]\)Z/Z0\1Z/g' \
+                     -e 's/[[^0-9]]//g'`
+
+  dnl # In the case of le, ge, lt, and gt, the strings are sorted as necessary
+  dnl # then the first line is used to determine if the condition is true.
+  dnl # The sed right after the echo is to remove any indented white space.
+  m4_case(m4_tolower($2),
+  [lt],[
+    ax_compare_version=`echo "x$A
+x$B" | sed 's/^ *//' | sort -r | sed "s/x${A}/false/;s/x${B}/true/;1q"`
+  ],
+  [gt],[
+    ax_compare_version=`echo "x$A
+x$B" | sed 's/^ *//' | sort | sed "s/x${A}/false/;s/x${B}/true/;1q"`
+  ],
+  [le],[
+    ax_compare_version=`echo "x$A
+x$B" | sed 's/^ *//' | sort | sed "s/x${A}/true/;s/x${B}/false/;1q"`
+  ],
+  [ge],[
+    ax_compare_version=`echo "x$A
+x$B" | sed 's/^ *//' | sort -r | sed "s/x${A}/true/;s/x${B}/false/;1q"`
+  ],[
+    dnl Split the operator from the subversion count if present.
+    m4_bmatch(m4_substr($2,2),
+    [0],[
+      # A count of zero means use the length of the shorter version.
+      # Determine the number of characters in A and B.
+      ax_compare_version_len_A=`echo "$A" | $AWK '{print(length)}'`
+      ax_compare_version_len_B=`echo "$B" | $AWK '{print(length)}'`
+
+      # Set A to no more than B's length and B to no more than A's length.
+      A=`echo "$A" | sed "s/\(.\{$ax_compare_version_len_B\}\).*/\1/"`
+      B=`echo "$B" | sed "s/\(.\{$ax_compare_version_len_A\}\).*/\1/"`
+    ],
+    [[0-9]+],[
+      # A count greater than zero means use only that many subversions
+      A=`echo "$A" | sed "s/\(\([[0-9]]\{4\}\)\{m4_substr($2,2)\}\).*/\1/"`
+      B=`echo "$B" | sed "s/\(\([[0-9]]\{4\}\)\{m4_substr($2,2)\}\).*/\1/"`
+    ],
+    [.+],[
+      AC_WARNING(
+        [invalid OP numeric parameter: $2])
+    ],[])
+
+    # Pad zeros at end of numbers to make same length.
+    ax_compare_version_tmp_A="$A`echo $B | sed 's/./0/g'`"
+    B="$B`echo $A | sed 's/./0/g'`"
+    A="$ax_compare_version_tmp_A"
+
+    # Check for equality or inequality as necessary.
+    m4_case(m4_tolower(m4_substr($2,0,2)),
+    [eq],[
+      test "x$A" = "x$B" && ax_compare_version=true
+    ],
+    [ne],[
+      test "x$A" != "x$B" && ax_compare_version=true
+    ],[
+      AC_WARNING([invalid OP parameter: $2])
+    ])
+  ])
+
+  AS_VAR_POPDEF([A])dnl
+  AS_VAR_POPDEF([B])dnl
+
+  dnl # Execute ACTION-IF-TRUE / ACTION-IF-FALSE.
+  if test "$ax_compare_version" = "true" ; then
+    m4_ifvaln([$4],[$4],[:])dnl
+    m4_ifvaln([$5],[else $5])dnl
+  fi
+]) dnl AX_COMPARE_VERSION

build-aux/m4/ax_prog_perl_modules.m4

@@ -0,0 +1,77 @@
+# ===========================================================================
+#   https://www.gnu.org/software/autoconf-archive/ax_prog_perl_modules.html
+# ===========================================================================
+#
+# SYNOPSIS
+#
+#   AX_PROG_PERL_MODULES([MODULES], [ACTION-IF-TRUE], [ACTION-IF-FALSE])
+#
+# DESCRIPTION
+#
+#   Checks to see if the given perl modules are available. If true the shell
+#   commands in ACTION-IF-TRUE are executed. If not the shell commands in
+#   ACTION-IF-FALSE are run. Note if $PERL is not set (for example by
+#   calling AC_CHECK_PROG, or AC_PATH_PROG), AC_CHECK_PROG(PERL, perl, perl)
+#   will be run.
+#
+#   MODULES is a space separated list of module names. To check for a
+#   minimum version of a module, append the version number to the module
+#   name, separated by an equals sign.
+#
+#   Example:
+#
+#     AX_PROG_PERL_MODULES( Text::Wrap Net::LDAP=1.0.3, ,
+#                           AC_MSG_WARN(Need some Perl modules)
+#
+# LICENSE
+#
+#   Copyright (c) 2009 Dean Povey <povey@wedgetail.com>
+#
+#   Copying and distribution of this file, with or without modification, are
+#   permitted in any medium without royalty provided the copyright notice
+#   and this notice are preserved. This file is offered as-is, without any
+#   warranty.
+
+#serial 8
+
+AU_ALIAS([AC_PROG_PERL_MODULES], [AX_PROG_PERL_MODULES])
+AC_DEFUN([AX_PROG_PERL_MODULES],[dnl
+
+m4_define([ax_perl_modules])
+m4_foreach([ax_perl_module], m4_split(m4_normalize([$1])),
+	  [
+	   m4_append([ax_perl_modules],
+		     [']m4_bpatsubst(ax_perl_module,=,[ ])[' ])
+          ])
+
+# Make sure we have perl
+if test -z "$PERL"; then
+AC_CHECK_PROG(PERL,perl,perl)
+fi
+
+if test "x$PERL" != x; then
+  ax_perl_modules_failed=0
+  for ax_perl_module in ax_perl_modules; do
+    AC_MSG_CHECKING(for perl module $ax_perl_module)
+
+    # Would be nice to log result here, but can't rely on autoconf internals
+    $PERL -e "use $ax_perl_module; exit" > /dev/null 2>&1
+    if test $? -ne 0; then
+      AC_MSG_RESULT(no);
+      ax_perl_modules_failed=1
+   else
+      AC_MSG_RESULT(ok);
+    fi
+  done
+
+  # Run optional shell commands
+  if test "$ax_perl_modules_failed" = 0; then
+    :
+    $2
+  else
+    :
+    $3
+  fi
+else
+  AC_MSG_WARN(could not find perl)
+fi])dnl

build-aux/m4/ax_prog_perl_version.m4

@@ -0,0 +1,70 @@
+# ===========================================================================
+#   https://www.gnu.org/software/autoconf-archive/ax_prog_perl_version.html
+# ===========================================================================
+#
+# SYNOPSIS
+#
+#   AX_PROG_PERL_VERSION([VERSION],[ACTION-IF-TRUE],[ACTION-IF-FALSE])
+#
+# DESCRIPTION
+#
+#   Makes sure that perl supports the version indicated. If true the shell
+#   commands in ACTION-IF-TRUE are executed. If not the shell commands in
+#   ACTION-IF-FALSE are run. Note if $PERL is not set (for example by
+#   running AC_CHECK_PROG or AC_PATH_PROG) the macro will fail.
+#
+#   Example:
+#
+#     AC_PATH_PROG([PERL],[perl])
+#     AX_PROG_PERL_VERSION([5.8.0],[ ... ],[ ... ])
+#
+#   This will check to make sure that the perl you have supports at least
+#   version 5.8.0.
+#
+#   NOTE: This macro uses the $PERL variable to perform the check.
+#   AX_WITH_PERL can be used to set that variable prior to running this
+#   macro. The $PERL_VERSION variable will be valorized with the detected
+#   version.
+#
+# LICENSE
+#
+#   Copyright (c) 2009 Francesco Salvestrini <salvestrini@users.sourceforge.net>
+#
+#   Copying and distribution of this file, with or without modification, are
+#   permitted in any medium without royalty provided the copyright notice
+#   and this notice are preserved. This file is offered as-is, without any
+#   warranty.
+
+#serial 13
+
+AC_DEFUN([AX_PROG_PERL_VERSION],[
+    AC_REQUIRE([AC_PROG_SED])
+    AC_REQUIRE([AC_PROG_GREP])
+
+    AS_IF([test -n "$PERL"],[
+        ax_perl_version="$1"
+
+        AC_MSG_CHECKING([for perl version])
+        changequote(<<,>>)
+        perl_version=`$PERL --version 2>&1 \
+          | $SED -n -e '/This is perl/b inspect
+b
+: inspect
+s/.* (\{0,1\}v\([0-9]*\.[0-9]*\.[0-9]*\))\{0,1\} .*/\1/;p'`
+        changequote([,])
+        AC_MSG_RESULT($perl_version)
+
+	AC_SUBST([PERL_VERSION],[$perl_version])
+
+        AX_COMPARE_VERSION([$ax_perl_version],[le],[$perl_version],[
+	    :
+            $2
+        ],[
+	    :
+            $3
+        ])
+    ],[
+        AC_MSG_WARN([could not find the perl interpreter])
+        $3
+    ])
+])

build-aux/m4/ax_with_prog.m4

@@ -0,0 +1,70 @@
+# ===========================================================================
+#       https://www.gnu.org/software/autoconf-archive/ax_with_prog.html
+# ===========================================================================
+#
+# SYNOPSIS
+#
+#   AX_WITH_PROG([VARIABLE],[program],[VALUE-IF-NOT-FOUND],[PATH])
+#
+# DESCRIPTION
+#
+#   Locates an installed program binary, placing the result in the precious
+#   variable VARIABLE. Accepts a present VARIABLE, then --with-program, and
+#   failing that searches for program in the given path (which defaults to
+#   the system path). If program is found, VARIABLE is set to the full path
+#   of the binary; if it is not found VARIABLE is set to VALUE-IF-NOT-FOUND
+#   if provided, unchanged otherwise.
+#
+#   A typical example could be the following one:
+#
+#     AX_WITH_PROG(PERL,perl)
+#
+#   NOTE: This macro is based upon the original AX_WITH_PYTHON macro from
+#   Dustin J. Mitchell <dustin@cs.uchicago.edu>.
+#
+# LICENSE
+#
+#   Copyright (c) 2008 Francesco Salvestrini <salvestrini@users.sourceforge.net>
+#   Copyright (c) 2008 Dustin J. Mitchell <dustin@cs.uchicago.edu>
+#
+#   Copying and distribution of this file, with or without modification, are
+#   permitted in any medium without royalty provided the copyright notice
+#   and this notice are preserved. This file is offered as-is, without any
+#   warranty.
+
+#serial 17
+
+AC_DEFUN([AX_WITH_PROG],[
+    AC_PREREQ([2.61])
+
+    pushdef([VARIABLE],$1)
+    pushdef([EXECUTABLE],$2)
+    pushdef([VALUE_IF_NOT_FOUND],$3)
+    pushdef([PATH_PROG],$4)
+
+    AC_ARG_VAR(VARIABLE,Absolute path to EXECUTABLE executable)
+
+    AS_IF(test -z "$VARIABLE",[
+        AC_MSG_CHECKING(whether EXECUTABLE executable path has been provided)
+        AC_ARG_WITH(EXECUTABLE,AS_HELP_STRING([--with-EXECUTABLE=[[[PATH]]]],absolute path to EXECUTABLE executable), [
+            AS_IF([test "$withval" != yes && test "$withval" != no],[
+                VARIABLE="$withval"
+                AC_MSG_RESULT($VARIABLE)
+            ],[
+                VARIABLE=""
+                AC_MSG_RESULT([no])
+                AS_IF([test "$withval" != no], [
+                  AC_PATH_PROG([]VARIABLE[],[]EXECUTABLE[],[]VALUE_IF_NOT_FOUND[],[]PATH_PROG[])
+                ])
+            ])
+        ],[
+            AC_MSG_RESULT([no])
+            AC_PATH_PROG([]VARIABLE[],[]EXECUTABLE[],[]VALUE_IF_NOT_FOUND[],[]PATH_PROG[])
+        ])
+    ])
+
+    popdef([PATH_PROG])
+    popdef([VALUE_IF_NOT_FOUND])
+    popdef([EXECUTABLE])
+    popdef([VARIABLE])
+])

configure.ac

@@ -0,0 +1,123 @@
+AC_PREREQ([2.63])
+# Get the version from ddclient.in so that the same version string
+# doesn't have to be maintained in two places.  The m4_dquote macro is
+# used instead of quote characters to ensure that the command is only
+# run once.  The command outputs quote characters to prevent
+# incidental expansion (the m4_esyscmd macro does not quote the
+# command output itself, so the command output is subject to
+# expansion).
+AC_INIT([ddclient], m4_dquote(m4_esyscmd([printf '[%s]' "$(./ddclient.in --version=short)"])))
+# Needed because of the above invocation of ddclient.in.
+AC_SUBST([CONFIGURE_DEPENDENCIES], ['$(top_srcdir)/ddclient.in'])
+AC_CONFIG_SRCDIR([ddclient.in])
+AC_CONFIG_AUX_DIR([build-aux])
+AC_CONFIG_MACRO_DIR([build-aux/m4])
+AC_REQUIRE_AUX_FILE([tap-driver.sh])
+# If the automake dependency is bumped to v1.12 or newer, remove
+# build-aux/tap-driver.sh from the repository.  Automake 1.12+ comes
+# with tap-driver.sh, and autoreconf will copy in the version
+# distributed with automake.  (Automake 1.11 and older don't come with
+# tap-driver.sh, so build-aux/tap-driver.sh is checked in to keep the
+# above AC_REQUIRE_AUX_FILE line from causing configure to complain
+# about a mising file if the user has Automake 1.11.)
+AM_INIT_AUTOMAKE([1.11 -Wall -Werror foreign subdir-objects parallel-tests])
+AM_SILENT_RULES
+
+m4_define([CONFDIR_DEFAULT], [${sysconfdir}/AC_PACKAGE_NAME])
+AC_ARG_WITH(
+  [confdir],
+  [AS_HELP_STRING(
+    [--with-confdir=DIR],
+    m4_expand([[look for ddclient.conf in DIR @<:@default: ]CONFDIR_DEFAULT[@:>@]]))],
+  [],
+  # The single quotes are intentional; see:
+  # https://www.gnu.org/software/automake/manual/html_node/Uniform.html
+  [with_confdir='CONFDIR_DEFAULT'])
+AC_SUBST([confdir], [${with_confdir}])
+
+AC_PROG_MKDIR_P
+
+# The Fedora Docker image doesn't come with the 'findutils' package.
+# 'find' is required for 'make distcheck', which the user might not
+# run. We could log a warning instead of erroring out, but:
+#   * a warning is unlikely to be seen,
+#   * 'make distcheck' doesn't yield a non-0 exit code if 'find' is
+#     not available,
+#   * 'find' is a core utility that should always be available, and
+#   * we might use 'find' for other purposes in the future.
+AC_PATH_PROG([FIND], [find])
+AS_IF([test -z "${FIND}"], [AC_MSG_ERROR(['find' utility not found])])
+
+AC_ARG_WITH([curl],
+  [AS_HELP_STRING([[--with-curl[=CURL]]], [use CURL as absolute path to curl executable])],
+  [],
+  [with_curl=yes])
+AS_CASE([${with_curl}],
+  [[yes]], [AC_PATH_PROG([CURL], [curl])],
+  [[no]], [CURL=],
+  [
+    AC_MSG_CHECKING([for curl])
+    CURL=${with_curl}
+    AC_MSG_RESULT([${CURL}])
+  ]);
+AS_IF([test -z "${CURL}"], [AC_MSG_ERROR([curl not found])])
+
+AX_WITH_PROG([PERL], perl)
+AX_PROG_PERL_VERSION([5.10.1], [],
+  [AC_MSG_ERROR([Perl 5.10.1 or newer not found])])
+AC_SUBST([PERL])
+
+# Perl modules required to run ddclient. Note: CentOS, RHEL, and
+# Fedora put some core modules in separate packages, and the perl
+# package doesn't depend on all of them, so their availability can't
+# be assumed.
+m4_foreach_w([_m], [
+    Data::Dumper
+    File::Basename
+    File::Path
+    File::Temp
+    Getopt::Long
+    Socket
+    Sys::Hostname
+    version=0.77
+  ], [AX_PROG_PERL_MODULES([_m], [],
+         [AC_MSG_ERROR([missing required Perl module _m])])])
+
+# Perl modules required for tests. If these modules are not installed
+# then some tests will fail. Only prints a warning if not installed.
+m4_foreach_w([_m], [
+    B
+    Exporter
+    File::Spec::Functions
+    File::Temp
+    List::Util
+    Scalar::Util
+    re
+  ], [AX_PROG_PERL_MODULES([_m], [],
+         [AC_MSG_WARN([some tests will fail due to missing module _m])])])
+
+# Optional Perl modules for tests. If these modules are not installed
+# then some tests will be skipped, but no tests should fail. Only
+# prints a warning if not installed.
+m4_foreach_w([_m], [
+    Carp
+    HTTP::Daemon=6.12
+    HTTP::Daemon::SSL
+    HTTP::Message::PSGI
+    HTTP::Request
+    HTTP::Response
+    JSON::PP
+    Test::MockModule
+    Test::TCP
+    Test::Warnings
+    Time::HiRes
+    URI
+    parent
+  ], [AX_PROG_PERL_MODULES([_m], [],
+         [AC_MSG_WARN([some tests may be skipped due to missing module _m])])])
+
+AC_CONFIG_FILES([
+    Makefile
+    t/version.pl
+  ])
+AC_OUTPUT

ddclient.conf.in

@@ -0,0 +1,421 @@
+######################################################################
+##
+## Define default global variables with lines like:
+##      var=value [, var=value]*
+## These values will be used for each following host unless overridden
+## with a local variable definition.
+##
+## Define local variables for one or more hosts with:
+##      var=value [, var=value]* host.and.domain[,host2.and.domain...]
+##
+## Lines can be continued on the following line by ending the line
+## with a \
+##
+##
+## Warning: not all supported routers or dynamic DNS services
+##          are mentioned here.
+##
+######################################################################
+
+## Use encryption (TLS) when the scheme (either "http://" or "https://") is
+## missing from a URL.  Defaults to "yes".
+#ssl=yes
+
+daemon=300                      # check every 300 seconds
+syslog=yes                      # log update msgs to syslog
+mail=root                       # mail all msgs to root
+mail-failure=root               # mail failed update msgs to root
+# mail-from=root                # set the email "From:" header to "root".  If
+                                # unset (the default) or empty, the from address
+                                # depends on your system's default behavior.
+pid=@runstatedir@/ddclient.pid  # record PID in file.
+# postscript=script             # run script after updating.  The new IP is
+                                # added as argument.
+#
+#use=watchguard-soho,        fw=192.168.111.1:80        # via Watchguard's SOHO FW
+#use=netopia-r910,           fw=192.168.111.1:80        # via Netopia R910 FW
+#use=smc-barricade,          fw=192.168.123.254:80      # via SMC's Barricade FW
+#use=netgear-rt3xx,          fw=192.168.0.1:80          # via Netgear's internet FW
+#use=linksys,                fw=192.168.1.1:80          # via Linksys's internet FW
+#use=maxgate-ugate3x00,      fw=192.168.0.1:80          # via MaxGate's UGATE-3x00  FW
+#use=elsa-lancom-dsl10,      fw=10.0.0.254:80           # via ELSA LanCom DSL/10 DSL Router
+#use=elsa-lancom-dsl10-ch01, fw=10.0.0.254:80           # via ELSA LanCom DSL/10 DSL Router
+#use=elsa-lancom-dsl10-ch02, fw=10.0.0.254:80           # via ELSA LanCom DSL/10 DSL Router
+#use=alcatel-stp,            fw=10.0.0.138:80           # via Alcatel Speed Touch Pro
+#use=xsense-aero,            fw=192.168.1.1:80          # via Xsense Aero Router
+#use=allnet-1298,            fw=192.168.1.1:80          # via AllNet 1298 DSL Router
+#use=3com-oc-remote812,      fw=192.168.0.254:80        # via 3com OfficeConnect Remote 812
+#use=e-tech,                 fw=192.168.1.1:80          # via E-tech Router
+#use=cayman-3220h,           fw=192.168.0.1:1080        # via Cayman 3220-H DSL Router
+#
+#fw-login=admin,             fw-password=XXXXXX         # FW login and password
+#
+## To obtain an IP address from FW status page (using fw-login, fw-password)
+#use=fw, fw=192.168.1.254/status.htm, fw-skip='IP Address' # found after IP Address
+#
+## To obtain an IP address via UPnP from router
+## Requires miniupnpc to be installed on the system.
+#use=cmd, cmd=external-ip
+#
+## To obtain an IP address from Web status page (using the proxy if defined)
+## by default, checkip.dyndns.org is used if you use the dyndns protocol.
+## Using use=web is enough to get it working.
+## WARNING: set deamon at least to 600 seconds if you use checkip or you could
+## get banned from their service.
+#use=web, web=checkip.dyndns.org/, web-skip='IP Address' # found after IP Address
+#
+#use=ip,                     ip=127.0.0.1       # via static IP's
+#use=if,                     if=eth0            # via interfaces
+#use=web                                        # via web
+#
+#protocol=dyndns2                               # default protocol
+#proxy=fasthttp.sympatico.ca:80                 # default proxy
+#server=members.dyndns.org                      # default server
+#server=members.dyndns.org:8245                 # default server (bypassing proxies)
+
+#login=your-login                               # default login
+#password=test                                  # default password
+#mx=mx.for.your.host                            # default MX
+#backupmx=yes|no                                # host is primary MX?
+#wildcard=yes|no                                # add wildcard CNAME?
+
+##
+## dyndns.org dynamic addresses
+##
+## (supports variables: wildcard,mx,backupmx)
+##
+# server=members.dyndns.org,            \
+# protocol=dyndns2                      \
+# your-dynamic-host.dyndns.org
+
+##
+## ZoneEdit (zoneedit.com)
+##
+# server=dynamic.zoneedit.com,          \
+# protocol=zoneedit1,                   \
+# login=your-zoneedit-login,            \
+# password=your-zoneedit-password       \
+# your.any.domain,your-2nd.any.dom
+
+##
+## EasyDNS (easydns.com)
+##
+# server=members.easydns.com,           \
+# protocol=easydns,                     \
+# login=your-easydns-login,             \
+# password=your-easydns-password        \
+# your.any.domain,your-2nd.any.domain
+
+##
+## dslreports.com dynamic-host monitoring
+##
+# server=members.dslreports.com         \
+# protocol=dslreports1,                 \
+# login=dslreports-login,               \
+# password=dslreports-password          \
+# dslreports-unique-id
+
+##
+## OrgDNS.org account-configuration
+##
+# use=web, web=members.orgdns.org/nic/ip
+# protocol=dyndns2
+# server=www.orgdns.org                 \
+# login=yourLoginName                   \
+# password=yourPassword                 \
+# yourSubdomain.orgdns.org
+
+##
+## NameCheap (namecheap.com)
+##
+# protocol=namecheap,                     \
+# server=dynamicdns.park-your-domain.com, \
+# login=example.com,                      \
+# password=example.com-password           \
+# subdomain.example.com
+
+##
+## NearlyFreeSpeech.NET (nearlyfreespeech.net)
+##
+# protocol=nfsn,                        \
+# zone=example.com,                     \
+# login=member-login,                   \
+# password=api-key                      \
+# example.com,subdomain.example.com
+
+##
+## Loopia (loopia.se)
+##
+# use=web, web=loopia
+# protocol=dyndns2
+# server=dns.loopia.se
+# script=/XDynDNSServer/XDynDNS.php
+# login=my-loopia.se-login
+# password=my-loopia.se-password
+# my.domain.tld,other.domain.tld
+
+##
+## NoIP (noip.com)
+##
+# protocol=noip,                        \
+# ssl=yes,                              \
+# server=dynupdate.no-ip.com,           \
+# login=your-noip-login,                \
+# password=your-noip-password           \
+# your-host.domain.com, your-2nd-host.domain.com
+
+##
+## ChangeIP (changeip.com)
+##
+## single host update
+# protocol=changeip,                   \
+# login=my-my-changeip.com-login,      \
+# password=my-changeip.com-password    \
+# myhost.changeip.org
+
+##
+## CloudFlare (www.cloudflare.com)
+##
+# protocol=cloudflare,        \
+# zone=domain.tld,            \
+# ttl=1,                      \
+# login=your-login-email,     \ # Only needed if you are using your global API key. If you are using an API token, set it to "token" (without double quotes).
+# password=APIKey             \ # This is either your global API key, or an API token. If you are using an API token, it must have the permissions "Zone - DNS - Edit" and "Zone - Zone - Read". The Zone resources must be "Include - All zones".
+# domain.tld,my.domain.tld
+
+##
+## Gandi (gandi.net)
+##
+## Single host update
+# protocol=gandi
+# zone=example.com
+# password=my-gandi-access-token
+# use-personal-access-token=yes
+# ttl=10800 # optional
+# myhost.example.com
+
+##
+## GoDaddy (godaddy.com)
+##
+# protocol=godaddy,                    \
+# password=my-godaddy-api-key,         \
+# password=my-godaddy-secret,          \
+# ttl=600                              \
+# zone=example.com,                    \
+# myhost.example.com,nexthost.example.com
+
+##
+## Hurricane Electric (dns.he.net)
+##
+# protocol=he.net,                      \
+# password=my-genereated-password       \
+# myhost.example.com
+
+##
+## Duckdns (http://www.duckdns.org/)
+##
+#
+# protocol=duckdns, \
+# password=my-auto-generated-password \
+# hostwithoutduckdnsorg
+
+##
+## Freemyip (http://freemyip.com/)
+##
+#
+# protocol=freemyip,
+# password=my-token
+# myhost
+
+##
+## DDNS.FM (https://ddns.fm/)
+##
+#
+# protocol=ddns.fm,
+# password=my-token
+# myhost.example.com
+
+##
+## MyOnlinePortal (http://myonlineportal.net)
+##
+# # ipv6=yes # optional
+# use=web, web=myonlineportal.net/checkip
+# # use=if, if=eth0     # alternative to use=web
+# # if-skip=Scope:Link  # alternative to use=web
+# protocol=dyndns2
+# ssl=yes
+# login=your-myonlineportal-username
+# password=your-myonlineportal-password
+# domain.myonlineportal.net
+
+##
+## nsupdate.info IPV4(https://www.nsupdate.info)
+##
+# use=web, web=http://ipv4.nsupdate.info/myip
+# protocol=dyndns2
+# server=ipv4.nsupdate.info
+# login=domain.nsupdate.info
+# password='123'
+# domain.nsupdate.info
+
+##
+## nsupdate.info IPV6 (https://www.nsupdate.info)
+## ddclient releases <= 3.8.1 do not support IPv6
+##
+# usev6=if, if=eth0
+# protocol=dyndns2
+# server=ipv6.nsupdate.info
+# login=domain.nsupdate.info
+# password='123'
+# domain.nsupdate.info
+
+##
+## Yandex.Mail for Domain (domain.yandex.com)
+##
+# protocol=yandex,                      \
+# login=domain.tld,                     \
+# password=yandex-pdd-token             \
+# my.domain.tld,other.domain.tld        \
+
+##
+## DNS Made Easy (https://dnsmadeeasy.com)
+##
+# protocol=dnsmadeeasy,
+# login=your-account-email-address
+# password=your-generated-password
+# your-numeric-record-id-1,your-numeric-record-id-2,...
+
+##
+## OVH DynHost (https://ovh.com)
+##
+# protocol=ovh,
+# login=example.com-dynhostuser,
+# password=your_password
+# test.example.com
+
+##
+## Porkbun (https://porkbun.com/)
+##
+# protocol=porkbun
+# apikey=APIKey
+# secretapikey=SecretAPIKey
+# root-domain=example.com
+# host.example.com,host2.sub.example.com
+# example.com,sub.example.com
+
+##
+## ClouDNS (https://www.cloudns.net)
+##
+# protocol=cloudns, \
+# dynurl=https://ipv4.cloudns.net/api/dynamicURL/?q=Njc1OTE2OjY3Njk0NDM6YTk2, \
+# myhost.example.com
+
+##
+## dinahosting (https://dinahosting.com)
+##
+# protocol=dinahosting, \
+# login=myusername,     \
+# password=mypassword   \
+# myhost.mydomain.com
+
+##
+## dnsexit (www.dnsexit.com)
+##
+# protocol=dnsexit,                                            \
+# login=myusername,                                            \
+# password=mypassword,                                         \
+# subdomain-1.domain.com,subdomain-2.domain.com
+
+##
+## dnsexit2 (API method www.dnsexit.com)
+##
+# protocol=dnsexit2
+# password=MyAPIKey
+# subdomain-1.domain.com,subdomain-2.domain.com
+
+##
+## domeneshop (www.domeneshop.no)
+##
+# protocol=domeneshop
+# login=<token>
+# password=<secret>
+# subdomain-1.domain.com,subdomain-2.domain.com
+
+##
+## Njal.la (http://njal.la/)
+##
+# protocol=njalla,
+# password=mypassword
+# quietreply=no|yes
+# my-domain.com
+
+##
+## regfish.de (www.regfish.de/)
+##
+# protocol=regfishde,
+# password=mypassword
+# my-domain.com
+
+##
+## Enom (www.enom.com)
+##
+# protocol=enom,
+# login=domain.name,
+# password=domain-password
+# my-domain.com
+
+##
+## DigitalOcean (www.digitalocean.com)
+##
+# protocol=digitalocean, \
+# zone=example.com,      \
+# password=api-token     \
+# example.com,sub.example.com
+
+##
+## Directnic (directnic.com)
+##
+# protocol=directnic,
+# urlv4=https://directnic.com/dns/gateway/ipv4_token/
+# urlv6=https://directnic.com/dns/gateway/ipv6_token/
+# my-domain.com
+
+##
+## Infomaniak (www.infomaniak.com)
+##
+# protocol=infomaniak,
+# login=ddns_username,
+# password=ddns_password
+# example.com
+#
+# N.B. the infomaniak protocol is obsolete. Please use dyndns2 instead:
+#
+# protocol=dyndns2,
+# use=web, web=infomaniak.com/ip.php/
+# login=ddns_username,
+# password=ddns_password
+# redirect=2
+# example.com
+
+##
+## Email Only
+##
+# protocol=emailonly
+# host.example.com
+
+##
+## dnsHome.de
+##
+# protocol=dyndns2           \
+# server=www.dnshome.de      \
+# login=subdomain.domain.tld \
+# password=your_password     \
+# subdomain.domain.tld
+
+##
+## INWX
+##
+# protocol=inwx                             \
+# login=my-inwx-DynDNS-account-username     \
+# password=my-inwx-DynDNS-account-password  \
+# myhost.example.org

docs/ProviderGuidelines.md

@@ -0,0 +1,39 @@
+# Provider implementations
+
+Author: [@LenardHess](https://github.com/LenardHess/)\
+Date: 2023-11-23
+
+This document is meant to detail the mechanisms that provider implementation shall use. It differentiates between new and legacy provider implementations. The former are adhering to the IPv6 support updates being done to ddclient, the legacy ones are from before that update.
+
+## New provider Implementation
+1. Grab the IP(s) from $config{$host}{'wantipv4'} and/or $config{$host}{'wantipv6'}
+2. Optional: Query the provider for the current IP record(s). If they are already good, skip updating IP record(s)
+3. Update the IP record(s).
+4. If successful (or if the records were already good):
+    - Set 'status-ipv4' and/or 'status-ipv6' to 'good'
+    - Set 'ipv4' and/or 'ipv6' to the IP that has been set
+    - Set 'mtime' to the current time
+5. If not successful:
+    - Set 'status-ipv4' and/or 'status-ipv6' to an error message
+    - Set 'atime' to the current time
+
+The new provider implementation should not set 'status' nor 'ip'. They're part of the legacy infrastructure and ddclient will take care of setting them correctly.
+
+## Legacy provider implementations
+1. Grab the IP from $config{$host}{'wantip'}
+2. Optional: Query the provider for the current IP record. If it is already good, skip updating IP record
+3. Update the IP record.
+4. If successful (or if the record was already good):
+    - Set 'status' to 'good'
+    - Set 'ip' to the IP that has been set
+    - Set 'mtime' to the current time
+5. If not successful:
+    - Set 'status' to an error message
+    - Set 'atime' to the current time
+
+# ToDo
+- Decide/Inquire whether services prefer querying the IP first. Then decide whether to make it mandatory.
+- Write guidelines on checking existing records (i.e. check TTL as well?).
+- Start a list of providers and their implementation state
+- Add more details to this document
+    - Whether 'wantip*' ought to be deleted when read or not.

docs/ipv6-design-doc.md

@@ -0,0 +1,337 @@
+# Design Doc: IPv6 Support
+
+Author: [@rhansen](https://github.com/rhansen/)\
+Date: 2020-06-09\
+Signed off by:
+[@SuperSandro2000](https://github.com/SuperSandro2000/)
+
+## Objective
+
+Add full IPv6 support to ddclient, including support for dual-stack
+systems.
+
+## Background
+
+ddclient's current IPv6 support is limited:
+
+  * Users can update either an IPv6 record or an IPv4 record for a
+    host, not both.
+  * If SSL is used for an HTTP request, IPv6 will be used if the
+    remote host has a AAAA record, even if the user would rather use
+    IPv4. This breaks `use=web` for IPv4 if the `web` URL's host has a
+    AAAA record.
+  * The `use=if` method only works if the user sets `if-skip` to
+    something that skips over all IPv4 addresses in the output of
+    `ifconfig` (or `ip`). If the output contains an IPv4 address after
+    the IPv6 address then `use=if` cannot be used for IPv6.
+  * There is no support for falling back to IPv4 if an IPv6 connection
+    fails.
+  * `use=if` does not filter out locally scoped or temporary IPv6
+    addresses.
+
+Some attempts have been made to add more robust IPv6 support:
+
+  * Debian's ddclient package applies a
+    [patch](https://salsa.debian.org/debian/ddclient/-/blob/67a138aa3d98d70f01766123f58ef40e98693fd4/debian/patches/usev6.diff)
+    that adds a new `usev6` option. The `usev6` option can be set to
+    `ip` or `if`, but not any of the other strategies currently
+    available for the `use` option (`web`, `cmd`, `fw`, `cisco`,
+    `cisco-asa`). When set to `ip` or `if`, only IPv6 addresses are
+    considered; IPv4 addresses are ignored. The patch does not change
+    the behavior of the `use` option, so `use=web` or `use=cmd` can be
+    used for IPv6 if pointed at something that only outputs an IPv6
+    address.
+  * [ddclient-curl](https://github.com/astlinux-project/ddclient-curl)
+    is a fork of ddclient that uses curl as the HTTP client (instead
+    of ddclient's own homemade client) for more robust IPv6 support.
+  * PR #40 is perhaps the most comprehensive attempt at adding full
+    IPv6 support, but it was never merged and has since
+    bit-rotted. There is renewed effort to rebase the changes and get
+    them merged in. PR #40 adds new options and changes some existing
+    options. The approach taken is to completely isolate IPv4 address
+    detection from IPv6 address detection and require the update
+    protocol callbacks to handle each type of address appropriately.
+
+## Requirements
+
+  * The mechanism for determining the current IPv4 address (the `use`
+    option) must be independently configurable from the mechanism used
+    to determine the current IPv6 address.
+  * The user must be able to disable IPv4 address updates without
+    affecting IPv6 updates.
+  * The user must be able to disable IPv6 address updates without
+    affecting IPv4 updates.
+  * If HTTP polling is used for both IPv4 and IPv6 address discovery,
+    the URL used to determine the IPv4 address (the `web` option) must
+    be independently configurable from the URL used to determine the
+    IPv6 address.
+  * The use of IPv4 or IPv6 to update a record must be independent of
+    the type of record being updated (IPv4 or IPv6).
+  * The callback for the update protocol must be given both addresses,
+    even if only one of the two addresses has changed.
+  * The callback for the update protocol must be told which addresses
+    have changed.
+  * There must be IPv6 equivalents to `use=ip`, `use=if`, `use=web`,
+    and `use=cmd`. For the IPv6 equivalent to `use=if`, it is
+    acceptable to ignore non-global and temporary addresses (the user
+    can always use the IPv6 equivalent to `use=cmd` to get non-global
+    or temporary addresses).
+  * Existing support for updating IPv6 records must not be lost.
+  * Some dynamic DNS service providers use separate credentials for
+    the IPv4 and IPv6 records. These providers must be supported,
+    either by accepting both sets of credentials in a single host's
+    configuration or by allowing the user to specify the same host
+    twice, once for IPv4 and once for IPv6.
+
+### Nice-to-Haves
+
+  * The user should be able to force the update protocol to use IPv4
+    or IPv6.
+  * Unless configured otherwise, ddclient should first attempt to
+    update via IPv6 and fall back to IPv4 if the IPv6 connection
+    fails. This behavior can be added later; for now it is acceptable
+    to keep the current behavior (use IPv6 without IPv4 fallback if
+    there is a AAAA record, use IPv4 if there is no AAAA record).
+  * Full backwards compatibility with existing config files and
+    flags. The trade-offs between migration burden, long-term
+    usability, and code maintenance should be carefully considered.
+  * IPv6 equivalents to `use=fw`, `use=cisco`, and `use=cisco-asa`.
+  * Add IPv6 support in protocol callbacks where IPv6 support is
+    currently missing. (This can be done later.)
+
+## Proposal
+
+### Configuration changes
+
+  * Add new `usev4` and `usev6` settings that are like the current
+    `use` setting except they only apply to IPv4 and IPv6,
+    respectively.
+      * `usev4` can be set to one of the following values: `disabled`,
+        `ipv4`, `webv4`, `fwv4`, `ifv4`, `cmdv4`, `ciscov4`,
+        `cisco-asav4`
+      * `usev6` can be set to one of the following values: `disabled`,
+        `ipv6`, `webv6`, `fwv6`, `ifv6`, `cmdv6`, `ciscov6`,
+        `cisco-asav6`
+  * Add a new `use` strategy: `disabled`.
+  * The `disabled` value for `use`, `usev4`, and `usev6` causes
+    ddclient to act as if it was never set. This is useful for
+    overriding the global value for a particular host.
+  * For compatibility with ddclient-curl, `no` is a deprecated alias
+    of `disabled`.
+  * Add new `ipv4`, `ipv6`, `webv4`, `webv4-skip`, `webv6`,
+    `webv6-skip`, `ifv4`, `ifv6`, `cmdv4`, `cmdv6`, etc. settings that
+    behave like their versionless counterparts except they only apply
+    to IPv4 or IPv6. Deprecate the versionless counterparts, and
+    change their behavior so that they also influence the default
+    value of the versioned options. (Example:  Suppose
+    `usev4=ifv4`. If `ifv4` is not set then `if` is used.)  Special
+    notes:
+      * The value of `ip` will only serve as the default for `ipv4`
+        (or `ipv6`) if it contains an IPv4 (or IPv6) address.
+      * There is currently an `ipv6` boolean setting. To preserve
+        backward compatibility with existing configs, `ipv6` set to a
+        boolean value is ignored (other than a warning).
+      * There is no `ifv4-skip` or `ifv6-skip` because it's ddclient's
+        responsibility to properly parse the output of whatever tool
+        it uses to read the interface's addresses.
+      * For now there is no `cmdv4-skip` or `cmdv6-skip`. Anyone who
+        already knows how to write a regular expression can probably
+        write a wrapper script. These may be added in the future if
+        users request them, especially if it facilitates migration
+        away from the deprecated `cmd-skip` setting.
+      * For `usev6=ifv6`, interfaces are likely to have several IPv6
+        addresses (unlike IPv4). Choosing the "right" IPv6 address is
+        not trivial. Fortunately, we don't have to solve this
+        perfectly right now; we can choose something that mostly
+        works and let user bug reports guide future refinements. For
+        the first iteration, we will try the following:
+          * Ignore addresses that are not global unicast.
+            (Unfortunately, the `ip` command from iproute2 does not
+            provide a way to filter out ULA addresses so we will have
+            to do this ourselves.)
+          * Ignore temporary addresses.
+          * If no addresses remain, log a warning and don't update the
+            IPv6 record.
+          * Otherwise, if one of the remaining addresses matches the
+            previously selected address, continue to use it.
+          * Otherwise, select one arbitrarily.
+  * Deprecate the `use` setting (print a loud warning) but keep its
+    existing semantics with an exception: If there is a conflict with
+    `usev4` or `usev6` then those take priority:
+      * If `use`, `usev4`, and `usev6` are all set then a warning is
+        logged and the `use` setting is ignored.
+      * If `use` and `usev4` are both set and the `use` strategy
+        discovers an IPv4 address that differs from the address
+        discovered by the `usev4` strategy, then the address from
+        `usev4` is used and a warning is logged.
+      * If `use` and `usev6` are both set and the `use` strategy
+        discovers an IPv6 address that differs from the address
+        discovered by the `usev6` strategy, then the address from
+        `usev6` is used and a warning is logged.
+  * If `usev4` (`usev6`) is not set:
+      * If `ipv4` (`usev6`) is set, ddclient acts as if `usev4`
+        (`usev6`) was set to `ipv4` (`ipv6`).
+      * Otherwise, if `ifv4` (`ifv6`) is set, ddclient acts as if
+        `usev4` (`usev6`) was set to `ifv4` (`ifv6`).
+      * Otherwise, if `cmdv4` (`cmdv6`) is set, ddclient acts as if
+        `usev4` (`usev6`) was set to `cmdv4` (`cmdv6`).
+      * Otherwise, if `fwv4` (`fwv6`) is set, ddclient acts as if
+        `usev4` (`usev6`) was set to `fwv4` (`fwv6`).
+      * Otherwise, `usev4` (`usev6`) remains unset.
+  * To support separate credentials for IPv4 vs. IPv6 updates, users
+    can specify the same host multiple times, each time with different
+    options.
+
+### Internal API changes
+
+  * Add two new entries to the `$config{$host}` hash:
+      * `$config{$host}{'wantipv4'}` is set to:
+          * If `usev4` is enabled, the IPv4 address discovered by the
+            `usev4` strategy.
+          * Otherwise, if `use` is enabled and the `use` strategy
+            discovered an IPv4 address, the IPv4 address discovered by
+            the `use` strategy.
+          * Otherwise, `undef`.
+      * `$config{$host}{'wantipv6'}` is set to:
+          * If `usev6` is enabled, the IPv6 address discovered by the
+            `usev6` strategy.
+          * Otherwise, if `use` is enabled and the `use` strategy
+            discovered an IPv6 address, the IPv6 address discovered by
+            the `use` strategy.
+          * Otherwise, `undef`.
+  * Deprecate the existing `$config{$host}{'wantip'}` entry, to be
+    removed after all update protocol callbacks have been updated to
+    use the above new entries. In the meantime, this entry's value
+    depends on which of `use`, `usev4`, and `usev6` is enabled, and
+    what type of IP address is discovered by the `use` strategy (if
+    enabled), according to the following table:
+
+    | `use` | `usev4` | `usev6` | resulting value |
+    | :---: | :---: | :---: | :--- |
+    | ✔(IPv4) | ✖ | ✖ | the IPv4 address discovered by the `use` strategy |
+    | ✔(IPv6) | ✖ | ✖ | the IPv6 address discovered by the `use` strategy |
+    | ✖ | ✔ | ✖ | the IPv4 address discovered by the `usev4` strategy |
+    | ✖ | ✖ | ✔ | the IPv6 address discovered by the `usev6` strategy |
+    | ✔(IPv4) | ✔ | ✖ | the IPv4 address discovered by the `usev4` strategy (and log another warning if it doesn't match the IPv4 address found by the `use` strategy) |
+    | ✔(IPv6) | ✔ | ✖ | the IPv6 address discovered by the `use` strategy |
+    | ✔(IPv4) | ✖ | ✔ | the IPv4 address discovered by the `use` strategy |
+    | ✔(IPv6) | ✖ | ✔ | the IPv6 address discovered by the `usev6` strategy (and log another warning if it doesn't match the IPv6 address found by the `use` strategy) |
+
+  * To support separate credentials for IPv4 vs. IPv6 updates, convert
+    the `%config` hash of host configs into a list of host configs. A
+    second definition for the same host adds a second entry rather
+    than overwrites the existing entry.
+
+## Alternatives Considered
+
+### Repurpose the existing settings for v4
+
+Rather than create new `usev4`, `ifv4`, `cmdv4`, etc. settings,
+repurpose the existing `use`, `if`, `cmd`, etc. settings for IPv4.
+
+Why this was rejected:
+  * There is a usability advantage to the symmetry with the `v6`
+    settings.
+  * It is easier to remain compatible with existing configurations.
+
+### Let `use` set the default for `usev4`
+
+Rather than three separate IP discovery mechanisms (`use`, `usev4`,
+and `usev6`), have just two (`usev4` and `usev6`) and let the old
+`use` setting control the default for `usev4`: If `usev4` is not set,
+then `use=foo` is equivalent to `usev4=foov4`.
+
+Why this was rejected: Backwards incompatibility. Specifically,
+configurations that previously updated an IPv6 record would instead
+(attempt to) update an IPv4 record.
+
+### Let `use` set the default for `usev4` and `usev6`
+
+Rather than three separate IP discovery mechanisms (`use`, `usev4`,
+and `usev6`), have just two (`usev4` and `usev6`) and let the old
+`use` setting control the default for `usev4` and `usev6`:
+
+  * If neither `usev4` nor `usev6` is set, then `use=foo` is
+    equivalent to `usev4=foov4,usev6=foov6`.
+  * If `usev4` is set but not `usev6`, then `use=foo` is equivalent to
+    `usev6=foov6`.
+  * If `usev6` is set but not `usev4`, then `use=foo` is equivalent to
+    `usev4=foov4`.
+  * If both `usev4` and `usev6` are set, then `use=foo` is ignored.
+
+Why this was rejected: The new design would cause existing
+configurations to trigger surprising, and possibly undesired (e.g.,
+timeouts or update errors), new behavior:
+
+  * Configurations that previously updated only an IPv4 record would
+    also update an IPv6 record.
+  * Similarly, configurations that previously updated only an IPv6
+    record would also update an IPv4 record.
+
+### Replace uses of `'wantip'` with `'wantipv4'`
+
+Rather than support `'wantip'`, `'wantipv4'`, and `'wantipv6'`, just
+replace all `'wantip'` references to `'wantipv4'`.
+
+Why this was rejected: This would break compatibility for users that
+are currently updating IPv6 addresses. (Compatibility would be
+restored once the update protocol callbacks are updated to honor
+`'wantipv6'`.)
+
+### Single `if` setting for both `usev4=if` and `usev6=if`
+
+The proposed design calls for separate `ifv4` and `ifv6` settings. If
+the user sets `usev4=if,usev6=if`, then the user most likely wants to
+use the same interface for both IPv4 and IPv6. Rather than create
+separate `ifv4` and `ifv6` settings, have a single `if` setting used
+for both `usev4` and `usev6`.
+
+Why this was rejected:
+  * Separate `v4` and `v6` settings adds consistency to the
+    configuration.
+  * There are cases where a user will want to use a different
+    interface. In particular, an IPv6 over IPv4 tunnel (e.g.,
+    https://tunnelbroker.net) involves creating a separate interface
+    that is used only for IPv6.
+
+### Separate IPv4 and IPv6 credentials
+
+In order to support providers that use separate credentials for IPv4
+and IPv6 updates, the proposed design allows the user to define the
+same host twice. We could instead add additional options so that the
+user can provide both sets of credentials in a single host definition.
+
+Why this was rejected:
+  * The proposed design is easier to implement, as it does not require
+    any modifications to existing protocol implementations.
+  * The proposed design is less likely to cause problems for users
+    that rely on globals instead of host-specific options. For
+    example, a configuration file like the following might not do what
+    the user expects:
+
+    ```
+    ssl=true, use=if, if=eth0
+
+    protocol=foo
+    login=username-for-ipv4
+    password=password-for-ipv4
+    loginv6=username-for-ipv6
+    passwordv6=password-for-ipv6
+    myhost.example.com
+
+    protocol=bar
+    login=username
+    password=password
+    # This host definition will use loginv6, passwordv6 from above
+    # because the user didn't end each setting with a line
+    # continuation:
+    my-other-host.example.com
+    ```
+
+  * The proposed design provides some bonus functionality:
+      * Users can smoothly transition between different providers by
+        updating both providers simultaneously until the domain
+        registration switches to the new registrar.
+      * Users can take advantage of providers that support multiple A
+        or multiple AAAA records for the same hostname, assuming each
+        record has independent credentials.

sample-etc_cron.d_ddclient

@@ -1,6 +1,5 @@
 ######################################################################
 ## ddclient is an IP address updater for www.dyndns.org
-## $Id: sample-etc_cron.d_ddclient 96 2008-06-13 20:24:24Z wimpunk $
 ######################################################################
 ## minute         0-59
 ## hour           0-23
@@ -10,8 +9,4 @@
 ######################################################################
 ## force an update twice a month (only if you are not using daemon-mode)
 ##
-## 30 23 1,15 * *	root    /usr/sbin/ddclient -daemon=0 -syslog -quiet -force
-######################################################################
-## retry failed updates every hour (only if you are not using daemon-mode)
-##
-## 0 * * * *	root    /usr/sbin/ddclient -daemon=0 -syslog -quiet retry
+## 30 23 1,15 * *	root    /usr/bin/ddclient -daemon=0 -syslog -quiet -force

sample-etc_ddclient.conf

@@ -1,216 +0,0 @@
-######################################################################
-## 
-## $Id: sample-etc_ddclient.conf 150 2013-04-28 14:55:34Z wimpunk $
-##
-## Define default global variables with lines like:
-## 	var=value [, var=value]*
-## These values will be used for each following host unless overridden
-## with a local variable definition.
-##
-## Define local variables for one or more hosts with:
-## 	var=value [, var=value]* host.and.domain[,host2.and.domain...]
-##
-## Lines can be continued on the following line by ending the line
-## with a \
-##
-##
-## Warning: not all supported routers or dynamic DNS services 
-##          are mentioned here.
-##
-######################################################################
-daemon=300				# check every 300 seconds
-syslog=yes				# log update msgs to syslog
-mail=root				# mail all msgs to root
-mail-failure=root			# mail failed update msgs to root
-pid=/var/run/ddclient.pid		# record PID in file.
-ssl=yes					# use ssl-support.  Works with
-					# ssl-library
-# postscript=script			# run script after updating.  The
-					# new IP is added as argument.
-#
-#use=watchguard-soho,        fw=192.168.111.1:80	# via Watchguard's SOHO FW
-#use=netopia-r910,           fw=192.168.111.1:80	# via Netopia R910 FW
-#use=smc-barricade,          fw=192.168.123.254:80	# via SMC's Barricade FW
-#use=netgear-rt3xx,          fw=192.168.0.1:80		# via Netgear's internet FW
-#use=linksys,                fw=192.168.1.1:80		# via Linksys's internet FW
-#use=maxgate-ugate3x00,      fw=192.168.0.1:80		# via MaxGate's UGATE-3x00  FW
-#use=elsa-lancom-dsl10,      fw=10.0.0.254:80		# via ELSA LanCom DSL/10 DSL Router
-#use=elsa-lancom-dsl10-ch01, fw=10.0.0.254:80		# via ELSA LanCom DSL/10 DSL Router
-#use=elsa-lancom-dsl10-ch02, fw=10.0.0.254:80		# via ELSA LanCom DSL/10 DSL Router
-#use=alcatel-stp,            fw=10.0.0.138:80           # via Alcatel Speed Touch Pro
-#use=xsense-aero,            fw=192.168.1.1:80          # via Xsense Aero Router
-#use=allnet-1298,            fw=192.168.1.1:80          # via AllNet 1298 DSL Router
-#use=3com-oc-remote812,	     fw=192.168.0.254:80	# via 3com OfficeConnect Remote 812
-#use=e-tech,                 fw=192.168.1.1:80          # via E-tech Router
-#use=cayman-3220h,           fw=192.168.0.1:1080        # via Cayman 3220-H DSL Router
-#
-#fw-login=admin,             fw-password=XXXXXX		# FW login and password
-#
-## To obtain an IP address from FW status page (using fw-login, fw-password)
-#use=fw, fw=192.168.1.254/status.htm, fw-skip='IP Address' # found after IP Address
-#
-## To obtain an IP address from Web status page (using the proxy if defined)
-## by default, checkip.dyndns.org is used if you use the dyndns protocol. 
-## Using use=web is enough to get it working.
-## WARNING: set deamon at least to 600 seconds if you use checkip or you could
-## get banned from their service.
-#use=web, web=checkip.dyndns.org/, web-skip='IP Address' # found after IP Address
-#
-#use=ip,                     ip=127.0.0.1	# via static IP's
-#use=if,                     if=eth0		# via interfaces
-#use=web					# via web
-#
-#protocol=dyndns2				# default protocol
-#proxy=fasthttp.sympatico.ca:80			# default proxy
-#server=members.dyndns.org			# default server
-#server=members.dyndns.org:8245			# default server (bypassing proxies)
-
-#login=your-login				# default login
-#password=test					# default password
-#mx=mx.for.your.host				# default MX
-#backupmx=yes|no				# host is primary MX?
-#wildcard=yes|no				# add wildcard CNAME?
-
-##
-## dyndns.org dynamic addresses
-##
-## (supports variables: wildcard,mx,backupmx)
-##
-# server=members.dyndns.org,		\
-# protocol=dyndns2			\
-# your-dynamic-host.dyndns.org
-
-##
-## dyndns.org static addresses
-##
-## (supports variables: wildcard,mx,backupmx)
-##
-# static=yes,				\
-# server=members.dyndns.org,		\
-# protocol=dyndns2			\
-# your-static-host.dyndns.org
-
-##
-##
-## dyndns.org custom addresses
-##
-## (supports variables: wildcard,mx,backupmx)
-##
-# custom=yes,				\
-# server=members.dyndns.org,		\
-# protocol=dyndns2			\
-# your-domain.top-level,your-other-domain.top-level
-
-##
-## ZoneEdit (zoneedit.com)
-##
-# server=dynamic.zoneedit.com, 		\
-# protocol=zoneedit1,			\
-# login=your-zoneedit-login,  		\
-# password=your-zoneedit-password	\
-# your.any.domain,your-2nd.any.dom
-
-##
-## EasyDNS (easydns.com)
-##
-# server=members.easydns.com, 		\
-# protocol=easydns,			\
-# login=your-easydns-login,  		\
-# password=your-easydns-password	\
-# your.any.domain,your-2nd.any.domain
-
-##
-## Hammernode (hn.org) dynamic addresses
-##
-# server=dup.hn.org,             	\
-# protocol=hammernode1,         	\
-# login=your-hn-login,           	\
-# password=your-hn-password      	\
-# your-hn-host.hn.org,your-2nd-hn-host.hn.org
-
-##
-## dslreports.com dynamic-host monitoring
-##
-# server=members.dslreports.com		\
-# protocol=dslreports1,			\
-# login=dslreports-login,		\
-# password=dslreports-password		\
-# dslreports-unique-id
-
-##
-## OrgDNS.org account-configuration
-##
-# use=web, web=members.orgdns.org/nic/ip
-# server=www.orgdns.org 		\
-# protocol=dyndns2 			\
-# login=yourLoginName 			\
-# password=yourPassword 		\
-# yourSubdomain.orgdns.org
-
-##
-## dnspark.com
-## (supports variables: mx, mxpri)
-##
-# use=web, web=ipdetect.dnspark.com, web-skip='Current Address:'
-# protocol=dnspark,			\
-# server=www.dnspark.com,		\
-# your-host.dnspark.com
-
-##
-## NameCheap (namecheap.com)
-##
-# protocol=namecheap,				\
-# server=dynamicdns.park-your-domain.com,	\
-# login=my-namecheap.com-login,			\
-# password=my-namecheap.com-password		\
-# myhost.namecheap.com 
-
-##
-##
-## Loopia (loopia.se)
-##
-# use=web
-# web=loopia
-# protocol=dyndns2
-# server=dns.loopia.se
-# script=/XDynDNSServer/XDynDNS.php
-# login=my-loopia.se-login
-# password=my-loopia.se-password
-# my.domain.tld,other.domain.tld
-
-##
-##
-## ChangeIP (changeip.com)
-##
-## single host update
-# protocol=changeip,                   \
-# login=my-my-changeip.com-login,      \
-# password=my-changeip.com-password    \
-# myhost.changeip.org
-
-##
-## DtDNS (www.dtdns.com)
-##
-# protocol=dtdns,
-# server=www.dtdns.com,
-# client=ddclient,
-# password=my-dtdns.com-password
-# myhost.dtdns.net, otherhost.dtdns.net
-
-##
-## CloudFlare (www.cloudflare.com)
-##
-#protocol=cloudflare,        \
-#zone=domain.tld,            \
-#server=www.cloudflare.com,  \
-#login=your-login-email,     \
-#password=APIKey             \
-#domain.tld,my.domain.tld
-
-##
-## Google Domains (www.google.com/domains)
-##
-# protocol=googledomains,
-# login=my-auto-generated-username,
-# password=my-auto-generated-password
-# my.domain.tld, otherhost.domain.tld

sample-etc_dhclient-exit-hooks

@@ -1,11 +1,9 @@
 #!/bin/sh
 ######################################################################
-## $Id: sample-etc_dhclient-exit-hooks 96 2008-06-13 20:24:24Z wimpunk $
-######################################################################
 # The /etc/dhclient-enter-hooks script is run by the ISC DHCP client's standard
 # update script whenever dhclient obtains or renews an address. 
 
-PATH=/usr/sbin:${PATH}
+PATH=/usr/bin:${PATH}
 case "$new_ip_address" in
 10.*)   	;;
 172.1[6-9].* | 172.2[0-9].* | 172.3[0-1].*)	;;

sample-etc_dhcpc_dhcpcd-eth0.exe

@@ -1,8 +1,6 @@
 #!/bin/sh
 ######################################################################
-## $Id: sample-etc_dhcpc_dhcpcd-eth0.exe 96 2008-06-13 20:24:24Z wimpunk $
-######################################################################
-PATH=/usr/sbin:${PATH}
+PATH=/usr/bin:${PATH}
 
 ## update the DNS server unless the IP address is a private address
 ## that may be used as an internal LAN address. This may be true if

sample-etc_ppp_ip-up.local

@@ -1,7 +1,5 @@
 #!/bin/sh
 ######################################################################
-## $Id: sample-etc_ppp_ip-up.local 128 2011-07-11 20:24:43Z wimpunk $
-######################################################################
 ## 
 ## On my host, pppd invokes this script with args:
 ## /etc/ppp/ip-up.local ppp0 /dev/pts/1 115200 192.168.2.1 192.168.2.3
@@ -16,7 +14,7 @@
 ## in the environment as either PPP_LOCAL or IPLOCAL.
 ##
 ######################################################################
-PATH=/usr/sbin:${PATH}
+PATH=/usr/bin:${PATH}
 IP=
 IP=${IP:-$PPP_LOCAL}
 IP=${IP:-$IPLOCAL}

sample-etc_rc.d_init.d_ddclient

@@ -1,91 +0,0 @@
-#!/bin/bash
-#
-# ddclient      This shell script takes care of starting and stopping
-#               ddclient.
-#
-# chkconfig: 2345 65 35
-# description: ddclient provides support for updating dynamic DNS services.
-
-CONF=/etc/ddclient/ddclient.conf
-program=ddclient
-
-[ -f $CONF ] || exit 0
-
-system=unknown
-if [ -f /etc/fedora-release ]; then
-    system=fedora
-elif [ -f /etc/redhat-release ]; then
-    system=redhat
-elif [ -f /etc/debian_version ]; then
-    system=debian
-fi
-
-PID=''
-if [ "$system" = "fedora" ] || [ "$system" = "redhat" ]; then
-    . /etc/init.d/functions
-    PID=`pidofproc $program`
-else
-    PID=`ps -aef | grep "$program - sleep" | grep -v grep | awk '{print $2}'`
-fi
-
-PATH=/usr/sbin:/usr/local/sbin:${PATH}
-export PATH
-
-# See how we were called.
-case "$1" in
-  start)
-	# Start daemon.
-    DELAY=`grep -v '^\s*#' $CONF | grep -i -m 1 "daemon" | awk -F '=' '{print $2}'`
-    if [ -z "$DELAY" ] ; then
-        DELAY="-daemon 300"
-    else
-        DELAY=''
-    fi
-	echo -n "Starting ddclient: "
-    if [ "$system" = "fedora" ] || [ "$system" = "redhat" ]; then
-        daemon $program $DELAY
-    else
-	    ddclient $DELAY
-    fi
-	echo    
-	;;
-  stop)
-	# Stop daemon.
-	echo -n "Shutting down ddclient: "
-    if [ -n "$PID" ] ; then
-        if [ "$system" = "fedora" ] || [ "$system" = "redhat" ]; then
-            killproc $program
-        else
-	        kill $PID
-        fi
-    else
-        echo "ddclient is not running"
-    fi
-	echo
-	;;
-  restart)
-	$0 stop
-	$0 start
-	;;
-  status)
-    if [ "$system" = "fedora" ] || [ "$system" = "redhat" ]; then
-        status $program
-    else
-	    if test "$PID"
-	    then
-		    for p in $PID
-		    do
-			    echo "$program (pid $p) is running"
-		    done
-	    else
-		    echo "$program is stopped"
-        fi
-	fi
-	;;
-  *)
-	echo "Usage: ddclient {start|stop|restart|status}"
-	exit 1
-esac
-
-exit 0
-

sample-etc_rc.d_init.d_ddclient.alpine

@@ -1,38 +0,0 @@
-#!/sbin/runscript
-description="ddclient Daemon for Alpine"
-command="/usr/sbin/ddclient"
-config_file="/etc/ddclient/ddclient.conf"
-command_args=""
-pidfile=$(grep -v '^\s*#' "${config_file}" | grep -i -m 1 pid= | awk -F '=' '{print $2}')
-delay=$(grep -v '^\s*#' "${config_file}" | grep -i -m 1 "daemon" | awk -F '=' '{print $2}')
-
-if [ -z "${delay}" ]
-then
-	command_args="-daemon 300"
-else
-	command_args=""
-fi
-
-
-depend() {
-    use logger
-    need net
-    after firewall
-}
-
-start() {
-    ebegin "Starting ddclient"
-    start-stop-daemon --start \
-        --exec "${command}" \
-        --pidfile "${pidfile}" \
-        -- \
-        ${command_args}
-    eend $?
-}
-
-stop() {
-    ebegin "Stopping ddclient"
-    start-stop-daemon --stop --exec "${command}" \
-        --pidfile "${pidfile}"
-    eend $?
-}

sample-etc_rc.d_init.d_ddclient.lsb

@@ -1,66 +0,0 @@
-#!/bin/sh
-#
-# ddclient      This shell script takes care of starting and stopping
-#               ddclient.
-#
-# chkconfig: 2345 65 35
-# description: ddclient provides support for updating dynamic DNS services.
-#
-# Above is for RedHat and now the LSB part
-### BEGIN INIT INFO
-# Provides:          ddclient
-# Required-Start:    $syslog $remote_fs
-# Should-Start: $time ypbind sendmail
-# Required-Stop:     $syslog $remote_fs
-# Should-Stop: $time ypbind sendmail
-# Default-Start:     3 5
-# Default-Stop:      0 1 2 6
-# Short-Description: ddclient provides support for updating dynamic DNS services
-# Description:       ddclient is a Perl client used to update dynamic DNS
-#                    entries for accounts on many dynamic DNS services and
-#                    can be used on many types of firewalls
-### END INIT INFO
-# 
-# $Id: sample-etc_rc.d_init.d_ddclient.lsb 96 2008-06-13 20:24:24Z wimpunk $
-#
-###
-
-[ -f /etc/ddclient/ddclient.conf ] || exit 0
-
-DDCLIENT_BIN=/usr/sbin/ddclient
-
-#
-# LSB Standard (SuSE,RedHat,...)
-#
-if [ -f /lib/lsb/init-functions ] ; then
-   . /lib/lsb/init-functions
-fi
-
-# See how we were called.
-case "$1" in
-  start)
-        echo -n "Starting ddclient "
-        start_daemon $DDCLIENT_BIN -daemon 300
-        rc_status -v
-        ;;
-  stop)
-        echo -n "Shutting down ddclient "
-        killproc -TERM `basename $DDCLIENT_BIN`
-        rc_status -v
-        ;;
-  restart)
-        $0 stop
-        $0 start
-        rc_status
-        ;;
-  status)
-        echo -n "Checking for service ddclient "
-        checkproc `basename $DDCLIENT_BIN`w
-        rc_status -v
-        ;;
-  *)
-        echo "Usage: ddclient {start|stop|restart|status}"
-        exit 1
-esac
-
-exit 0

sample-etc_rc.d_init.d_ddclient.redhat

@@ -1,41 +0,0 @@
-#!/bin/sh
-# $Id: sample-etc_rc.d_init.d_ddclient.redhat 96 2008-06-13 20:24:24Z wimpunk $
-# ddclient      This shell script takes care of starting and stopping
-#               ddclient.
-#
-# chkconfig: 2345 65 35
-# description: ddclient provides support for updating dynamic DNS services.
-
-[ -f /etc/ddclient/ddclient.conf ] || exit 0
-
-. /etc/rc.d/init.d/functions
-
-# See how we were called.
-case "$1" in
-  start)
-	# Start daemon.
-	echo -n "Starting ddclient: "
-	touch /var/lock/subsys/ddclient
-	daemon ddclient -daemon 300
-	echo    
-	;;
-  stop)
-	# Stop daemon.
-	echo -n "Shutting down ddclient: "
-	killproc ddclient
-	echo
-	rm -f /var/lock/subsys/ddclient
-	;;
-  restart)
-	$0 stop
-	$0 start
-	;;
-  status)
-	status ddclient
-	;;
-  *)
-	echo "Usage: ddclient {start|stop|restart|status}"
-	exit 1
-esac
-
-exit 0

sample-etc_rc.d_init.d_ddclient.ubuntu

@@ -1,51 +0,0 @@
-#!/bin/sh
-### BEGIN INIT INFO
-# Provides:          ddclient
-# Required-Start:    $remote_fs $syslog $network
-# Required-Stop:     $remote_fs $syslog $network
-# Default-Start:     2 3 4 5
-# Default-Stop:      0 1 6
-# Short-Description: Start ddclient daemon at boot time
-# Description:       Start ddclient that provides support for updating dynamic DNS services.  Originally submitted by paolo martinelli, updated by joe passavanti
-### END INIT INFO
-
-DDCLIENT=/usr/sbin/ddclient
-CONF=/etc/ddclient/ddclient.conf
-PIDFILE=/var/run/ddclient.pid
-
-test -x $DDCLIENT || exit 0
-test -f $CONF || exit 0
-
-. /lib/lsb/init-functions
-
-case "$1" in
-  start)
-      log_begin_msg "Starting ddclient..."
-      DELAY=`grep -v '^\s*#' $CONF | grep -i -m 1 "daemon" | awk -F '=' '{print $2}'`
-      if [ -z "$DELAY" ] ; then
-        DELAY="-daemon 300"
-      else
-        DELAY=''
-      fi
-      start-stop-daemon -S -q -p $PIDFILE -x $DDCLIENT -- $DELAY
-      log_end_msg $?
-      ;;
-  stop)
-      if [ -f $PIDFILE ] ; then
-        log_begin_msg "Stopping ddclient..."
-        start-stop-daemon -K -q -p $PIDFILE
-        log_end_msg $?
-        rm -f $PIDFILE
-      fi
-      ;;
-  restart|reload|force-reload)
-      $0 stop
-      $0 start
-      ;;
-  *)
-      log_success_msg "Usage: $0 {start|stop|restart|reload|force-reload}"
-      exit 1
-      ;;
-esac
-
-exit 0

sample-etc_systemd.service

@@ -0,0 +1,13 @@
+[Unit]
+Description=Dynamic DNS Update Client
+Wants=network-online.target
+After=network-online.target nss-lookup.target
+
+[Service]
+Type=exec
+Environment=daemon_interval=5m
+ExecStart=/usr/bin/ddclient --daemon ${daemon_interval} --foreground
+Restart=on-failure
+
+[Install]
+WantedBy=multi-user.target

sample-get-ip-from-fritzbox

@@ -0,0 +1,21 @@
+#!/bin/bash
+# 
+# Script to fetch IP from fritzbox
+#
+# Contributed by @Rusk85 in request #45
+# Script can be used in the configuration by adding
+#
+#    use=cmd, cmd=/etc/ddclient/get-ip-from-fritzbox
+#
+# All credits for this one liner go to the author of this blog:
+# http://scytale.name/blog/2010/01/fritzbox-wan-ip
+# Disclaimer: It might be necessary to make the script executable
+
+# Set default hostname to connect to the FritzBox
+: ${FRITZ_BOX_HOSTNAME:=fritz.box}
+
+curl -s -H 'Content-Type: text/xml; charset="utf-8"' \
+  -H 'SOAPAction: urn:schemas-upnp-org:service:WANIPConnection:1#GetExternalIPAddress' \
+  -d '<?xml version="1.0" encoding="utf-8"?><s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" s:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <s:Body> <u:GetExternalIPAddress xmlns:u="urn:schemas-upnp-org:service:WANIPConnection:1" /></s:Body></s:Envelope>' \
+  "http://$FRITZ_BOX_HOSTNAME:49000/igdupnp/control/WANIPConn1" | \
+  grep -Eo '\<[[:digit:]]{1,3}(\.[[:digit:]]{1,3}){3}\>'

shell.nix

@@ -0,0 +1,11 @@
+{ pkgs ? import <nixpkgs> { } }:
+
+with pkgs;
+
+mkShellNoCC {
+  buildInputs = [
+    autoconf
+    automake
+    gnumake
+  ];
+}

t/builtinfw_query.pl

@@ -0,0 +1,169 @@
+use Test::More;
+BEGIN { SKIP: { eval { require Test::Warnings; 1; } or skip($@, 1); } }
+BEGIN { eval { require 'ddclient'; } or BAIL_OUT($@); }
+
+sub setbuiltinfw {
+    my ($fw) = @_;
+    no warnings 'once';
+    $ddclient::builtinfw{$fw->{name}} = $fw;
+    %ddclient::ip_strategies = ddclient::builtinfw_strategy($fw->{name});
+    %ddclient::ipv4_strategies = ddclient::builtinfwv4_strategy($fw->{name});
+    %ddclient::ipv6_strategies = ddclient::builtinfwv6_strategy($fw->{name});
+}
+
+my @gotcalls;
+
+my $skip_test_fw = 't/builtinfw_query.pl skip test';
+setbuiltinfw({
+    name => $skip_test_fw,
+    query => sub { return '192.0.2.1 skip1 192.0.2.2 skip2 192.0.2.3'; },
+    queryv4 => sub { return '192.0.2.4 skip1 192.0.2.5 skip3 192.0.2.6'; },
+    queryv6 => sub { return '2001:db8::1 skip1 2001:db8::2 skip4 2001:db8::3'; },
+});
+
+my @skip_test_cases = (
+    {
+        desc => 'query',
+        getip => \&ddclient::get_ip,
+        useopt => 'use',
+        cfgxtra => {},
+        want => '192.0.2.2',
+    },
+    {
+        desc => 'queryv4',
+        getip => \&ddclient::get_ipv4,
+        useopt => 'usev4',
+        cfgxtra => {'fwv4-skip' => 'skip3'},
+        want => '192.0.2.6',
+    },
+    {
+        desc => 'queryv4 with fw-skip fallback',
+        getip => \&ddclient::get_ipv4,
+        useopt => 'usev4',
+        cfgxtra => {},
+        want => '192.0.2.5',
+    },
+    {
+        desc => 'queryv6',
+        getip => \&ddclient::get_ipv6,
+        useopt => 'usev6',
+        cfgxtra => {'fwv6-skip' => 'skip4'},
+        want => '2001:db8::3',
+    },
+    {
+        # Support for --usev6=<builtin> wasn't added until after --fwv6-skip was added, so fallback
+        # to the deprecated --fw-skip option was never needed.
+        desc => 'queryv6 ignores fw-skip',
+        getip => \&ddclient::get_ipv6,
+        useopt => 'usev6',
+        cfgxtra => {},
+        want => '2001:db8::1',
+    },
+);
+
+for my $tc (@skip_test_cases) {
+    my $h = "t/builtinfw_query.pl $tc->{desc}";
+    $ddclient::config{$h} = {
+        $tc->{useopt} => $skip_test_fw,
+        'fw-skip' => 'skip1',
+        %{$tc->{cfgxtra}},
+    };
+    my $got = $tc->{getip}(ddclient::strategy_inputs($tc->{useopt}, $h));
+    is($got, $tc->{want}, $tc->{desc});
+}
+
+my $default_inputs_fw = 't/builtinfw_query.pl default inputs';
+setbuiltinfw({
+    name => $default_inputs_fw,
+    query => sub { my %p = @_; push(@gotcalls, \%p); return '192.0.2.1'; },
+    queryv4 => sub { my %p = @_; push(@gotcalls, \%p); return '192.0.2.2'; },
+    queryv6 => sub { my %p = @_; push(@gotcalls, \%p); return '2001:db8::1'; },
+});
+my @default_inputs_test_cases = (
+    {
+        desc => 'use with default inputs',
+        getip => \&ddclient::get_ip,
+        useopt => 'use',
+        want => {use => $default_inputs_fw, fw => 'server', 'fw-skip' => 'skip',
+                 'fw-login' => 'login', 'fw-password' => 'password', 'fw-ssl-validate' => 1},
+    },
+    {
+        desc => 'usev4 with default inputs',
+        getip => \&ddclient::get_ipv4,
+        useopt => 'usev4',
+        want => {usev4 => $default_inputs_fw, fwv4 => 'serverv4', fw => 'server',
+                 'fwv4-skip' => 'skipv4', 'fw-skip' => 'skip', 'fw-login' => 'login',
+                 'fw-password' => 'password', 'fw-ssl-validate' => 1},
+    },
+    {
+        desc => 'usev6 with default inputs',
+        getip => \&ddclient::get_ipv6,
+        useopt => 'usev6',
+        want => {usev6 => $default_inputs_fw, fwv6 => 'serverv6', 'fwv6-skip' => 'skipv6'},
+    },
+);
+for my $tc (@default_inputs_test_cases) {
+    my $h = "t/builtinfw_query.pl $tc->{desc}";
+    $ddclient::config{$h} = {
+        $tc->{useopt} => $default_inputs_fw,
+        'fw' => 'server',
+        'fwv4' => 'serverv4',
+        'fwv6' => 'serverv6',
+        'fw-login' => 'login',
+        'fw-password' => 'password',
+        'fw-ssl-validate' => 1,
+        'fw-skip' => 'skip',
+        'fwv4-skip' => 'skipv4',
+        'fwv6-skip' => 'skipv6',
+    };
+    @gotcalls = ();
+    $tc->{getip}(ddclient::strategy_inputs($tc->{useopt}, $h));
+    is_deeply(\@gotcalls, [$tc->{want}], $tc->{desc});
+}
+
+my $custom_inputs_fw = 't/builtinfw_query.pl custom inputs';
+setbuiltinfw({
+    name => $custom_inputs_fw,
+    query => sub { my %p = @_; push(@gotcalls, \%p); return '192.0.2.1'; },
+    inputs => ['if'],
+    queryv4 => sub { my %p = @_; push(@gotcalls, \%p); return '192.0.2.2'; },
+    inputsv4 => ['ifv4'],
+    queryv6 => sub { my %p = @_; push(@gotcalls, \%p); return '2001:db8::1'; },
+    inputsv6 => ['ifv6'],
+});
+
+my @custom_inputs_test_cases = (
+    {
+        desc => 'use with custom inputs',
+        getip => \&ddclient::get_ip,
+        useopt => 'use',
+        want => {use => $custom_inputs_fw, if => 'eth0'},
+    },
+    {
+        desc => 'usev4 with custom inputs',
+        getip => \&ddclient::get_ipv4,
+        useopt => 'usev4',
+        want => {usev4 => $custom_inputs_fw, ifv4 => 'eth4'},
+    },
+    {
+        desc => 'usev6 with custom inputs',
+        getip => \&ddclient::get_ipv6,
+        useopt => 'usev6',
+        want => {usev6 => $custom_inputs_fw, ifv6 => 'eth6'},
+    },
+);
+
+for my $tc (@custom_inputs_test_cases) {
+    my $h = "t/builtinfw_query.pl $tc->{desc}";
+    $ddclient::config{$h} = {
+        $tc->{useopt} => $custom_inputs_fw,
+        'if' => 'eth0',
+        'ifv4' => 'eth4',
+        'ifv6' => 'eth6',
+    };
+    @gotcalls = ();
+    $tc->{getip}(ddclient::strategy_inputs($tc->{useopt}, $h));
+    is_deeply(\@gotcalls, [$tc->{want}], $tc->{desc});
+}
+
+done_testing();

t/check_value.pl

@@ -0,0 +1,53 @@
+use Test::More;
+use strict;
+SKIP: { eval { require Test::Warnings; } or skip($@, 1); }
+eval { require 'ddclient'; } or BAIL_OUT($@);
+
+my @test_cases = (
+    {
+        type  => ddclient::T_FQDN(),
+        input => 'example.com',
+        want  => 'example.com',
+    },
+    {
+        type  => ddclient::T_FQDN(),
+        input => 'example',
+        want_invalid => 1,
+    },
+    {
+        type  => ddclient::T_URL(),
+        input => 'https://www.example.com',
+        want  => 'https://www.example.com',
+    },
+    {
+        type  => ddclient::T_URL(),
+        input => 'https://directnic.com/dns/gateway/ad133/',
+        want  => 'https://directnic.com/dns/gateway/ad133/',
+    },
+    {
+        type  => ddclient::T_URL(),
+        input => 'HTTPS://MixedCase.com/',
+        want  => 'HTTPS://MixedCase.com/',
+    },
+    {
+        type  => ddclient::T_URL(),
+        input => 'ftp://bad.protocol/',
+        want_invalid => 1,
+    },
+    {
+        type  => ddclient::T_URL(),
+        input => 'bad-url',
+        want_invalid => 1,
+    },
+);
+for my $tc (@test_cases) {
+    my $got;
+    my $got_invalid = !(eval {
+        $got = ddclient::check_value($tc->{input},
+                                     ddclient::setv($tc->{type}, 0, 0, undef, undef));
+        1;
+    });
+    is($got_invalid, !!$tc->{want_invalid}, "$tc->{type}: $tc->{input}: validity");
+    is($got, $tc->{want}, "$tc->{type}: $tc->{input}: normalization") if !$tc->{want_invalid};
+}
+done_testing();

t/get_ip_from_if.pl

@@ -0,0 +1,65 @@
+use Test::More;
+BEGIN { SKIP: { eval { require Test::Warnings; 1; } or skip($@, 1); } }
+BEGIN { eval { require 'ddclient'; } or BAIL_OUT($@); }
+use ddclient::t;
+
+subtest "get_default_interface tests" => sub {
+    for my $sample (@ddclient::t::routing_samples) {
+        if (defined($sample->{want_ipv4_if})) {
+            my $interface = ddclient::get_default_interface(4, $sample->{text});
+            is($interface, $sample->{want_ipv4_if}, $sample->{name});
+        }
+        if (defined($sample->{want_ipv6_if})) {
+            my $interface = ddclient::get_default_interface(6, $sample->{text});
+            is($interface, $sample->{want_ipv6_if}, $sample->{name});
+        }
+    }
+};
+
+subtest "get_ip_from_interface tests" => sub {
+    for my $sample (@ddclient::t::interface_samples) {
+        # interface name is undef as we are passing in test data
+        if (defined($sample->{want_ipv4_from_if})) {
+            my $ip = ddclient::get_ip_from_interface(undef, 4, undef, $sample->{text}, $sample->{MacOS});
+            is($ip, $sample->{want_ipv4_from_if}, $sample->{name});
+        }
+        if (defined($sample->{want_ipv6gua_from_if})) {
+            my $ip = ddclient::get_ip_from_interface(undef, 6, 'gua', $sample->{text}, $sample->{MacOS});
+            is($ip, $sample->{want_ipv6gua_from_if}, $sample->{name});
+        }
+        if (defined($sample->{want_ipv6ula_from_if})) {
+            my $ip = ddclient::get_ip_from_interface(undef, 6, 'ula', $sample->{text}, $sample->{MacOS});
+            is($ip, $sample->{want_ipv6ula_from_if}, $sample->{name});
+        }
+    }
+};
+
+subtest "Get default interface and IP for test system (IPv4)" => sub {
+    my $interface = ddclient::get_default_interface(4);
+    plan(skip_all => 'no IPv4 interface') if !$interface;
+    isnt($interface, "lo", "Check for loopback 'lo'");
+    isnt($interface, "lo0", "Check for loopback 'lo0'");
+    my $ip1 = ddclient::get_ip_from_interface("default", 4);
+    my $ip2 = ddclient::get_ip_from_interface($interface, 4);
+    is($ip1, $ip2, "Check IPv4 from default interface");
+    SKIP: {
+        skip('default interface does not have an appropriate IPv4 addresses') if !$ip1;
+        ok(ddclient::is_ipv4($ip1), "Valid IPv4 from get_ip_from_interface($interface)");
+    }
+};
+
+subtest "Get default interface and IP for test system (IPv6)" => sub {
+    my $interface = ddclient::get_default_interface(6);
+    plan(skip_all => 'no IPv6 interface') if !$interface;
+    isnt($interface, "lo", "Check for loopback 'lo'");
+    isnt($interface, "lo0", "Check for loopback 'lo0'");
+    my $ip1 = ddclient::get_ip_from_interface("default", 6);
+    my $ip2 = ddclient::get_ip_from_interface($interface, 6);
+    is($ip1, $ip2, "Check IPv6 from default interface");
+    SKIP: {
+        skip('default interface does not have an appropriate IPv6 addresses') if !$ip1;
+        ok(ddclient::is_ipv6($ip1), "Valid IPv6 from get_ip_from_interface($interface)");
+    }
+};
+
+done_testing();

t/geturl_connectivity.pl

@@ -0,0 +1,57 @@
+use Test::More;
+BEGIN { SKIP: { eval { require Test::Warnings; 1; } or skip($@, 1); } }
+BEGIN { eval { require 'ddclient'; } or BAIL_OUT($@); }
+use ddclient::t::HTTPD;
+use ddclient::t::ip;
+
+httpd_required();
+
+$ddclient::globals{'ssl_ca_file'} = $ca_file;
+
+for my $ipv ('4', '6') {
+    for my $ssl (0, 1) {
+        my $httpd = httpd($ipv, $ssl) or next;
+        $httpd->run(sub {
+            return [200, ['Content-Type' => 'application/octet-stream'], [$_[0]->as_string()]];
+        });
+    }
+}
+
+my @test_cases = (
+    {ipv6_opt => 0, server_ipv => '4', client_ipv => ''},
+    {ipv6_opt => 0, server_ipv => '4', client_ipv => '4'},
+    # IPv* client to a non-SSL IPv6 server is not expected to work unless opt('ipv6') is true
+    {ipv6_opt => 0, server_ipv => '6', client_ipv => '6'},
+
+    # Fetch without ssl
+    { server_ipv => '4', client_ipv => '' },
+    { server_ipv => '4', client_ipv => '4' },
+    { server_ipv => '6', client_ipv => '' },
+    { server_ipv => '6', client_ipv => '6' },
+
+    # Fetch with ssl
+    { ssl => 1, server_ipv => '4', client_ipv => '' },
+    { ssl => 1, server_ipv => '4', client_ipv => '4' },
+    { ssl => 1, server_ipv => '6', client_ipv => '' },
+    { ssl => 1, server_ipv => '6', client_ipv => '6' },
+);
+
+for my $tc (@test_cases) {
+    $tc->{ipv6_opt} //= 0;
+    $tc->{ssl} //= 0;
+    SKIP: {
+        skip("IPv6 not supported on this system", 1)
+            if $tc->{server_ipv} eq '6' && !$ipv6_supported;
+        skip("HTTP::Daemon too old for IPv6 support", 1)
+            if $tc->{server_ipv} eq '6' && !$httpd_ipv6_supported;
+        skip("HTTP::Daemon::SSL not available", 1) if $tc->{ssl} && !$httpd_ssl_supported;
+        my $uri = httpd($tc->{server_ipv}, $tc->{ssl})->endpoint();
+        my $name = sprintf("IPv%s client to %s%s",
+                           $tc->{client_ipv} || '*', $uri, $tc->{ipv6_opt} ? ' (-ipv6)' : '');
+        $ddclient::globals{'ipv6'} = $tc->{ipv6_opt};
+        my $got = ddclient::geturl(url => $uri, ipversion => $tc->{client_ipv});
+        isnt($got // '', '', $name);
+    }
+}
+
+done_testing();

t/geturl_response.pl

@@ -0,0 +1,27 @@
+use Test::More;
+SKIP: { eval { require Test::Warnings; } or skip($@, 1); }
+eval { require 'ddclient'; } or BAIL_OUT($@);
+
+# Fake curl.  Use the printf utility, which can process escapes.  This allows Perl to drive the fake
+# curl with plain ASCII and get arbitrary bytes back, avoiding problems caused by any encoding that
+# might be done by Perl (e.g., "use open ':encoding(UTF-8)';").
+my @fakecurl = ('sh', '-c', 'printf %b "$1"', '--');
+
+my @test_cases = (
+    {
+        desc => 'binary body',
+        # Body is UTF-8 encoded ✨ (U+2728 Sparkles) followed by a 0xff byte (invalid UTF-8).
+        printf => join('\r\n', ('HTTP/1.1 200 OK', '', '\0342\0234\0250\0377')),
+        # The raw bytes should come through as equally valued codepoints.  They must not be decoded.
+        want => "HTTP/1.1 200 OK\n\n\xe2\x9c\xa8\xff",
+    },
+);
+
+for my $tc (@test_cases) {
+    @ddclient::curl = (@fakecurl, $tc->{printf});
+    $ddclient::curl if 0;  # suppress spurious warning "Name used only once: possible typo"
+    my $got = ddclient::geturl(url => 'http://ignored');
+    is($got, $tc->{want}, $tc->{desc});
+}
+
+done_testing();

t/group_hosts_by.pl

@@ -0,0 +1,113 @@
+use Test::More;
+SKIP: { eval { require Test::Warnings; } or skip($@, 1); }
+eval { require 'ddclient'; } or BAIL_OUT($@);
+eval { require Data::Dumper; } or skip($@, 1);
+Data::Dumper->import();
+
+my $h1 = 'h1';
+my $h2 = 'h2';
+my $h3 = 'h3';
+
+$ddclient::config{$h1} = {
+    common => 'common',
+    h1h2 => 'h1 and h2',
+    unique => 'h1',
+    falsy => 0,
+    maybeunset => 'unique',
+};
+$ddclient::config{$h2} = {
+    common => 'common',
+    h1h2 => 'h1 and h2',
+    unique => 'h2',
+    falsy => '',
+    maybeunset => undef,  # should not be grouped with unset
+};
+$ddclient::config{$h3} = {
+    common => 'common',
+    h1h2 => 'unique',
+    unique => 'h3',
+    falsy => undef,
+    # maybeunset is intentionally not set
+};
+
+my @test_cases = (
+    {
+        desc => 'empty attribute set yields single group with all hosts',
+        groupby => [qw()],
+        want => [{cfg => {}, hosts => [$h1, $h2, $h3]}],
+    },
+    {
+        desc => 'common attribute yields single group with all hosts',
+        groupby => [qw(common)],
+        want => [{cfg => {common => 'common'}, hosts => [$h1, $h2, $h3]}],
+    },
+    {
+        desc => 'subset share a value',
+        groupby => [qw(h1h2)],
+        want => [
+            {cfg => {h1h2 => 'h1 and h2'}, hosts => [$h1, $h2]},
+            {cfg => {h1h2 => 'unique'}, hosts => [$h3]},
+        ],
+    },
+    {
+        desc => 'all unique',
+        groupby => [qw(unique)],
+        want => [
+            {cfg => {unique => 'h1'}, hosts => [$h1]},
+            {cfg => {unique => 'h2'}, hosts => [$h2]},
+            {cfg => {unique => 'h3'}, hosts => [$h3]},
+        ],
+    },
+    {
+        desc => 'combination',
+        groupby => [qw(common h1h2)],
+        want => [
+            {cfg => {common => 'common', h1h2 => 'h1 and h2'}, hosts => [$h1, $h2]},
+            {cfg => {common => 'common', h1h2 => 'unique'}, hosts => [$h3]},
+        ],
+    },
+    {
+        desc => 'falsy values',
+        groupby => [qw(falsy)],
+        want => [
+            {cfg => {falsy => 0}, hosts => [$h1]},
+            {cfg => {falsy => ''}, hosts => [$h2]},
+            # undef intentionally becomes unset because undef always means "fall back to global or
+            # default".
+            {cfg => {}, hosts => [$h3]},
+        ],
+    },
+    {
+        desc => 'set, unset, undef',
+        groupby => [qw(maybeunset)],
+        want => [
+            {cfg => {maybeunset => 'unique'}, hosts => [$h1]},
+            # undef intentionally becomes unset because undef always means "fall back to global or
+            # default".
+            {cfg => {}, hosts => [$h2, $h3]},
+        ],
+    },
+    {
+        desc => 'missing attribute',
+        groupby => [qw(thisdoesnotexist)],
+        want => [{cfg => {}, hosts => [$h1, $h2, $h3]}],
+    },
+);
+
+for my $tc (@test_cases) {
+    my @got = ddclient::group_hosts_by([$h1, $h2, $h3], @{$tc->{groupby}});
+    # @got is used as a set of sets.  Sort everything to make comparison easier.
+    $_->{hosts} = [sort(@{$_->{hosts}})] for @got;
+    @got = sort({
+        for (my $i = 0; $i < @{$a->{hosts}} && $i < @{$b->{hosts}}; ++$i) {
+            my $x = $a->{hosts}[$i] cmp $b->{hosts}[$i];
+            return $x if $x != 0;
+        }
+        return @{$a->{hosts}} <=> @{$b->{hosts}};
+    } @got);
+    is_deeply(\@got, $tc->{want}, $tc->{desc})
+        or diag(Data::Dumper->new([\@got, $tc->{want}],
+                                  [qw(got want)])->Sortkeys(1)->Useqq(1)->Dump());
+}
+
+done_testing();

t/header_ok.pl

@@ -0,0 +1,74 @@
+use Test::More;
+SKIP: { eval { require Test::Warnings; } or skip($@, 1); }
+eval { require 'ddclient'; } or BAIL_OUT($@);
+my $have_mock = eval { require Test::MockModule; };
+
+my $failmsg;
+my $module;
+if ($have_mock) {
+    $module = Test::MockModule->new('ddclient');
+    # Note: 'mock' is used instead of 'redefine' because 'redefine' is not available in the versions
+    # of Test::MockModule distributed with old Debian and Ubuntu releases.
+    $module->mock('failed', sub { $failmsg //= ''; $failmsg .= sprintf(shift, @_) . "\n"; });
+}
+
+my @test_cases = (
+    {
+        desc => 'malformed not OK',
+        input => 'malformed',
+        want => 0,
+        wantmsg => qr/unexpected/,
+    },
+    {
+        desc => 'HTTP/1.1 200 OK',
+        input => 'HTTP/1.1 200 OK',
+        want => 1,
+    },
+    {
+        desc => 'HTTP/2 200 OK',
+        input => 'HTTP/2 200 OK',
+        want => 1,
+    },
+    {
+        desc => 'HTTP/3 200 OK',
+        input => 'HTTP/3 200 OK',
+        want => 1,
+    },
+    {
+        desc => '401 not OK, fallback message',
+        input => 'HTTP/1.1 401 ',
+        want => 0,
+        wantmsg => qr/authentication failed/,
+    },
+    {
+        desc => '403 not OK, fallback message',
+        input => 'HTTP/1.1 403 ',
+        want => 0,
+        wantmsg => qr/not authorized/,
+    },
+    {
+        desc => 'other 4xx not OK',
+        input => 'HTTP/1.1 456 bad',
+        want => 0,
+        wantmsg => qr/bad/,
+    },
+    {
+        desc => 'only first line is logged on error',
+        input => "HTTP/1.1 404 not found\n\nbody",
+        want => 0,
+        wantmsg => qr/(?!body)/,
+    },
+);
+
+for my $tc (@test_cases) {
+    subtest $tc->{desc} => sub {
+        $failmsg = '';
+        is(ddclient::header_ok($tc->{input}), $tc->{want}, 'return value matches');
+        SKIP: {
+            skip('Test::MockModule not available') if !$have_mock;
+            like($failmsg, $tc->{wantmsg} // qr/^$/, 'fail message matches');
+        }
+    };
+}
+
+done_testing();

t/interval_expired.pl

@@ -0,0 +1,51 @@
+use Test::More;
+SKIP: { eval { require Test::Warnings; } or skip($@, 1); }
+eval { require 'ddclient'; } or BAIL_OUT($@);
+
+my $h = 't/interval_expired.pl';
+
+my $default_now = 1000000000;
+
+my @test_cases = (
+    {
+        interval => 'inf',
+        want => 0,
+    },
+    {
+        now => 'inf',
+        interval => 'inf',
+        want => 0,
+    },
+    {
+        cache => '-inf',
+        interval => 'inf',
+        want => 0,
+    },
+    {
+        cache => undef,  # Falsy cache value.
+        interval => 'inf',
+        want => 0,
+    },
+    {
+        now => 0,
+        cache => 0,  # Different kind of falsy cache value.
+        interval => 'inf',
+        want => 0,
+    },
+);
+
+for my $tc (@test_cases) {
+    $tc->{now} //= $default_now;
+    # For convenience, $tc->{cache} is an offset from $tc->{now}, not an absolute time..
+    my $cachetime = $tc->{now} + $tc->{cache} if defined($tc->{cache});
+    $ddclient::config{$h} = {'interval' => $tc->{interval}};
+    %ddclient::config if 0;  # suppress spurious warning "Name used only once: possible typo"
+    $ddclient::cache{$h} = {'cached-time' => $cachetime} if defined($cachetime);
+    %ddclient::cache if 0;  # suppress spurious warning "Name used only once: possible typo"
+    $ddclient::now = $tc->{now};
+    $ddclient::now if 0; # suppress spurious warning "Name used only once: possible typo"
+    my $desc = "now=$tc->{now}, cache=${\($cachetime // 'undef')}, interval=$tc->{interval}";
+    is(ddclient::interval_expired($h, 'cached-time', 'interval'), $tc->{want}, $desc);
+}
+
+done_testing();

t/is-and-extract-ipv4.pl

@@ -0,0 +1,83 @@
+use Test::More;
+use B qw(perlstring);
+
+SKIP: { eval { require Test::Warnings; } or skip($@, 1); }
+eval { require 'ddclient'; } or BAIL_OUT($@);
+
+
+my @valid_ipv4 = (
+    "192.168.1.1",
+    "0.0.0.0",
+    "000.000.000.000",
+    "255.255.255.255",
+    "10.0.0.0",
+);
+
+my @invalid_ipv4 = (
+    undef,
+    "",
+    "192.168.1",
+    "0.0.0",
+    "000.000",
+    "256.256.256.256",
+    ".10.0.0.0",
+);
+
+
+subtest "is_ipv4() with valid addresses" => sub {
+    foreach my $ip (@valid_ipv4) {
+        ok(ddclient::is_ipv4($ip), "is_ipv4('$ip')");
+    }
+};
+
+subtest "is_ipv4() with invalid addresses" => sub {
+    foreach my $ip (@invalid_ipv4) {
+        ok(!ddclient::is_ipv4($ip), sprintf("!is_ipv4(%s)", defined($ip) ? "'$ip'" : 'undef'));
+    }
+};
+
+subtest "is_ipv4() with char adjacent to valid address" => sub {
+    foreach my $ch (split(//, '/.,:z @$#&%!^*()_-+'), "\n") {
+        subtest perlstring($ch) => sub {
+            foreach my $ip (@valid_ipv4) {
+                subtest $ip => sub {
+                    my $test = $ch . $ip;  # insert at front
+                    ok(!ddclient::is_ipv4($test), "!is_ipv4('$test')");
+                    $test = $ip . $ch;  # add at end
+                    ok(!ddclient::is_ipv4($test), "!is_ipv4('$test')");
+                    $test = $ch . $ip . $ch; # wrap front and end
+                    ok(!ddclient::is_ipv4($test), "!is_ipv4('$test')");
+                };
+            }
+        };
+    }
+};
+
+subtest "extract_ipv4()" => sub {
+    my @test_cases = (
+        {name => "undef",     text => undef,              want => undef},
+        {name => "empty",     text => "",                 want => undef},
+        {name => "invalid",   text => "1.2.3.256",        want => undef},
+        {name => "two addrs", text => "1.1.1.1\n2.2.2.2", want => "1.1.1.1"},
+        {name => "host+port", text => "1.2.3.4:123",      want => "1.2.3.4"},
+        {name => "zero pad",  text => "001.002.003.004",  want => "1.2.3.4"},
+    );
+    foreach my $tc (@test_cases) {
+        is(ddclient::extract_ipv4($tc->{text}), $tc->{want}, $tc->{name});
+    }
+};
+
+subtest "extract_ipv4() of valid addr with adjacent non-word char" => sub {
+    foreach my $wb (split(//, '/, @$#&%!^*()_-+:'), "\n") {
+        subtest perlstring($wb) => sub {
+            my $test = "";
+            foreach my $ip (@valid_ipv4) {
+                $test = "foo" . $wb . $ip . $wb . "bar"; # wrap front and end
+                $ip =~ s/\b0+\B//g; ## remove embedded leading zeros for testing
+                is(ddclient::extract_ipv4($test), $ip, perlstring($test));
+            }
+        };
+    }
+};
+
+done_testing();

t/is-and-extract-ipv6-global.pl

@@ -0,0 +1,66 @@
+use Test::More;
+use ddclient::t;
+SKIP: { eval { require Test::Warnings; } or skip($@, 1); }
+eval { require 'ddclient'; } or BAIL_OUT($@);
+
+subtest "is_ipv6_global() with valid but non-globally-routable addresses" => sub {
+    foreach my $ip (
+        # The entirety of ::/16 is assumed to never contain globally routable addresses
+        "::",
+        "::1",
+        "0:ffff:ffff:ffff:ffff:ffff:ffff:ffff",
+        # fc00::/7 unique local addresses (ULA)
+        "fc00::",
+        "fdff:ffff:ffff:ffff:ffff:ffff:ffff:ffff",
+        # fe80::/10 link-local unicast addresses
+        "fe80::",
+        "febf:ffff:ffff:ffff:ffff:ffff:ffff:ffff",
+        # ff00::/8 multicast addresses
+        "ff00::",
+        "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff",
+        # Case insensitivity of the negative lookahead
+        "FF00::",
+    ) {
+        ok(!ddclient::is_ipv6_global($ip), "!is_ipv6_global('$ip')");
+    }
+};
+
+subtest "is_ipv6_global() with valid, globally routable addresses" => sub {
+    foreach my $ip (
+        "1::",                                      # just after ::/16 assumed non-global block
+        "fbff:ffff:ffff:ffff:ffff:ffff:ffff:ffff",  # just before fc00::/7 ULA block
+        "fe00::",                                   # just after  fc00::/7 ULA block
+        "fe7f:ffff:ffff:ffff:ffff:ffff:ffff:ffff",  # just before fe80::/10 link-local block
+        "fec0::",                                   # just after  fe80::/10 link-local block
+        "feff:ffff:ffff:ffff:ffff:ffff:ffff:ffff",  # just before ff00::/8 multicast block
+    ) {
+        ok(ddclient::is_ipv6_global($ip), "is_ipv6_global('$ip')");
+    }
+};
+
+subtest "extract_ipv6_global()" => sub {
+    my @test_cases = (
+        {name => "undef",                    text => undef,            want => undef},
+        {name => "empty",                    text => "",               want => undef},
+        {name => "only non-global",          text => "foo fe80:: bar", want => undef},
+        {name => "single global",            text => "foo 2000:: bar", want => "2000::"},
+        {name => "multiple globals",         text => "2000:: 3000::",  want => "2000::"},
+        {name => "global before non-global", text => "2000:: fe80::",  want => "2000::"},
+        {name => "non-global before global", text => "fe80:: 2000::",  want => "2000::"},
+        {name => "zero pad",                 text => "2001::0001",     want => "2001::1"},
+    );
+    foreach my $tc (@test_cases) {
+        is(ddclient::extract_ipv6_global($tc->{text}), $tc->{want}, $tc->{name});
+    }
+};
+
+subtest "interface config samples" => sub {
+    for my $sample (@ddclient::t::interface_samples) {
+        if (defined($sample->{want_extract_ipv6_global})) {
+            my $got = ddclient::extract_ipv6_global($sample->{text});
+            is($got, $sample->{want_extract_ipv6_global}, $sample->{name});
+        }
+    }
+};
+
+done_testing();

t/is-and-extract-ipv6.pl

@@ -0,0 +1,441 @@
+use Test::More;
+use B qw(perlstring);
+use ddclient::t;
+SKIP: { eval { require Test::Warnings; } or skip($@, 1); }
+eval { require 'ddclient'; } or BAIL_OUT($@);
+
+
+my @valid_ipv6 = (
+    "::abcd:efAB:CDEF",  # case sensitivity
+    "08:09:0a:0b:0c:0d:0e:0f",  # leading zeros
+
+    # with thanks to http://home.deds.nl/~aeron/regex/valid_ipv6.txt
+    "1111:2222:3333:4444:5555:6666:7777:8888",
+    "1111:2222:3333:4444:5555:6666:7777::",
+    "1111:2222:3333:4444:5555:6666::",
+    "1111:2222:3333:4444:5555::",
+    "1111:2222:3333:4444::",
+    "1111:2222:3333::",
+    "1111:2222::",
+    "1111::",
+    "::",
+    "1111:2222:3333:4444:5555:6666::8888",
+    "1111:2222:3333:4444:5555::8888",
+    "1111:2222:3333:4444::8888",
+    "1111:2222:3333::8888",
+    "1111:2222::8888",
+    "1111::8888",
+    "::8888",
+    "1111:2222:3333:4444:5555::7777:8888",
+    "1111:2222:3333:4444::7777:8888",
+    "1111:2222:3333::7777:8888",
+    "1111:2222::7777:8888",
+    "1111::7777:8888",
+    "::7777:8888",
+    "1111:2222:3333:4444::6666:7777:8888",
+    "1111:2222:3333::6666:7777:8888",
+    "1111:2222::6666:7777:8888",
+    "1111::6666:7777:8888",
+    "::6666:7777:8888",
+    "1111:2222:3333::5555:6666:7777:8888",
+    "1111:2222::5555:6666:7777:8888",
+    "1111::5555:6666:7777:8888",
+    "::5555:6666:7777:8888",
+    "1111:2222::4444:5555:6666:7777:8888",
+    "1111::4444:5555:6666:7777:8888",
+    "::4444:5555:6666:7777:8888",
+    "1111::3333:4444:5555:6666:7777:8888",
+    "::3333:4444:5555:6666:7777:8888",
+    "::2222:3333:4444:5555:6666:7777:8888",
+    # IPv4-mapped IPv6 addresses
+    "1111:2222:3333:4444:5555:6666:0.0.0.0",
+    "1111:2222:3333:4444:5555:6666:00.00.00.00",
+    "1111:2222:3333:4444:5555:6666:000.000.000.000",
+    "1111:2222:3333:4444:5555:6666:123.123.123.123",
+    "1111:2222:3333:4444:5555::123.123.123.123",
+    "1111:2222:3333:4444::123.123.123.123",
+    "1111:2222:3333::123.123.123.123",
+    "1111:2222::123.123.123.123",
+    "1111::123.123.123.123",
+    "::123.123.123.123",
+    "1111:2222:3333:4444::6666:123.123.123.123",
+    "1111:2222:3333::6666:123.123.123.123",
+    "1111:2222::6666:123.123.123.123",
+    "1111::6666:123.123.123.123",
+    "::6666:123.123.123.123",
+    "1111:2222:3333::5555:6666:123.123.123.123",
+    "1111:2222::5555:6666:123.123.123.123",
+    "1111::5555:6666:123.123.123.123",
+    "::5555:6666:123.123.123.123",
+    "1111:2222::4444:5555:6666:123.123.123.123",
+    "1111::4444:5555:6666:123.123.123.123",
+    "::4444:5555:6666:123.123.123.123",
+    "1111::3333:4444:5555:6666:123.123.123.123",
+    "::3333:4444:5555:6666:123.123.123.123",
+    "::2222:3333:4444:5555:6666:123.123.123.123",
+);
+
+my @invalid_ipv6 = (
+    # Empty string and bogus text
+    undef,
+    "",
+    "   ",
+    "foobar",
+
+    # Valid IPv6 with extra text before or after
+    "foo2001:DB8:4341:0781:1111:2222:3333:4444",
+    "foo 2001:DB8:4341:0781::4444",
+    "foo 2001:DB8:4341:0781:1111:: bar",
+    "foo2001:DB8:4341:0781::100bar",
+    "2001:DB8:4341:0781::1 bar",
+    "2001:DB8:4341:0781::0001bar",
+    "foo bar 3001:DB8:4341:0781:1111:2222:3333:4444 foo bar",
+    "__3001:DB8:4341:0781::4444",
+    "__3001:DB8:4341:0781:1111::__",
+    "--3001:DB8:4341:0781::100--",
+    "/3001:DB8:4341:0781::1/",
+    "3001:DB8:4341:0781::0001%",
+    "fdb6:1d86:d9bd:1::4444%eth0",
+    "fdb6:1d86:d9bd:1:1111::%ens192",
+    "fdb6:1d86:d9bd:1::100%en0",
+    "fdb6:1d86:d9bd:1::1%eth1.100",
+
+    # With thanks to http://home.deds.nl/~aeron/regex/invalid_ipv6.txt
+    # Invalid data
+    "XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX",
+
+    # Too many components
+    "1111:2222:3333:4444:5555:6666:7777:8888:9999",
+    "1111:2222:3333:4444:5555:6666:7777:8888::",
+    "::2222:3333:4444:5555:6666:7777:8888:9999",
+
+    # Too few components
+    "1111:2222:3333:4444:5555:6666:7777",
+    "1111:2222:3333:4444:5555:6666",
+    "1111:2222:3333:4444:5555",
+    "1111:2222:3333:4444",
+    "1111:2222:3333",
+    "1111:2222",
+    "1111",
+
+    # Missing :
+    "11112222:3333:4444:5555:6666:7777:8888",
+    "1111:22223333:4444:5555:6666:7777:8888",
+    "1111:2222:33334444:5555:6666:7777:8888",
+    "1111:2222:3333:44445555:6666:7777:8888",
+    "1111:2222:3333:4444:55556666:7777:8888",
+    "1111:2222:3333:4444:5555:66667777:8888",
+    "1111:2222:3333:4444:5555:6666:77778888",
+
+    # Missing : intended for ::
+    "1111:2222:3333:4444:5555:6666:7777:8888:",
+    "1111:2222:3333:4444:5555:6666:7777:",
+    "1111:2222:3333:4444:5555:6666:",
+    "1111:2222:3333:4444:5555:",
+    "1111:2222:3333:4444:",
+    "1111:2222:3333:",
+    "1111:2222:",
+    "1111:",
+    ":",
+    ":8888",
+    ":7777:8888",
+    ":6666:7777:8888",
+    ":5555:6666:7777:8888",
+    ":4444:5555:6666:7777:8888",
+    ":3333:4444:5555:6666:7777:8888",
+    ":2222:3333:4444:5555:6666:7777:8888",
+    ":1111:2222:3333:4444:5555:6666:7777:8888",
+
+    # :::
+    ":::2222:3333:4444:5555:6666:7777:8888",
+    "1111:::3333:4444:5555:6666:7777:8888",
+    "1111:2222:::4444:5555:6666:7777:8888",
+    "1111:2222:3333:::5555:6666:7777:8888",
+    "1111:2222:3333:4444:::6666:7777:8888",
+    "1111:2222:3333:4444:5555:::7777:8888",
+    "1111:2222:3333:4444:5555:6666:::8888",
+    "1111:2222:3333:4444:5555:6666:7777:::",
+
+    # Double ::
+    "::2222::4444:5555:6666:7777:8888",
+    "::2222:3333::5555:6666:7777:8888",
+    "::2222:3333:4444::6666:7777:8888",
+    "::2222:3333:4444:5555::7777:8888",
+    "::2222:3333:4444:5555:7777::8888",
+    "::2222:3333:4444:5555:7777:8888::",
+
+    "1111::3333::5555:6666:7777:8888",
+    "1111::3333:4444::6666:7777:8888",
+    "1111::3333:4444:5555::7777:8888",
+    "1111::3333:4444:5555:6666::8888",
+    "1111::3333:4444:5555:6666:7777::",
+
+    "1111:2222::4444::6666:7777:8888",
+    "1111:2222::4444:5555::7777:8888",
+    "1111:2222::4444:5555:6666::8888",
+    "1111:2222::4444:5555:6666:7777::",
+
+    "1111:2222:3333::5555::7777:8888",
+    "1111:2222:3333::5555:6666::8888",
+    "1111:2222:3333::5555:6666:7777::",
+
+    "1111:2222:3333:4444::6666::8888",
+    "1111:2222:3333:4444::6666:7777::",
+
+    "1111:2222:3333:4444:5555::7777::",
+
+    # Invalid data
+    "XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:1.2.3.4",
+    "1111:2222:3333:4444:5555:6666:256.256.256.256",
+
+    # Too many components
+    "1111:2222:3333:4444:5555:6666:7777:8888:1.2.3",
+    "1111:2222:3333:4444:5555:6666:7777:1.2.3.4",
+    "1111:2222:3333:4444:5555:6666::1.2.3.4",
+    "::2222:3333:4444:5555:6666:7777:1.2.3.4",
+    "1111:2222:3333:4444:5555:6666:1.2.3.4.5",
+
+    # Too few components
+    "1111:2222:3333:4444:5555:1.2.3.4",
+    "1111:2222:3333:4444:1.2.3.4",
+    "1111:2222:3333:1.2.3.4",
+    "1111:2222:1.2.3.4",
+    "1111:1.2.3.4",
+    "1.2.3.4",
+
+    # Missing :
+    "11112222:3333:4444:5555:6666:1.2.3.4",
+    "1111:22223333:4444:5555:6666:1.2.3.4",
+    "1111:2222:33334444:5555:6666:1.2.3.4",
+    "1111:2222:3333:44445555:6666:1.2.3.4",
+    "1111:2222:3333:4444:55556666:1.2.3.4",
+    "1111:2222:3333:4444:5555:66661.2.3.4",
+
+    # Missing .
+    "1111:2222:3333:4444:5555:6666:255255.255.255",
+    "1111:2222:3333:4444:5555:6666:255.255255.255",
+    "1111:2222:3333:4444:5555:6666:255.255.255255",
+
+    # Missing : intended for ::
+    ":1.2.3.4",
+    ":6666:1.2.3.4",
+    ":5555:6666:1.2.3.4",
+    ":4444:5555:6666:1.2.3.4",
+    ":3333:4444:5555:6666:1.2.3.4",
+    ":2222:3333:4444:5555:6666:1.2.3.4",
+    ":1111:2222:3333:4444:5555:6666:1.2.3.4",
+
+    # :::
+    ":::2222:3333:4444:5555:6666:1.2.3.4",
+    "1111:::3333:4444:5555:6666:1.2.3.4",
+    "1111:2222:::4444:5555:6666:1.2.3.4",
+    "1111:2222:3333:::5555:6666:1.2.3.4",
+    "1111:2222:3333:4444:::6666:1.2.3.4",
+    "1111:2222:3333:4444:5555:::1.2.3.4",
+
+    # Double ::
+    "::2222::4444:5555:6666:1.2.3.4",
+    "::2222:3333::5555:6666:1.2.3.4",
+    "::2222:3333:4444::6666:1.2.3.4",
+    "::2222:3333:4444:5555::1.2.3.4",
+
+    "1111::3333::5555:6666:1.2.3.4",
+    "1111::3333:4444::6666:1.2.3.4",
+    "1111::3333:4444:5555::1.2.3.4",
+
+    "1111:2222::4444::6666:1.2.3.4",
+    "1111:2222::4444:5555::1.2.3.4",
+
+    "1111:2222:3333::5555::1.2.3.4",
+
+    # Missing parts
+    "::.",
+    "::..",
+    "::...",
+    "::1...",
+    "::1.2..",
+    "::1.2.3.",
+    "::.2..",
+    "::.2.3.",
+    "::.2.3.4",
+    "::..3.",
+    "::..3.4",
+    "::...4",
+
+    # Extra : in front
+    ":1111:2222:3333:4444:5555:6666:7777::",
+    ":1111:2222:3333:4444:5555:6666::",
+    ":1111:2222:3333:4444:5555::",
+    ":1111:2222:3333:4444::",
+    ":1111:2222:3333::",
+    ":1111:2222::",
+    ":1111::",
+    ":::",
+    ":1111:2222:3333:4444:5555:6666::8888",
+    ":1111:2222:3333:4444:5555::8888",
+    ":1111:2222:3333:4444::8888",
+    ":1111:2222:3333::8888",
+    ":1111:2222::8888",
+    ":1111::8888",
+    ":::8888",
+    ":1111:2222:3333:4444:5555::7777:8888",
+    ":1111:2222:3333:4444::7777:8888",
+    ":1111:2222:3333::7777:8888",
+    ":1111:2222::7777:8888",
+    ":1111::7777:8888",
+    ":::7777:8888",
+    ":1111:2222:3333:4444::6666:7777:8888",
+    ":1111:2222:3333::6666:7777:8888",
+    ":1111:2222::6666:7777:8888",
+    ":1111::6666:7777:8888",
+    ":::6666:7777:8888",
+    ":1111:2222:3333::5555:6666:7777:8888",
+    ":1111:2222::5555:6666:7777:8888",
+    ":1111::5555:6666:7777:8888",
+    ":::5555:6666:7777:8888",
+    ":1111:2222::4444:5555:6666:7777:8888",
+    ":1111::4444:5555:6666:7777:8888",
+    ":::4444:5555:6666:7777:8888",
+    ":1111::3333:4444:5555:6666:7777:8888",
+    ":::3333:4444:5555:6666:7777:8888",
+    ":::2222:3333:4444:5555:6666:7777:8888",
+    ":1111:2222:3333:4444:5555:6666:1.2.3.4",
+    ":1111:2222:3333:4444:5555::1.2.3.4",
+    ":1111:2222:3333:4444::1.2.3.4",
+    ":1111:2222:3333::1.2.3.4",
+    ":1111:2222::1.2.3.4",
+    ":1111::1.2.3.4",
+    ":::1.2.3.4",
+    ":1111:2222:3333:4444::6666:1.2.3.4",
+    ":1111:2222:3333::6666:1.2.3.4",
+    ":1111:2222::6666:1.2.3.4",
+    ":1111::6666:1.2.3.4",
+    ":::6666:1.2.3.4",
+    ":1111:2222:3333::5555:6666:1.2.3.4",
+    ":1111:2222::5555:6666:1.2.3.4",
+    ":1111::5555:6666:1.2.3.4",
+    ":::5555:6666:1.2.3.4",
+    ":1111:2222::4444:5555:6666:1.2.3.4",
+    ":1111::4444:5555:6666:1.2.3.4",
+    ":::4444:5555:6666:1.2.3.4",
+    ":1111::3333:4444:5555:6666:1.2.3.4",
+    ":::3333:4444:5555:6666:1.2.3.4",
+    ":::2222:3333:4444:5555:6666:1.2.3.4",
+
+    # Extra : at end
+    "1111:2222:3333:4444:5555:6666:7777:::",
+    "1111:2222:3333:4444:5555:6666:::",
+    "1111:2222:3333:4444:5555:::",
+    "1111:2222:3333:4444:::",
+    "1111:2222:3333:::",
+    "1111:2222:::",
+    "1111:::",
+    ":::",
+    "1111:2222:3333:4444:5555:6666::8888:",
+    "1111:2222:3333:4444:5555::8888:",
+    "1111:2222:3333:4444::8888:",
+    "1111:2222:3333::8888:",
+    "1111:2222::8888:",
+    "1111::8888:",
+    "::8888:",
+    "1111:2222:3333:4444:5555::7777:8888:",
+    "1111:2222:3333:4444::7777:8888:",
+    "1111:2222:3333::7777:8888:",
+    "1111:2222::7777:8888:",
+    "1111::7777:8888:",
+    "::7777:8888:",
+    "1111:2222:3333:4444::6666:7777:8888:",
+    "1111:2222:3333::6666:7777:8888:",
+    "1111:2222::6666:7777:8888:",
+    "1111::6666:7777:8888:",
+    "::6666:7777:8888:",
+    "1111:2222:3333::5555:6666:7777:8888:",
+    "1111:2222::5555:6666:7777:8888:",
+    "1111::5555:6666:7777:8888:",
+    "::5555:6666:7777:8888:",
+    "1111:2222::4444:5555:6666:7777:8888:",
+    "1111::4444:5555:6666:7777:8888:",
+    "::4444:5555:6666:7777:8888:",
+    "1111::3333:4444:5555:6666:7777:8888:",
+    "::3333:4444:5555:6666:7777:8888:",
+    "::2222:3333:4444:5555:6666:7777:8888:",
+);
+
+
+subtest "is_ipv6() with valid addresses" => sub {
+    foreach my $ip (@valid_ipv6) {
+        ok(ddclient::is_ipv6($ip), "is_ipv6('$ip')");
+    }
+};
+
+subtest "is_ipv6() with invalid addresses" => sub {
+    foreach my $ip (@invalid_ipv6) {
+        ok(!ddclient::is_ipv6($ip), sprintf("!is_ipv6(%s)", defined($ip) ? "'$ip'" : 'undef'));
+    }
+};
+
+subtest "is_ipv6() with char adjacent to valid address" => sub {
+    foreach my $ch (split(//, '/.,:z @$#&%!^*()_-+'), "\n") {
+        subtest perlstring($ch) => sub {
+            foreach my $ip (@valid_ipv6) {
+                subtest $ip => sub {
+                    my $test = $ch . $ip;  # insert at front
+                    ok(!ddclient::is_ipv6($test), "!is_ipv6('$test')");
+                    $test = $ip . $ch;  # add at end
+                    ok(!ddclient::is_ipv6($test), "!is_ipv6('$test')");
+                    $test = $ch . $ip . $ch; # wrap front and end
+                    ok(!ddclient::is_ipv6($test), "!is_ipv6('$test')");
+                };
+            }
+        };
+    }
+};
+
+subtest "extract_ipv6()" => sub {
+    my @test_cases = (
+        {name => "undef",            text => undef,               want => undef},
+        {name => "empty",            text => "",                  want => undef},
+        {name => "invalid",          text => "::12345",           want => undef},
+        {name => "two addrs",        text => "::1\n::2",          want => "::1"},
+        {name => "zone index",       text => "fe80::1%0",         want => "fe80::1"},
+        {name => "url host+port",    text => "[::1]:123",         want => "::1"},
+        {name => "url host+zi+port", text => "[fe80::1%250]:123", want => "fe80::1"},
+        {name => "zero pad",         text => "::0001",            want => "::1"},
+    );
+    foreach my $tc (@test_cases) {
+        is(ddclient::extract_ipv6($tc->{text}), $tc->{want}, $tc->{name});
+    }
+};
+
+subtest "extract_ipv6() of valid addr with adjacent non-word char" => sub {
+    foreach my $wb (split(//, '/, @$#&%!^*()_-+'), "\n") {
+        subtest perlstring($wb) => sub {
+            my $test = "";
+            foreach my $ip (@valid_ipv6) {
+                $test = "foo" . $wb . $ip . $wb . "bar"; # wrap front and end
+                $ip =~ s/\b0+\B//g; ## remove embedded leading zeros for testing
+                is(ddclient::extract_ipv6($test), $ip, perlstring($test));
+            }
+        };
+    }
+};
+
+subtest "interface config samples" => sub {
+    for my $sample (@ddclient::t::interface_samples) {
+        if (defined($sample->{want_extract_ipv6_global})) {
+            subtest $sample->{name} => sub {
+                my $ip = ddclient::extract_ipv6($sample->{text});
+                ok(ddclient::is_ipv6($ip), "extract_ipv6() returns an IPv6 address");
+            };
+            foreach my $line (split(/\n/, $sample->{text})) {
+                my $ip = ddclient::extract_ipv6($line);
+                if ($ip) {  ## Test cases may have lines that do not contain IPv6 address.
+                    ok(ddclient::is_ipv6($ip),
+                       sprintf("extract_ipv6(%s) returns an IPv6 address", perlstring($line)));
+                }
+            }
+        }
+    }
+};
+
+done_testing();

t/lib/Devel/Autoflush.pm

@@ -0,0 +1,106 @@
+package Devel::Autoflush;
+# ABSTRACT: Set autoflush from the command line
+our $VERSION = '0.06'; # VERSION
+
+my $kwalitee_nocritic = << 'END';
+# can't use strict as older stricts load Carp and we can't allow side effects
+use strict;  
+END
+
+my $old = select STDOUT;
+$|++;
+select STDERR;
+$|++;
+select $old;
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Devel::Autoflush - Set autoflush from the command line
+
+=head1 VERSION
+
+version 0.06
+
+=head1 SYNOPSIS
+
+ perl -MDevel::Autoflush Makefile.PL
+
+=head1 DESCRIPTION
+
+This module is a hack to set autoflush for STDOUT and STDERR from the command
+line or from C<PERL5OPT> for code that needs it but doesn't have it.
+
+This often happens when prompting:
+
+  # guess.pl
+  print "Guess a number: ";
+  my $n = <STDIN>;
+
+As long as the output is going to a terminal, the prompt is flushed when STDIN
+is read.  However, if the output is being piped, the print statement will 
+not automatically be flushed, no prompt will be seen and the program will
+silently appear to hang while waiting for input.  This might happen with 'tee':
+
+  $ perl guess.pl | tee capture.out
+
+Use Devel::Autoflush to work around this:
+
+  $ perl -MDevel::Autoflush guess.pl | tee capture.out
+
+Or set it in C<PERL5OPT>:
+
+  $ export PERL5OPT=-MDevel::Autoflush
+  $ perl guess.pl | tee capture.out
+
+= SEE ALSO
+
+=over 4
+
+=item *
+
+L<CPANPLUS::Internals::Utils::Autoflush> -- same idea but STDOUT only and 
+
+only available as part of the full CPANPLUS distribution
+
+=back
+
+=for :stopwords cpan testmatrix url annocpan anno bugtracker rt cpants kwalitee diff irc mailto metadata placeholders metacpan
+
+=head1 SUPPORT
+
+=head2 Bugs / Feature Requests
+
+Please report any bugs or feature requests through the issue tracker
+at L<https://github.com/dagolden/Devel-Autoflush/issues>.
+You will be notified automatically of any progress on your issue.
+
+=head2 Source Code
+
+This is open source software.  The code repository is available for
+public review and contribution under the terms of the license.
+
+L<https://github.com/dagolden/Devel-Autoflush>
+
+  git clone https://github.com/dagolden/Devel-Autoflush.git
+
+=head1 AUTHOR
+
+David Golden <dagolden@cpan.org>
+
+=head1 COPYRIGHT AND LICENSE
+
+This software is Copyright (c) 2014 by David Golden.
+
+This is free software, licensed under:
+
+  The Apache License, Version 2.0, January 2004
+
+=cut

t/lib/Test/Builder/Formatter.pm

@@ -0,0 +1,107 @@
+package Test::Builder::Formatter;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+BEGIN { require Test2::Formatter::TAP; our @ISA = qw(Test2::Formatter::TAP) }
+
+use Test2::Util::HashBase qw/no_header no_diag/;
+
+BEGIN {
+    *OUT_STD = Test2::Formatter::TAP->can('OUT_STD');
+    *OUT_ERR = Test2::Formatter::TAP->can('OUT_ERR');
+
+    my $todo = OUT_ERR() + 1;
+    *OUT_TODO = sub() { $todo };
+}
+
+sub init {
+    my $self = shift;
+    $self->SUPER::init(@_);
+    $self->{+HANDLES}->[OUT_TODO] = $self->{+HANDLES}->[OUT_STD];
+}
+
+sub plan_tap {
+    my ($self, $f) = @_;
+
+    return if $self->{+NO_HEADER};
+    return $self->SUPER::plan_tap($f);
+}
+
+sub debug_tap {
+    my ($self, $f, $num) = @_;
+    return if $self->{+NO_DIAG};
+    my @out = $self->SUPER::debug_tap($f, $num);
+    $self->redirect(\@out) if @out && ref $f->{about} && defined $f->{about}->{package}
+        && $f->{about}->{package} eq 'Test::Builder::TodoDiag';
+    return @out;
+}
+
+sub info_tap {
+    my ($self, $f) = @_;
+    return if $self->{+NO_DIAG};
+    my @out = $self->SUPER::info_tap($f);
+    $self->redirect(\@out) if @out && ref $f->{about} && defined $f->{about}->{package}
+        && $f->{about}->{package} eq 'Test::Builder::TodoDiag';
+    return @out;
+}
+
+sub redirect {
+    my ($self, $out) = @_;
+    $_->[0] = OUT_TODO for @$out;
+}
+
+sub no_subtest_space { 1 }
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test::Builder::Formatter - Test::Builder subclass of Test2::Formatter::TAP
+
+=head1 DESCRIPTION
+
+This is what takes events and turns them into TAP.
+
+=head1 SYNOPSIS
+
+    use Test::Builder; # Loads Test::Builder::Formatter for you
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test/Builder/IO/Scalar.pm

@@ -0,0 +1,659 @@
+package Test::Builder::IO::Scalar;
+
+
+=head1 NAME
+
+Test::Builder::IO::Scalar - A copy of IO::Scalar for Test::Builder
+
+=head1 DESCRIPTION
+
+This is a copy of L<IO::Scalar> which ships with L<Test::Builder> to
+support scalar references as filehandles on Perl 5.6.  Newer
+versions of Perl simply use C<open()>'s built in support.
+
+L<Test::Builder> can not have dependencies on other modules without
+careful consideration, so its simply been copied into the distribution.
+
+=head1 COPYRIGHT and LICENSE
+
+This file came from the "IO-stringy" Perl5 toolkit.
+
+Copyright (c) 1996 by Eryq.  All rights reserved.
+Copyright (c) 1999,2001 by ZeeGee Software Inc.  All rights reserved.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+
+=cut
+
+# This is copied code, I don't care.
+##no critic
+
+use Carp;
+use strict;
+use vars qw($VERSION @ISA);
+use IO::Handle;
+
+use 5.005;
+
+### The package version, both in 1.23 style *and* usable by MakeMaker:
+$VERSION = "2.114";
+
+### Inheritance:
+@ISA = qw(IO::Handle);
+
+#==============================
+
+=head2 Construction
+
+=over 4
+
+=cut
+
+#------------------------------
+
+=item new [ARGS...]
+
+I<Class method.>
+Return a new, unattached scalar handle.
+If any arguments are given, they're sent to open().
+
+=cut
+
+sub new {
+    my $proto = shift;
+    my $class = ref($proto) || $proto;
+    my $self = bless \do { local *FH }, $class;
+    tie *$self, $class, $self;
+    $self->open(@_);   ### open on anonymous by default
+    $self;
+}
+sub DESTROY {
+    shift->close;
+}
+
+#------------------------------
+
+=item open [SCALARREF]
+
+I<Instance method.>
+Open the scalar handle on a new scalar, pointed to by SCALARREF.
+If no SCALARREF is given, a "private" scalar is created to hold
+the file data.
+
+Returns the self object on success, undefined on error.
+
+=cut
+
+sub open {
+    my ($self, $sref) = @_;
+
+    ### Sanity:
+    defined($sref) or do {my $s = ''; $sref = \$s};
+    (ref($sref) eq "SCALAR") or croak "open() needs a ref to a scalar";
+
+    ### Setup:
+    *$self->{Pos} = 0;          ### seek position
+    *$self->{SR}  = $sref;      ### scalar reference
+    $self;
+}
+
+#------------------------------
+
+=item opened
+
+I<Instance method.>
+Is the scalar handle opened on something?
+
+=cut
+
+sub opened {
+    *{shift()}->{SR};
+}
+
+#------------------------------
+
+=item close
+
+I<Instance method.>
+Disassociate the scalar handle from its underlying scalar.
+Done automatically on destroy.
+
+=cut
+
+sub close {
+    my $self = shift;
+    %{*$self} = ();
+    1;
+}
+
+=back
+
+=cut
+
+
+
+#==============================
+
+=head2 Input and output
+
+=over 4
+
+=cut
+
+
+#------------------------------
+
+=item flush
+
+I<Instance method.>
+No-op, provided for OO compatibility.
+
+=cut
+
+sub flush { "0 but true" }
+
+#------------------------------
+
+=item getc
+
+I<Instance method.>
+Return the next character, or undef if none remain.
+
+=cut
+
+sub getc {
+    my $self = shift;
+
+    ### Return undef right away if at EOF; else, move pos forward:
+    return undef if $self->eof;
+    substr(${*$self->{SR}}, *$self->{Pos}++, 1);
+}
+
+#------------------------------
+
+=item getline
+
+I<Instance method.>
+Return the next line, or undef on end of string.
+Can safely be called in an array context.
+Currently, lines are delimited by "\n".
+
+=cut
+
+sub getline {
+    my $self = shift;
+
+    ### Return undef right away if at EOF:
+    return undef if $self->eof;
+
+    ### Get next line:
+    my $sr = *$self->{SR};
+    my $i  = *$self->{Pos};	        ### Start matching at this point.
+
+    ### Minimal impact implementation!
+    ### We do the fast fast thing (no regexps) if using the
+    ### classic input record separator.
+
+    ### Case 1: $/ is undef: slurp all...
+    if    (!defined($/)) {
+	*$self->{Pos} = length $$sr;
+        return substr($$sr, $i);
+    }
+
+    ### Case 2: $/ is "\n": zoom zoom zoom...
+    elsif ($/ eq "\012") {
+
+        ### Seek ahead for "\n"... yes, this really is faster than regexps.
+        my $len = length($$sr);
+        for (; $i < $len; ++$i) {
+           last if ord (substr ($$sr, $i, 1)) == 10;
+        }
+
+        ### Extract the line:
+        my $line;
+        if ($i < $len) {                ### We found a "\n":
+            $line = substr ($$sr, *$self->{Pos}, $i - *$self->{Pos} + 1);
+            *$self->{Pos} = $i+1;            ### Remember where we finished up.
+        }
+        else {                          ### No "\n"; slurp the remainder:
+            $line = substr ($$sr, *$self->{Pos}, $i - *$self->{Pos});
+            *$self->{Pos} = $len;
+        }
+        return $line;
+    }
+
+    ### Case 3: $/ is ref to int. Do fixed-size records.
+    ###        (Thanks to Dominique Quatravaux.)
+    elsif (ref($/)) {
+        my $len = length($$sr);
+		my $i = ${$/} + 0;
+		my $line = substr ($$sr, *$self->{Pos}, $i);
+		*$self->{Pos} += $i;
+        *$self->{Pos} = $len if (*$self->{Pos} > $len);
+		return $line;
+    }
+
+    ### Case 4: $/ is either "" (paragraphs) or something weird...
+    ###         This is Graham's general-purpose stuff, which might be
+    ###         a tad slower than Case 2 for typical data, because
+    ###         of the regexps.
+    else {
+        pos($$sr) = $i;
+
+	### If in paragraph mode, skip leading lines (and update i!):
+        length($/) or
+	    (($$sr =~ m/\G\n*/g) and ($i = pos($$sr)));
+
+        ### If we see the separator in the buffer ahead...
+        if (length($/)
+	    ?  $$sr =~ m,\Q$/\E,g          ###   (ordinary sep) TBD: precomp!
+            :  $$sr =~ m,\n\n,g            ###   (a paragraph)
+            ) {
+            *$self->{Pos} = pos $$sr;
+            return substr($$sr, $i, *$self->{Pos}-$i);
+        }
+        ### Else if no separator remains, just slurp the rest:
+        else {
+            *$self->{Pos} = length $$sr;
+            return substr($$sr, $i);
+        }
+    }
+}
+
+#------------------------------
+
+=item getlines
+
+I<Instance method.>
+Get all remaining lines.
+It will croak() if accidentally called in a scalar context.
+
+=cut
+
+sub getlines {
+    my $self = shift;
+    wantarray or croak("can't call getlines in scalar context!");
+    my ($line, @lines);
+    push @lines, $line while (defined($line = $self->getline));
+    @lines;
+}
+
+#------------------------------
+
+=item print ARGS...
+
+I<Instance method.>
+Print ARGS to the underlying scalar.
+
+B<Warning:> this continues to always cause a seek to the end
+of the string, but if you perform seek()s and tell()s, it is
+still safer to explicitly seek-to-end before subsequent print()s.
+
+=cut
+
+sub print {
+    my $self = shift;
+    *$self->{Pos} = length(${*$self->{SR}} .= join('', @_) . (defined($\) ? $\ : ""));
+    1;
+}
+sub _unsafe_print {
+    my $self = shift;
+    my $append = join('', @_) . $\;
+    ${*$self->{SR}} .= $append;
+    *$self->{Pos}   += length($append);
+    1;
+}
+sub _old_print {
+    my $self = shift;
+    ${*$self->{SR}} .= join('', @_) . $\;
+    *$self->{Pos} = length(${*$self->{SR}});
+    1;
+}
+
+
+#------------------------------
+
+=item read BUF, NBYTES, [OFFSET]
+
+I<Instance method.>
+Read some bytes from the scalar.
+Returns the number of bytes actually read, 0 on end-of-file, undef on error.
+
+=cut
+
+sub read {
+    my $self = $_[0];
+    my $n    = $_[2];
+    my $off  = $_[3] || 0;
+
+    my $read = substr(${*$self->{SR}}, *$self->{Pos}, $n);
+    $n = length($read);
+    *$self->{Pos} += $n;
+    ($off ? substr($_[1], $off) : $_[1]) = $read;
+    return $n;
+}
+
+#------------------------------
+
+=item write BUF, NBYTES, [OFFSET]
+
+I<Instance method.>
+Write some bytes to the scalar.
+
+=cut
+
+sub write {
+    my $self = $_[0];
+    my $n    = $_[2];
+    my $off  = $_[3] || 0;
+
+    my $data = substr($_[1], $off, $n);
+    $n = length($data);
+    $self->print($data);
+    return $n;
+}
+
+#------------------------------
+
+=item sysread BUF, LEN, [OFFSET]
+
+I<Instance method.>
+Read some bytes from the scalar.
+Returns the number of bytes actually read, 0 on end-of-file, undef on error.
+
+=cut
+
+sub sysread {
+  my $self = shift;
+  $self->read(@_);
+}
+
+#------------------------------
+
+=item syswrite BUF, NBYTES, [OFFSET]
+
+I<Instance method.>
+Write some bytes to the scalar.
+
+=cut
+
+sub syswrite {
+  my $self = shift;
+  $self->write(@_);
+}
+
+=back
+
+=cut
+
+
+#==============================
+
+=head2 Seeking/telling and other attributes
+
+=over 4
+
+=cut
+
+
+#------------------------------
+
+=item autoflush
+
+I<Instance method.>
+No-op, provided for OO compatibility.
+
+=cut
+
+sub autoflush {}
+
+#------------------------------
+
+=item binmode
+
+I<Instance method.>
+No-op, provided for OO compatibility.
+
+=cut
+
+sub binmode {}
+
+#------------------------------
+
+=item clearerr
+
+I<Instance method.>  Clear the error and EOF flags.  A no-op.
+
+=cut
+
+sub clearerr { 1 }
+
+#------------------------------
+
+=item eof
+
+I<Instance method.>  Are we at end of file?
+
+=cut
+
+sub eof {
+    my $self = shift;
+    (*$self->{Pos} >= length(${*$self->{SR}}));
+}
+
+#------------------------------
+
+=item seek OFFSET, WHENCE
+
+I<Instance method.>  Seek to a given position in the stream.
+
+=cut
+
+sub seek {
+    my ($self, $pos, $whence) = @_;
+    my $eofpos = length(${*$self->{SR}});
+
+    ### Seek:
+    if    ($whence == 0) { *$self->{Pos} = $pos }             ### SEEK_SET
+    elsif ($whence == 1) { *$self->{Pos} += $pos }            ### SEEK_CUR
+    elsif ($whence == 2) { *$self->{Pos} = $eofpos + $pos}    ### SEEK_END
+    else                 { croak "bad seek whence ($whence)" }
+
+    ### Fixup:
+    if (*$self->{Pos} < 0)       { *$self->{Pos} = 0 }
+    if (*$self->{Pos} > $eofpos) { *$self->{Pos} = $eofpos }
+    return 1;
+}
+
+#------------------------------
+
+=item sysseek OFFSET, WHENCE
+
+I<Instance method.> Identical to C<seek OFFSET, WHENCE>, I<q.v.>
+
+=cut
+
+sub sysseek {
+    my $self = shift;
+    $self->seek (@_);
+}
+
+#------------------------------
+
+=item tell
+
+I<Instance method.>
+Return the current position in the stream, as a numeric offset.
+
+=cut
+
+sub tell { *{shift()}->{Pos} }
+
+#------------------------------
+
+=item  use_RS [YESNO]
+
+I<Instance method.>
+B<Deprecated and ignored.>
+Obey the current setting of $/, like IO::Handle does?
+Default is false in 1.x, but cold-welded true in 2.x and later.
+
+=cut
+
+sub use_RS {
+    my ($self, $yesno) = @_;
+    carp "use_RS is deprecated and ignored; \$/ is always consulted\n";
+ }
+
+#------------------------------
+
+=item setpos POS
+
+I<Instance method.>
+Set the current position, using the opaque value returned by C<getpos()>.
+
+=cut
+
+sub setpos { shift->seek($_[0],0) }
+
+#------------------------------
+
+=item getpos
+
+I<Instance method.>
+Return the current position in the string, as an opaque object.
+
+=cut
+
+*getpos = \&tell;
+
+
+#------------------------------
+
+=item sref
+
+I<Instance method.>
+Return a reference to the underlying scalar.
+
+=cut
+
+sub sref { *{shift()}->{SR} }
+
+
+#------------------------------
+# Tied handle methods...
+#------------------------------
+
+# Conventional tiehandle interface:
+sub TIEHANDLE {
+    ((defined($_[1]) && UNIVERSAL::isa($_[1], __PACKAGE__))
+     ? $_[1]
+     : shift->new(@_));
+}
+sub GETC      { shift->getc(@_) }
+sub PRINT     { shift->print(@_) }
+sub PRINTF    { shift->print(sprintf(shift, @_)) }
+sub READ      { shift->read(@_) }
+sub READLINE  { wantarray ? shift->getlines(@_) : shift->getline(@_) }
+sub WRITE     { shift->write(@_); }
+sub CLOSE     { shift->close(@_); }
+sub SEEK      { shift->seek(@_); }
+sub TELL      { shift->tell(@_); }
+sub EOF       { shift->eof(@_); }
+sub FILENO    { -1 }
+
+#------------------------------------------------------------
+
+1;
+
+__END__
+
+
+
+=back
+
+=cut
+
+
+=head1 WARNINGS
+
+Perl's TIEHANDLE spec was incomplete prior to 5.005_57;
+it was missing support for C<seek()>, C<tell()>, and C<eof()>.
+Attempting to use these functions with an IO::Scalar will not work
+prior to 5.005_57. IO::Scalar will not have the relevant methods
+invoked; and even worse, this kind of bug can lie dormant for a while.
+If you turn warnings on (via C<$^W> or C<perl -w>),
+and you see something like this...
+
+    attempt to seek on unopened filehandle
+
+...then you are probably trying to use one of these functions
+on an IO::Scalar with an old Perl.  The remedy is to simply
+use the OO version; e.g.:
+
+    $SH->seek(0,0);    ### GOOD: will work on any 5.005
+    seek($SH,0,0);     ### WARNING: will only work on 5.005_57 and beyond
+
+
+=head1 VERSION
+
+$Id: Scalar.pm,v 1.6 2005/02/10 21:21:53 dfs Exp $
+
+
+=head1 AUTHORS
+
+=head2 Primary Maintainer
+
+David F. Skoll (F<dfs@roaringpenguin.com>).
+
+=head2 Principal author
+
+Eryq (F<eryq@zeegee.com>).
+President, ZeeGee Software Inc (F<http://www.zeegee.com>).
+
+
+=head2 Other contributors
+
+The full set of contributors always includes the folks mentioned
+in L<IO::Stringy/"CHANGE LOG">.  But just the same, special
+thanks to the following individuals for their invaluable contributions
+(if I've forgotten or misspelled your name, please email me!):
+
+I<Andy Glew,>
+for contributing C<getc()>.
+
+I<Brandon Browning,>
+for suggesting C<opened()>.
+
+I<David Richter,>
+for finding and fixing the bug in C<PRINTF()>.
+
+I<Eric L. Brine,>
+for his offset-using read() and write() implementations.
+
+I<Richard Jones,>
+for his patches to massively improve the performance of C<getline()>
+and add C<sysread> and C<syswrite>.
+
+I<B. K. Oxley (binkley),>
+for stringification and inheritance improvements,
+and sundry good ideas.
+
+I<Doug Wilson,>
+for the IO::Handle inheritance and automatic tie-ing.
+
+
+=head1 SEE ALSO
+
+L<IO::String>, which is quite similar but which was designed
+more-recently and with an IO::Handle-like interface in mind,
+so you could mix OO- and native-filehandle usage without using tied().
+
+I<Note:> as of version 2.x, these classes all work like
+their IO::Handle counterparts, so we have comparable
+functionality to IO::String.
+
+=cut
+

t/lib/Test/Builder/Module.pm

@@ -0,0 +1,182 @@
+package Test::Builder::Module;
+
+use strict;
+
+use Test::Builder;
+
+require Exporter;
+our @ISA = qw(Exporter);
+
+our $VERSION = '1.302175';
+
+
+=head1 NAME
+
+Test::Builder::Module - Base class for test modules
+
+=head1 SYNOPSIS
+
+  # Emulates Test::Simple
+  package Your::Module;
+
+  my $CLASS = __PACKAGE__;
+
+  use parent 'Test::Builder::Module';
+  @EXPORT = qw(ok);
+
+  sub ok ($;$) {
+      my $tb = $CLASS->builder;
+      return $tb->ok(@_);
+  }
+  
+  1;
+
+
+=head1 DESCRIPTION
+
+This is a superclass for L<Test::Builder>-based modules.  It provides a
+handful of common functionality and a method of getting at the underlying
+L<Test::Builder> object.
+
+
+=head2 Importing
+
+Test::Builder::Module is a subclass of L<Exporter> which means your
+module is also a subclass of Exporter.  @EXPORT, @EXPORT_OK, etc...
+all act normally.
+
+A few methods are provided to do the C<< use Your::Module tests => 23 >> part
+for you.
+
+=head3 import
+
+Test::Builder::Module provides an C<import()> method which acts in the
+same basic way as L<Test::More>'s, setting the plan and controlling
+exporting of functions and variables.  This allows your module to set
+the plan independent of L<Test::More>.
+
+All arguments passed to C<import()> are passed onto 
+C<< Your::Module->builder->plan() >> with the exception of 
+C<< import =>[qw(things to import)] >>.
+
+    use Your::Module import => [qw(this that)], tests => 23;
+
+says to import the functions C<this()> and C<that()> as well as set the plan
+to be 23 tests.
+
+C<import()> also sets the C<exported_to()> attribute of your builder to be
+the caller of the C<import()> function.
+
+Additional behaviors can be added to your C<import()> method by overriding
+C<import_extra()>.
+
+=cut
+
+sub import {
+    my($class) = shift;
+
+    Test2::API::test2_load() unless Test2::API::test2_in_preload();
+
+    # Don't run all this when loading ourself.
+    return 1 if $class eq 'Test::Builder::Module';
+
+    my $test = $class->builder;
+
+    my $caller = caller;
+
+    $test->exported_to($caller);
+
+    $class->import_extra( \@_ );
+    my(@imports) = $class->_strip_imports( \@_ );
+
+    $test->plan(@_);
+
+    local $Exporter::ExportLevel = $Exporter::ExportLevel + 1;
+    $class->Exporter::import(@imports);
+}
+
+sub _strip_imports {
+    my $class = shift;
+    my $list  = shift;
+
+    my @imports = ();
+    my @other   = ();
+    my $idx     = 0;
+    while( $idx <= $#{$list} ) {
+        my $item = $list->[$idx];
+
+        if( defined $item and $item eq 'import' ) {
+            push @imports, @{ $list->[ $idx + 1 ] };
+            $idx++;
+        }
+        else {
+            push @other, $item;
+        }
+
+        $idx++;
+    }
+
+    @$list = @other;
+
+    return @imports;
+}
+
+=head3 import_extra
+
+    Your::Module->import_extra(\@import_args);
+
+C<import_extra()> is called by C<import()>.  It provides an opportunity for you
+to add behaviors to your module based on its import list.
+
+Any extra arguments which shouldn't be passed on to C<plan()> should be
+stripped off by this method.
+
+See L<Test::More> for an example of its use.
+
+B<NOTE> This mechanism is I<VERY ALPHA AND LIKELY TO CHANGE> as it
+feels like a bit of an ugly hack in its current form.
+
+=cut
+
+sub import_extra { }
+
+=head2 Builder
+
+Test::Builder::Module provides some methods of getting at the underlying
+Test::Builder object.
+
+=head3 builder
+
+  my $builder = Your::Class->builder;
+
+This method returns the L<Test::Builder> object associated with Your::Class.
+It is not a constructor so you can call it as often as you like.
+
+This is the preferred way to get the L<Test::Builder> object.  You should
+I<not> get it via C<< Test::Builder->new >> as was previously
+recommended.
+
+The object returned by C<builder()> may change at runtime so you should
+call C<builder()> inside each function rather than store it in a global.
+
+  sub ok {
+      my $builder = Your::Class->builder;
+
+      return $builder->ok(@_);
+  }
+
+
+=cut
+
+sub builder {
+    return Test::Builder->new;
+}
+
+=head1 SEE ALSO
+
+L<< Test2::Manual::Tooling::TestBuilder >> describes the improved
+options for writing testing modules provided by L<< Test2 >>.
+
+=cut
+
+1;

t/lib/Test/Builder/Tester.pm

@@ -0,0 +1,675 @@
+package Test::Builder::Tester;
+
+use strict;
+our $VERSION = '1.302175';
+
+use Test::Builder;
+use Symbol;
+use Carp;
+
+=head1 NAME
+
+Test::Builder::Tester - test testsuites that have been built with
+Test::Builder
+
+=head1 SYNOPSIS
+
+    use Test::Builder::Tester tests => 1;
+    use Test::More;
+
+    test_out("not ok 1 - foo");
+    test_fail(+1);
+    fail("foo");
+    test_test("fail works");
+
+=head1 DESCRIPTION
+
+A module that helps you test testing modules that are built with
+L<Test::Builder>.
+
+The testing system is designed to be used by performing a three step
+process for each test you wish to test.  This process starts with using
+C<test_out> and C<test_err> in advance to declare what the testsuite you
+are testing will output with L<Test::Builder> to stdout and stderr.
+
+You then can run the test(s) from your test suite that call
+L<Test::Builder>.  At this point the output of L<Test::Builder> is
+safely captured by L<Test::Builder::Tester> rather than being
+interpreted as real test output.
+
+The final stage is to call C<test_test> that will simply compare what you
+predeclared to what L<Test::Builder> actually outputted, and report the
+results back with a "ok" or "not ok" (with debugging) to the normal
+output.
+
+=cut
+
+####
+# set up testing
+####
+
+my $t = Test::Builder->new;
+
+###
+# make us an exporter
+###
+
+use Exporter;
+our @ISA = qw(Exporter);
+
+our @EXPORT = qw(test_out test_err test_fail test_diag test_test line_num);
+
+sub import {
+    my $class = shift;
+    my(@plan) = @_;
+
+    my $caller = caller;
+
+    $t->exported_to($caller);
+    $t->plan(@plan);
+
+    my @imports = ();
+    foreach my $idx ( 0 .. $#plan ) {
+        if( $plan[$idx] eq 'import' ) {
+            @imports = @{ $plan[ $idx + 1 ] };
+            last;
+        }
+    }
+
+    __PACKAGE__->export_to_level( 1, __PACKAGE__, @imports );
+}
+
+###
+# set up file handles
+###
+
+# create some private file handles
+my $output_handle = gensym;
+my $error_handle  = gensym;
+
+# and tie them to this package
+my $out = tie *$output_handle, "Test::Builder::Tester::Tie", "STDOUT";
+my $err = tie *$error_handle,  "Test::Builder::Tester::Tie", "STDERR";
+
+####
+# exported functions
+####
+
+# for remembering that we're testing and where we're testing at
+my $testing = 0;
+my $testing_num;
+my $original_is_passing;
+
+# remembering where the file handles were originally connected
+my $original_output_handle;
+my $original_failure_handle;
+my $original_todo_handle;
+my $original_formatter;
+
+my $original_harness_env;
+
+# function that starts testing and redirects the filehandles for now
+sub _start_testing {
+    # Hack for things that conditioned on Test-Stream being loaded
+    $INC{'Test/Stream.pm'} ||= 'fake' if $INC{'Test/Moose/More.pm'};
+    # even if we're running under Test::Harness pretend we're not
+    # for now.  This needed so Test::Builder doesn't add extra spaces
+    $original_harness_env = $ENV{HARNESS_ACTIVE} || 0;
+    $ENV{HARNESS_ACTIVE} = 0;
+
+    my $hub = $t->{Hub} || ($t->{Stack} ? $t->{Stack}->top : Test2::API::test2_stack->top);
+    $original_formatter = $hub->format;
+    unless ($original_formatter && $original_formatter->isa('Test::Builder::Formatter')) {
+        my $fmt = Test::Builder::Formatter->new;
+        $hub->format($fmt);
+    }
+
+    # remember what the handles were set to
+    $original_output_handle  = $t->output();
+    $original_failure_handle = $t->failure_output();
+    $original_todo_handle    = $t->todo_output();
+
+    # switch out to our own handles
+    $t->output($output_handle);
+    $t->failure_output($error_handle);
+    $t->todo_output($output_handle);
+
+    # clear the expected list
+    $out->reset();
+    $err->reset();
+
+    # remember that we're testing
+    $testing     = 1;
+    $testing_num = $t->current_test;
+    $t->current_test(0);
+    $original_is_passing  = $t->is_passing;
+    $t->is_passing(1);
+
+    # look, we shouldn't do the ending stuff
+    $t->no_ending(1);
+}
+
+=head2 Functions
+
+These are the six methods that are exported as default.
+
+=over 4
+
+=item test_out
+
+=item test_err
+
+Procedures for predeclaring the output that your test suite is
+expected to produce until C<test_test> is called.  These procedures
+automatically assume that each line terminates with "\n".  So
+
+   test_out("ok 1","ok 2");
+
+is the same as
+
+   test_out("ok 1\nok 2");
+
+which is even the same as
+
+   test_out("ok 1");
+   test_out("ok 2");
+
+Once C<test_out> or C<test_err> (or C<test_fail> or C<test_diag>) have
+been called, all further output from L<Test::Builder> will be
+captured by L<Test::Builder::Tester>.  This means that you will not
+be able perform further tests to the normal output in the normal way
+until you call C<test_test> (well, unless you manually meddle with the
+output filehandles)
+
+=cut
+
+sub test_out {
+    # do we need to do any setup?
+    _start_testing() unless $testing;
+
+    $out->expect(@_);
+}
+
+sub test_err {
+    # do we need to do any setup?
+    _start_testing() unless $testing;
+
+    $err->expect(@_);
+}
+
+=item test_fail
+
+Because the standard failure message that L<Test::Builder> produces
+whenever a test fails will be a common occurrence in your test error
+output, and because it has changed between Test::Builder versions, rather
+than forcing you to call C<test_err> with the string all the time like
+so
+
+    test_err("# Failed test ($0 at line ".line_num(+1).")");
+
+C<test_fail> exists as a convenience function that can be called
+instead.  It takes one argument, the offset from the current line that
+the line that causes the fail is on.
+
+    test_fail(+1);
+
+This means that the example in the synopsis could be rewritten
+more simply as:
+
+   test_out("not ok 1 - foo");
+   test_fail(+1);
+   fail("foo");
+   test_test("fail works");
+
+=cut
+
+sub test_fail {
+    # do we need to do any setup?
+    _start_testing() unless $testing;
+
+    # work out what line we should be on
+    my( $package, $filename, $line ) = caller;
+    $line = $line + ( shift() || 0 );    # prevent warnings
+
+    # expect that on stderr
+    $err->expect("#     Failed test ($filename at line $line)");
+}
+
+=item test_diag
+
+As most of the remaining expected output to the error stream will be
+created by L<Test::Builder>'s C<diag> function, L<Test::Builder::Tester>
+provides a convenience function C<test_diag> that you can use instead of
+C<test_err>.
+
+The C<test_diag> function prepends comment hashes and spacing to the
+start and newlines to the end of the expected output passed to it and
+adds it to the list of expected error output.  So, instead of writing
+
+   test_err("# Couldn't open file");
+
+you can write
+
+   test_diag("Couldn't open file");
+
+Remember that L<Test::Builder>'s diag function will not add newlines to
+the end of output and test_diag will. So to check
+
+   Test::Builder->new->diag("foo\n","bar\n");
+
+You would do
+
+  test_diag("foo","bar")
+
+without the newlines.
+
+=cut
+
+sub test_diag {
+    # do we need to do any setup?
+    _start_testing() unless $testing;
+
+    # expect the same thing, but prepended with "#     "
+    local $_;
+    $err->expect( map { "# $_" } @_ );
+}
+
+=item test_test
+
+Actually performs the output check testing the tests, comparing the
+data (with C<eq>) that we have captured from L<Test::Builder> against
+what was declared with C<test_out> and C<test_err>.
+
+This takes name/value pairs that effect how the test is run.
+
+=over
+
+=item title (synonym 'name', 'label')
+
+The name of the test that will be displayed after the C<ok> or C<not
+ok>.
+
+=item skip_out
+
+Setting this to a true value will cause the test to ignore if the
+output sent by the test to the output stream does not match that
+declared with C<test_out>.
+
+=item skip_err
+
+Setting this to a true value will cause the test to ignore if the
+output sent by the test to the error stream does not match that
+declared with C<test_err>.
+
+=back
+
+As a convenience, if only one argument is passed then this argument
+is assumed to be the name of the test (as in the above examples.)
+
+Once C<test_test> has been run test output will be redirected back to
+the original filehandles that L<Test::Builder> was connected to
+(probably STDOUT and STDERR,) meaning any further tests you run
+will function normally and cause success/errors for L<Test::Harness>.
+
+=cut
+
+sub test_test {
+    # END the hack
+    delete $INC{'Test/Stream.pm'} if $INC{'Test/Stream.pm'} && $INC{'Test/Stream.pm'} eq 'fake';
+    # decode the arguments as described in the pod
+    my $mess;
+    my %args;
+    if( @_ == 1 ) {
+        $mess = shift
+    }
+    else {
+        %args = @_;
+        $mess = $args{name} if exists( $args{name} );
+        $mess = $args{title} if exists( $args{title} );
+        $mess = $args{label} if exists( $args{label} );
+    }
+
+    # er, are we testing?
+    croak "Not testing.  You must declare output with a test function first."
+      unless $testing;
+
+
+    my $hub = $t->{Hub} || Test2::API::test2_stack->top;
+    $hub->format($original_formatter);
+
+    # okay, reconnect the test suite back to the saved handles
+    $t->output($original_output_handle);
+    $t->failure_output($original_failure_handle);
+    $t->todo_output($original_todo_handle);
+
+    # restore the test no, etc, back to the original point
+    $t->current_test($testing_num);
+    $testing = 0;
+    $t->is_passing($original_is_passing);
+
+    # re-enable the original setting of the harness
+    $ENV{HARNESS_ACTIVE} = $original_harness_env;
+
+    # check the output we've stashed
+    unless( $t->ok( ( $args{skip_out} || $out->check ) &&
+                    ( $args{skip_err} || $err->check ), $mess ) 
+    )
+    {
+        # print out the diagnostic information about why this
+        # test failed
+
+        local $_;
+
+        $t->diag( map { "$_\n" } $out->complaint )
+          unless $args{skip_out} || $out->check;
+
+        $t->diag( map { "$_\n" } $err->complaint )
+          unless $args{skip_err} || $err->check;
+    }
+}
+
+=item line_num
+
+A utility function that returns the line number that the function was
+called on.  You can pass it an offset which will be added to the
+result.  This is very useful for working out the correct text of
+diagnostic functions that contain line numbers.
+
+Essentially this is the same as the C<__LINE__> macro, but the
+C<line_num(+3)> idiom is arguably nicer.
+
+=cut
+
+sub line_num {
+    my( $package, $filename, $line ) = caller;
+    return $line + ( shift() || 0 );    # prevent warnings
+}
+
+=back
+
+In addition to the six exported functions there exists one
+function that can only be accessed with a fully qualified function
+call.
+
+=over 4
+
+=item color
+
+When C<test_test> is called and the output that your tests generate
+does not match that which you declared, C<test_test> will print out
+debug information showing the two conflicting versions.  As this
+output itself is debug information it can be confusing which part of
+the output is from C<test_test> and which was the original output from
+your original tests.  Also, it may be hard to spot things like
+extraneous whitespace at the end of lines that may cause your test to
+fail even though the output looks similar.
+
+To assist you C<test_test> can colour the background of the debug
+information to disambiguate the different types of output. The debug
+output will have its background coloured green and red.  The green
+part represents the text which is the same between the executed and
+actual output, the red shows which part differs.
+
+The C<color> function determines if colouring should occur or not.
+Passing it a true or false value will enable or disable colouring
+respectively, and the function called with no argument will return the
+current setting.
+
+To enable colouring from the command line, you can use the
+L<Text::Builder::Tester::Color> module like so:
+
+   perl -Mlib=Text::Builder::Tester::Color test.t
+
+Or by including the L<Test::Builder::Tester::Color> module directly in
+the PERL5LIB.
+
+=cut
+
+my $color;
+
+sub color {
+    $color = shift if @_;
+    $color;
+}
+
+=back
+
+=head1 BUGS
+
+Test::Builder::Tester does not handle plans well. It has never done anything
+special with plans. This means that plans from outside Test::Builder::Tester
+will effect Test::Builder::Tester, worse plans when using Test::Builder::Tester
+will effect overall testing. At this point there are no plans to fix this bug
+as people have come to depend on it, and Test::Builder::Tester is now
+discouraged in favor of C<Test2::API::intercept()>. See
+L<https://github.com/Test-More/test-more/issues/667>
+
+Calls C<< Test::Builder->no_ending >> turning off the ending tests.
+This is needed as otherwise it will trip out because we've run more
+tests than we strictly should have and it'll register any failures we
+had that we were testing for as real failures.
+
+The color function doesn't work unless L<Term::ANSIColor> is
+compatible with your terminal. Additionally, L<Win32::Console::ANSI>
+must be installed on windows platforms for color output.
+
+Bugs (and requests for new features) can be reported to the author
+though GitHub:
+L<https://github.com/Test-More/test-more/issues>
+
+=head1 AUTHOR
+
+Copyright Mark Fowler E<lt>mark@twoshortplanks.comE<gt> 2002, 2004.
+
+Some code taken from L<Test::More> and L<Test::Catch>, written by
+Michael G Schwern E<lt>schwern@pobox.comE<gt>.  Hence, those parts
+Copyright Micheal G Schwern 2001.  Used and distributed with
+permission.
+
+This program is free software; you can redistribute it
+and/or modify it under the same terms as Perl itself.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 NOTES
+
+Thanks to Richard Clamp E<lt>richardc@unixbeard.netE<gt> for letting
+me use his testing system to try this module out on.
+
+=head1 SEE ALSO
+
+L<Test::Builder>, L<Test::Builder::Tester::Color>, L<Test::More>.
+
+=cut
+
+1;
+
+####################################################################
+# Helper class that is used to remember expected and received data
+
+package Test::Builder::Tester::Tie;
+
+##
+# add line(s) to be expected
+
+sub expect {
+    my $self = shift;
+
+    my @checks = @_;
+    foreach my $check (@checks) {
+        $check = $self->_account_for_subtest($check);
+        $check = $self->_translate_Failed_check($check);
+        push @{ $self->{wanted} }, ref $check ? $check : "$check\n";
+    }
+}
+
+sub _account_for_subtest {
+    my( $self, $check ) = @_;
+
+    my $hub = $t->{Stack}->top;
+    my $nesting = $hub->isa('Test2::Hub::Subtest') ? $hub->nested : 0;
+    return ref($check) ? $check : ('    ' x $nesting) . $check;
+}
+
+sub _translate_Failed_check {
+    my( $self, $check ) = @_;
+
+    if( $check =~ /\A(.*)#     (Failed .*test) \((.*?) at line (\d+)\)\Z(?!\n)/ ) {
+        $check = "/\Q$1\E#\\s+\Q$2\E.*?\\n?.*?\Qat $3\E line \Q$4\E.*\\n?/";
+    }
+
+    return $check;
+}
+
+##
+# return true iff the expected data matches the got data
+
+sub check {
+    my $self = shift;
+
+    # turn off warnings as these might be undef
+    local $^W = 0;
+
+    my @checks = @{ $self->{wanted} };
+    my $got    = $self->{got};
+    foreach my $check (@checks) {
+        $check = "\Q$check\E" unless( $check =~ s,^/(.*)/$,$1, or ref $check );
+        return 0 unless $got =~ s/^$check//;
+    }
+
+    return length $got == 0;
+}
+
+##
+# a complaint message about the inputs not matching (to be
+# used for debugging messages)
+
+sub complaint {
+    my $self   = shift;
+    my $type   = $self->type;
+    my $got    = $self->got;
+    my $wanted = join '', @{ $self->wanted };
+
+    # are we running in colour mode?
+    if(Test::Builder::Tester::color) {
+        # get color
+        eval { require Term::ANSIColor };
+        unless($@) {
+            eval { require Win32::Console::ANSI } if 'MSWin32' eq $^O;  # support color on windows platforms
+
+            # colours
+
+            my $green = Term::ANSIColor::color("black") . Term::ANSIColor::color("on_green");
+            my $red   = Term::ANSIColor::color("black") . Term::ANSIColor::color("on_red");
+            my $reset = Term::ANSIColor::color("reset");
+
+            # work out where the two strings start to differ
+            my $char = 0;
+            $char++ while substr( $got, $char, 1 ) eq substr( $wanted, $char, 1 );
+
+            # get the start string and the two end strings
+            my $start = $green . substr( $wanted, 0, $char );
+            my $gotend    = $red . substr( $got,    $char ) . $reset;
+            my $wantedend = $red . substr( $wanted, $char ) . $reset;
+
+            # make the start turn green on and off
+            $start =~ s/\n/$reset\n$green/g;
+
+            # make the ends turn red on and off
+            $gotend    =~ s/\n/$reset\n$red/g;
+            $wantedend =~ s/\n/$reset\n$red/g;
+
+            # rebuild the strings
+            $got    = $start . $gotend;
+            $wanted = $start . $wantedend;
+        }
+    }
+
+    my @got = split "\n", $got;
+    my @wanted = split "\n", $wanted;
+
+    $got = "";
+    $wanted = "";
+
+    while (@got || @wanted) {
+        my $g = shift @got    || "";
+        my $w = shift @wanted || "";
+        if ($g ne $w) {
+            if($g =~ s/(\s+)$/    |> /g) {
+                $g .= ($_ eq ' ' ? '_' : '\t') for split '', $1;
+            }
+            if($w =~ s/(\s+)$/    |> /g) {
+                $w .= ($_ eq ' ' ? '_' : '\t') for split '', $1;
+            }
+            $g = "> $g";
+            $w = "> $w";
+        }
+        else {
+            $g = "  $g";
+            $w = "  $w";
+        }
+        $got = $got ? "$got\n$g" : $g;
+        $wanted = $wanted ? "$wanted\n$w" : $w;
+    }
+
+    return "$type is:\n" . "$got\nnot:\n$wanted\nas expected";
+}
+
+##
+# forget all expected and got data
+
+sub reset {
+    my $self = shift;
+    %$self = (
+        type   => $self->{type},
+        got    => '',
+        wanted => [],
+    );
+}
+
+sub got {
+    my $self = shift;
+    return $self->{got};
+}
+
+sub wanted {
+    my $self = shift;
+    return $self->{wanted};
+}
+
+sub type {
+    my $self = shift;
+    return $self->{type};
+}
+
+###
+# tie interface
+###
+
+sub PRINT {
+    my $self = shift;
+    $self->{got} .= join '', @_;
+}
+
+sub TIEHANDLE {
+    my( $class, $type ) = @_;
+
+    my $self = bless { type => $type }, $class;
+
+    $self->reset;
+
+    return $self;
+}
+
+sub READ     { }
+sub READLINE { }
+sub GETC     { }
+sub FILENO   { }
+
+1;

t/lib/Test/Builder/Tester/Color.pm

@@ -0,0 +1,51 @@
+package Test::Builder::Tester::Color;
+
+use strict;
+our $VERSION = '1.302175';
+
+require Test::Builder::Tester;
+
+
+=head1 NAME
+
+Test::Builder::Tester::Color - turn on colour in Test::Builder::Tester
+
+=head1 SYNOPSIS
+
+   When running a test script
+
+     perl -MTest::Builder::Tester::Color test.t
+
+=head1 DESCRIPTION
+
+Importing this module causes the subroutine color in Test::Builder::Tester
+to be called with a true value causing colour highlighting to be turned
+on in debug output.
+
+The sole purpose of this module is to enable colour highlighting
+from the command line.
+
+=cut
+
+sub import {
+    Test::Builder::Tester::color(1);
+}
+
+=head1 AUTHOR
+
+Copyright Mark Fowler E<lt>mark@twoshortplanks.comE<gt> 2002.
+
+This program is free software; you can redistribute it
+and/or modify it under the same terms as Perl itself.
+
+=head1 BUGS
+
+This module will have no effect unless Term::ANSIColor is installed.
+
+=head1 SEE ALSO
+
+L<Test::Builder::Tester>, L<Term::ANSIColor>
+
+=cut
+
+1;

t/lib/Test/Builder/TodoDiag.pm

@@ -0,0 +1,68 @@
+package Test::Builder::TodoDiag;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+BEGIN { require Test2::Event::Diag; our @ISA = qw(Test2::Event::Diag) }
+
+sub diagnostics { 0 }
+
+sub facet_data {
+    my $self = shift;
+    my $out = $self->SUPER::facet_data();
+    $out->{info}->[0]->{debug} = 0;
+    return $out;
+}
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test::Builder::TodoDiag - Test::Builder subclass of Test2::Event::Diag
+
+=head1 DESCRIPTION
+
+This is used to encapsulate diag messages created inside TODO.
+
+=head1 SYNOPSIS
+
+You do not need to use this directly.
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test/Simple.pm

@@ -0,0 +1,220 @@
+package Test::Simple;
+
+use 5.006;
+
+use strict;
+
+our $VERSION = '1.302175';
+
+use Test::Builder::Module;
+our @ISA    = qw(Test::Builder::Module);
+our @EXPORT = qw(ok);
+
+my $CLASS = __PACKAGE__;
+
+=head1 NAME
+
+Test::Simple - Basic utilities for writing tests.
+
+=head1 SYNOPSIS
+
+  use Test::Simple tests => 1;
+
+  ok( $foo eq $bar, 'foo is bar' );
+
+
+=head1 DESCRIPTION
+
+** If you are unfamiliar with testing B<read L<Test::Tutorial> first!> **
+
+This is an extremely simple, extremely basic module for writing tests
+suitable for CPAN modules and other pursuits.  If you wish to do more
+complicated testing, use the Test::More module (a drop-in replacement
+for this one).
+
+The basic unit of Perl testing is the ok.  For each thing you want to
+test your program will print out an "ok" or "not ok" to indicate pass
+or fail.  You do this with the C<ok()> function (see below).
+
+The only other constraint is you must pre-declare how many tests you
+plan to run.  This is in case something goes horribly wrong during the
+test and your test program aborts, or skips a test or whatever.  You
+do this like so:
+
+    use Test::Simple tests => 23;
+
+You must have a plan.
+
+
+=over 4
+
+=item B<ok>
+
+  ok( $foo eq $bar, $name );
+  ok( $foo eq $bar );
+
+C<ok()> is given an expression (in this case C<$foo eq $bar>).  If it's
+true, the test passed.  If it's false, it didn't.  That's about it.
+
+C<ok()> prints out either "ok" or "not ok" along with a test number (it
+keeps track of that for you).
+
+  # This produces "ok 1 - Hell not yet frozen over" (or not ok)
+  ok( get_temperature($hell) > 0, 'Hell not yet frozen over' );
+
+If you provide a $name, that will be printed along with the "ok/not
+ok" to make it easier to find your test when if fails (just search for
+the name).  It also makes it easier for the next guy to understand
+what your test is for.  It's highly recommended you use test names.
+
+All tests are run in scalar context.  So this:
+
+    ok( @stuff, 'I have some stuff' );
+
+will do what you mean (fail if stuff is empty)
+
+=cut
+
+sub ok ($;$) {    ## no critic (Subroutines::ProhibitSubroutinePrototypes)
+    return $CLASS->builder->ok(@_);
+}
+
+=back
+
+Test::Simple will start by printing number of tests run in the form
+"1..M" (so "1..5" means you're going to run 5 tests).  This strange
+format lets L<Test::Harness> know how many tests you plan on running in
+case something goes horribly wrong.
+
+If all your tests passed, Test::Simple will exit with zero (which is
+normal).  If anything failed it will exit with how many failed.  If
+you run less (or more) tests than you planned, the missing (or extras)
+will be considered failures.  If no tests were ever run Test::Simple
+will throw a warning and exit with 255.  If the test died, even after
+having successfully completed all its tests, it will still be
+considered a failure and will exit with 255.
+
+So the exit codes are...
+
+    0                   all tests successful
+    255                 test died or all passed but wrong # of tests run
+    any other number    how many failed (including missing or extras)
+
+If you fail more than 254 tests, it will be reported as 254.
+
+This module is by no means trying to be a complete testing system.
+It's just to get you started.  Once you're off the ground its
+recommended you look at L<Test::More>.
+
+
+=head1 EXAMPLE
+
+Here's an example of a simple .t file for the fictional Film module.
+
+    use Test::Simple tests => 5;
+
+    use Film;  # What you're testing.
+
+    my $btaste = Film->new({ Title    => 'Bad Taste',
+                             Director => 'Peter Jackson',
+                             Rating   => 'R',
+                             NumExplodingSheep => 1
+                           });
+    ok( defined($btaste) && ref $btaste eq 'Film',     'new() works' );
+
+    ok( $btaste->Title      eq 'Bad Taste',     'Title() get'    );
+    ok( $btaste->Director   eq 'Peter Jackson', 'Director() get' );
+    ok( $btaste->Rating     eq 'R',             'Rating() get'   );
+    ok( $btaste->NumExplodingSheep == 1,        'NumExplodingSheep() get' );
+
+It will produce output like this:
+
+    1..5
+    ok 1 - new() works
+    ok 2 - Title() get
+    ok 3 - Director() get
+    not ok 4 - Rating() get
+    #   Failed test 'Rating() get'
+    #   in t/film.t at line 14.
+    ok 5 - NumExplodingSheep() get
+    # Looks like you failed 1 tests of 5
+
+Indicating the Film::Rating() method is broken.
+
+
+=head1 CAVEATS
+
+Test::Simple will only report a maximum of 254 failures in its exit
+code.  If this is a problem, you probably have a huge test script.
+Split it into multiple files.  (Otherwise blame the Unix folks for
+using an unsigned short integer as the exit status).
+
+Because VMS's exit codes are much, much different than the rest of the
+universe, and perl does horrible mangling to them that gets in my way,
+it works like this on VMS.
+
+    0     SS$_NORMAL        all tests successful
+    4     SS$_ABORT         something went wrong
+
+Unfortunately, I can't differentiate any further.
+
+
+=head1 NOTES
+
+Test::Simple is B<explicitly> tested all the way back to perl 5.6.0.
+
+Test::Simple is thread-safe in perl 5.8.1 and up.
+
+=head1 HISTORY
+
+This module was conceived while talking with Tony Bowden in his
+kitchen one night about the problems I was having writing some really
+complicated feature into the new Testing module.  He observed that the
+main problem is not dealing with these edge cases but that people hate
+to write tests B<at all>.  What was needed was a dead simple module
+that took all the hard work out of testing and was really, really easy
+to learn.  Paul Johnson simultaneously had this idea (unfortunately,
+he wasn't in Tony's kitchen).  This is it.
+
+
+=head1 SEE ALSO
+
+=over 4
+
+=item L<Test::More>
+
+More testing functions!  Once you outgrow Test::Simple, look at
+L<Test::More>.  Test::Simple is 100% forward compatible with L<Test::More>
+(i.e. you can just use L<Test::More> instead of Test::Simple in your
+programs and things will still work).
+
+=back
+
+Look in L<Test::More>'s SEE ALSO for more testing modules.
+
+
+=head1 AUTHORS
+
+Idea by Tony Bowden and Paul Johnson, code by Michael G Schwern
+E<lt>schwern@pobox.comE<gt>, wardrobe by Calvin Klein.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2001-2008 by Michael G Schwern E<lt>schwern@pobox.comE<gt>.
+
+This program is free software; you can redistribute it and/or 
+modify it under the same terms as Perl itself.
+
+See F<http://www.perl.com/perl/misc/Artistic.html>
+
+=cut
+
+1;

t/lib/Test/Tester.pm

@@ -0,0 +1,695 @@
+use strict;
+
+package Test::Tester;
+
+BEGIN
+{
+	if (*Test::Builder::new{CODE})
+	{
+		warn "You should load Test::Tester before Test::Builder (or anything that loads Test::Builder)"
+	}
+}
+
+use Test::Builder;
+use Test::Tester::CaptureRunner;
+use Test::Tester::Delegate;
+
+require Exporter;
+
+use vars qw( @ISA @EXPORT );
+
+our $VERSION = '1.302175';
+
+@EXPORT = qw( run_tests check_tests check_test cmp_results show_space );
+@ISA = qw( Exporter );
+
+my $Test = Test::Builder->new;
+my $Capture = Test::Tester::Capture->new;
+my $Delegator = Test::Tester::Delegate->new;
+$Delegator->{Object} = $Test;
+
+my $runner = Test::Tester::CaptureRunner->new;
+
+my $want_space = $ENV{TESTTESTERSPACE};
+
+sub show_space
+{
+	$want_space = 1;
+}
+
+my $colour = '';
+my $reset = '';
+
+if (my $want_colour = $ENV{TESTTESTERCOLOUR} || $ENV{TESTTESTERCOLOR})
+{
+	if (eval { require Term::ANSIColor; 1 })
+	{
+		eval { require Win32::Console::ANSI } if 'MSWin32' eq $^O;  # support color on windows platforms
+		my ($f, $b) = split(",", $want_colour);
+		$colour = Term::ANSIColor::color($f).Term::ANSIColor::color("on_$b");
+		$reset = Term::ANSIColor::color("reset");
+	}
+
+}
+
+sub new_new
+{
+	return $Delegator;
+}
+
+sub capture
+{
+	return Test::Tester::Capture->new;
+}
+
+sub fh
+{
+	# experiment with capturing output, I don't like it
+	$runner = Test::Tester::FHRunner->new;
+
+	return $Test;
+}
+
+sub find_run_tests
+{
+	my $d = 1;
+	my $found = 0;
+	while ((not $found) and (my ($sub) = (caller($d))[3]) )
+	{
+#		print "$d: $sub\n";
+		$found = ($sub eq "Test::Tester::run_tests");
+		$d++;
+	}
+
+#	die "Didn't find 'run_tests' in caller stack" unless $found;
+	return $d;
+}
+
+sub run_tests
+{
+	local($Delegator->{Object}) = $Capture;
+
+	$runner->run_tests(@_);
+
+	return ($runner->get_premature, $runner->get_results);
+}
+
+sub check_test
+{
+	my $test = shift;
+	my $expect = shift;
+	my $name = shift;
+	$name = "" unless defined($name);
+
+	@_ = ($test, [$expect], $name);
+	goto &check_tests;
+}
+
+sub check_tests
+{
+	my $test = shift;
+	my $expects = shift;
+	my $name = shift;
+	$name = "" unless defined($name);
+
+	my ($prem, @results) = eval { run_tests($test, $name) };
+
+	$Test->ok(! $@, "Test '$name' completed") || $Test->diag($@);
+	$Test->ok(! length($prem), "Test '$name' no premature diagnostication") ||
+		$Test->diag("Before any testing anything, your tests said\n$prem");
+
+	local $Test::Builder::Level = $Test::Builder::Level + 1;
+	cmp_results(\@results, $expects, $name);
+	return ($prem, @results);
+}
+
+sub cmp_field
+{
+	my ($result, $expect, $field, $desc) = @_;
+
+	if (defined $expect->{$field})
+	{
+		$Test->is_eq($result->{$field}, $expect->{$field},
+			"$desc compare $field");
+	}
+}
+
+sub cmp_result
+{
+	my ($result, $expect, $name) = @_;
+
+	my $sub_name = $result->{name};
+	$sub_name = "" unless defined($name);
+
+	my $desc = "subtest '$sub_name' of '$name'";
+
+	{
+		local $Test::Builder::Level = $Test::Builder::Level + 1;
+
+		cmp_field($result, $expect, "ok", $desc);
+
+		cmp_field($result, $expect, "actual_ok", $desc);
+
+		cmp_field($result, $expect, "type", $desc);
+
+		cmp_field($result, $expect, "reason", $desc);
+
+		cmp_field($result, $expect, "name", $desc);
+	}
+
+	# if we got no depth then default to 1
+	my $depth = 1;
+	if (exists $expect->{depth})
+	{
+		$depth = $expect->{depth};
+	}
+
+	# if depth was explicitly undef then don't test it
+	if (defined $depth)
+	{
+		$Test->is_eq($result->{depth}, $depth, "checking depth") ||
+			$Test->diag('You need to change $Test::Builder::Level');
+	}
+
+	if (defined(my $exp = $expect->{diag}))
+	{
+
+        my $got = '';
+        if (ref $exp eq 'Regexp') {
+
+            if (not $Test->like($result->{diag}, $exp,
+                "subtest '$sub_name' of '$name' compare diag"))
+            {
+                $got = $result->{diag};
+            }
+
+        } else {
+
+            # if there actually is some diag then put a \n on the end if it's not
+            # there already
+            $exp .= "\n" if (length($exp) and $exp !~ /\n$/);
+
+            if (not $Test->ok($result->{diag} eq $exp,
+    			"subtest '$sub_name' of '$name' compare diag"))
+            {
+                $got = $result->{diag};
+            }
+        }
+
+        if ($got) {
+    		my $glen = length($got);
+    		my $elen = length($exp);
+    		for ($got, $exp)
+    		{
+    			my @lines = split("\n", $_);
+     			$_ = join("\n", map {
+    				if ($want_space)
+    				{
+    					$_ = $colour.escape($_).$reset;
+    				}
+    				else
+    				{
+    					"'$colour$_$reset'"
+    				}
+    			} @lines);
+    		}
+
+        	$Test->diag(<<EOM);
+Got diag ($glen bytes):
+$got
+Expected diag ($elen bytes):
+$exp
+EOM
+        }
+	}
+}
+
+sub escape
+{
+	my $str = shift;
+	my $res = '';
+	for my $char (split("", $str))
+	{
+		my $c = ord($char);
+		if(($c>32 and $c<125) or $c == 10)
+		{
+			$res .= $char;
+		}
+		else
+		{
+			$res .= sprintf('\x{%x}', $c)
+		}
+	}
+	return $res;
+}
+
+sub cmp_results
+{
+	my ($results, $expects, $name) = @_;
+
+	$Test->is_num(scalar @$results, scalar @$expects, "Test '$name' result count");
+
+	for (my $i = 0; $i < @$expects; $i++)
+	{
+		my $expect = $expects->[$i];
+		my $result = $results->[$i];
+
+		local $Test::Builder::Level = $Test::Builder::Level + 1;
+		cmp_result($result, $expect, $name);
+	}
+}
+
+######## nicked from Test::More
+sub plan {
+	my(@plan) = @_;
+
+	my $caller = caller;
+
+	$Test->exported_to($caller);
+
+	my @imports = ();
+	foreach my $idx (0..$#plan) {
+		if( $plan[$idx] eq 'import' ) {
+			my($tag, $imports) = splice @plan, $idx, 2;
+			@imports = @$imports;
+			last;
+		}
+	}
+
+	$Test->plan(@plan);
+
+	__PACKAGE__->_export_to_level(1, __PACKAGE__, @imports);
+}
+
+sub import {
+	my($class) = shift;
+		{
+			no warnings 'redefine';
+			*Test::Builder::new = \&new_new;
+		}
+	goto &plan;
+}
+
+sub _export_to_level
+{
+        my $pkg = shift;
+	my $level = shift;
+	(undef) = shift;	# redundant arg
+	my $callpkg = caller($level);
+	$pkg->export($callpkg, @_);
+}
+
+
+############
+
+1;
+
+__END__
+
+=head1 NAME
+
+Test::Tester - Ease testing test modules built with Test::Builder
+
+=head1 SYNOPSIS
+
+  use Test::Tester tests => 6;
+
+  use Test::MyStyle;
+
+  check_test(
+    sub {
+      is_mystyle_eq("this", "that", "not eq");
+    },
+    {
+      ok => 0, # expect this to fail
+      name => "not eq",
+      diag => "Expected: 'this'\nGot: 'that'",
+    }
+  );
+
+or
+
+  use Test::Tester tests => 6;
+
+  use Test::MyStyle;
+
+  check_test(
+    sub {
+      is_mystyle_qr("this", "that", "not matching");
+    },
+    {
+      ok => 0, # expect this to fail
+      name => "not matching",
+      diag => qr/Expected: 'this'\s+Got: 'that'/,
+    }
+  );
+
+or
+
+  use Test::Tester;
+
+  use Test::More tests => 3;
+  use Test::MyStyle;
+
+  my ($premature, @results) = run_tests(
+    sub {
+      is_database_alive("dbname");
+    }
+  );
+
+  # now use Test::More::like to check the diagnostic output
+
+  like($results[0]->{diag}, "/^Database ping took \\d+ seconds$"/, "diag");
+
+=head1 DESCRIPTION
+
+If you have written a test module based on Test::Builder then Test::Tester
+allows you to test it with the minimum of effort.
+
+=head1 HOW TO USE (THE EASY WAY)
+
+From version 0.08 Test::Tester no longer requires you to included anything
+special in your test modules. All you need to do is
+
+  use Test::Tester;
+
+in your test script B<before> any other Test::Builder based modules and away
+you go.
+
+Other modules based on Test::Builder can be used to help with the
+testing.  In fact you can even use functions from your module to test
+other functions from the same module (while this is possible it is
+probably not a good idea, if your module has bugs, then
+using it to test itself may give the wrong answers).
+
+The easiest way to test is to do something like
+
+  check_test(
+    sub { is_mystyle_eq("this", "that", "not eq") },
+    {
+      ok => 0, # we expect the test to fail
+      name => "not eq",
+      diag => "Expected: 'this'\nGot: 'that'",
+    }
+  );
+
+this will execute the is_mystyle_eq test, capturing its results and
+checking that they are what was expected.
+
+You may need to examine the test results in a more flexible way, for
+example, the diagnostic output may be quite long or complex or it may involve
+something that you cannot predict in advance like a timestamp. In this case
+you can get direct access to the test results:
+
+  my ($premature, @results) = run_tests(
+    sub {
+      is_database_alive("dbname");
+    }
+  );
+
+  like($result[0]->{diag}, "/^Database ping took \\d+ seconds$"/, "diag");
+
+or
+
+  check_test(
+    sub { is_mystyle_qr("this", "that", "not matching") },
+    {
+      ok => 0, # we expect the test to fail
+      name => "not matching",
+      diag => qr/Expected: 'this'\s+Got: 'that'/,
+    }
+  );
+
+We cannot predict how long the database ping will take so we use
+Test::More's like() test to check that the diagnostic string is of the right
+form.
+
+=head1 HOW TO USE (THE HARD WAY)
+
+I<This is here for backwards compatibility only>
+
+Make your module use the Test::Tester::Capture object instead of the
+Test::Builder one. How to do this depends on your module but assuming that
+your module holds the Test::Builder object in $Test and that all your test
+routines access it through $Test then providing a function something like this
+
+  sub set_builder
+  {
+    $Test = shift;
+  }
+
+should allow your test scripts to do
+
+  Test::YourModule::set_builder(Test::Tester->capture);
+
+and after that any tests inside your module will captured.
+
+=head1 TEST RESULTS
+
+The result of each test is captured in a hash. These hashes are the same as
+the hashes returned by Test::Builder->details but with a couple of extra
+fields.
+
+These fields are documented in L<Test::Builder> in the details() function
+
+=over 2
+
+=item ok
+
+Did the test pass?
+
+=item actual_ok
+
+Did the test really pass? That is, did the pass come from
+Test::Builder->ok() or did it pass because it was a TODO test?
+
+=item name
+
+The name supplied for the test.
+
+=item type
+
+What kind of test? Possibilities include, skip, todo etc. See
+L<Test::Builder> for more details.
+
+=item reason
+
+The reason for the skip, todo etc. See L<Test::Builder> for more details.
+
+=back
+
+These fields are exclusive to Test::Tester.
+
+=over 2
+
+=item diag
+
+Any diagnostics that were output for the test. This only includes
+diagnostics output B<after> the test result is declared.
+
+Note that Test::Builder ensures that any diagnostics end in a \n and
+it in earlier versions of Test::Tester it was essential that you have
+the final \n in your expected diagnostics. From version 0.10 onward,
+Test::Tester will add the \n if you forgot it. It will not add a \n if
+you are expecting no diagnostics. See below for help tracking down
+hard to find space and tab related problems.
+
+=item depth
+
+This allows you to check that your test module is setting the correct value
+for $Test::Builder::Level and thus giving the correct file and line number
+when a test fails. It is calculated by looking at caller() and
+$Test::Builder::Level. It should count how many subroutines there are before
+jumping into the function you are testing. So for example in
+
+  run_tests( sub { my_test_function("a", "b") } );
+
+the depth should be 1 and in
+
+  sub deeper { my_test_function("a", "b") }
+
+  run_tests(sub { deeper() });
+
+depth should be 2, that is 1 for the sub {} and one for deeper(). This
+might seem a little complex but if your tests look like the simple
+examples in this doc then you don't need to worry as the depth will
+always be 1 and that's what Test::Tester expects by default.
+
+B<Note>: if you do not specify a value for depth in check_test() then it
+automatically compares it against 1, if you really want to skip the depth
+test then pass in undef.
+
+B<Note>: depth will not be correctly calculated for tests that run from a
+signal handler or an END block or anywhere else that hides the call stack.
+
+=back
+
+Some of Test::Tester's functions return arrays of these hashes, just
+like Test::Builder->details. That is, the hash for the first test will
+be array element 1 (not 0). Element 0 will not be a hash it will be a
+string which contains any diagnostic output that came before the first
+test. This should usually be empty, if it's not, it means something
+output diagnostics before any test results showed up.
+
+=head1 SPACES AND TABS
+
+Appearances can be deceptive, especially when it comes to emptiness. If you
+are scratching your head trying to work out why Test::Tester is saying that
+your diagnostics are wrong when they look perfectly right then the answer is
+probably whitespace. From version 0.10 on, Test::Tester surrounds the
+expected and got diag values with single quotes to make it easier to spot
+trailing whitespace. So in this example
+
+  # Got diag (5 bytes):
+  # 'abcd '
+  # Expected diag (4 bytes):
+  # 'abcd'
+
+it is quite clear that there is a space at the end of the first string.
+Another way to solve this problem is to use colour and inverse video on an
+ANSI terminal, see below COLOUR below if you want this.
+
+Unfortunately this is sometimes not enough, neither colour nor quotes will
+help you with problems involving tabs, other non-printing characters and
+certain kinds of problems inherent in Unicode. To deal with this, you can
+switch Test::Tester into a mode whereby all "tricky" characters are shown as
+\{xx}. Tricky characters are those with ASCII code less than 33 or higher
+than 126. This makes the output more difficult to read but much easier to
+find subtle differences between strings. To turn on this mode either call
+C<show_space()> in your test script or set the C<TESTTESTERSPACE> environment
+variable to be a true value. The example above would then look like
+
+  # Got diag (5 bytes):
+  # abcd\x{20}
+  # Expected diag (4 bytes):
+  # abcd
+
+=head1 COLOUR
+
+If you prefer to use colour as a means of finding tricky whitespace
+characters then you can set the C<TESTTESTCOLOUR> environment variable to a
+comma separated pair of colours, the first for the foreground, the second
+for the background. For example "white,red" will print white text on a red
+background. This requires the Term::ANSIColor module. You can specify any
+colour that would be acceptable to the Term::ANSIColor::color function.
+
+If you spell colour differently, that's no problem. The C<TESTTESTERCOLOR>
+variable also works (if both are set then the British spelling wins out).
+
+=head1 EXPORTED FUNCTIONS
+
+=head3 ($premature, @results) = run_tests(\&test_sub)
+
+\&test_sub is a reference to a subroutine.
+
+run_tests runs the subroutine in $test_sub and captures the results of any
+tests inside it. You can run more than 1 test inside this subroutine if you
+like.
+
+$premature is a string containing any diagnostic output from before
+the first test.
+
+@results is an array of test result hashes.
+
+=head3 cmp_result(\%result, \%expect, $name)
+
+\%result is a ref to a test result hash.
+
+\%expect is a ref to a hash of expected values for the test result.
+
+cmp_result compares the result with the expected values. If any differences
+are found it outputs diagnostics. You may leave out any field from the
+expected result and cmp_result will not do the comparison of that field.
+
+=head3 cmp_results(\@results, \@expects, $name)
+
+\@results is a ref to an array of test results.
+
+\@expects is a ref to an array of hash refs.
+
+cmp_results checks that the results match the expected results and if any
+differences are found it outputs diagnostics. It first checks that the
+number of elements in \@results and \@expects is the same. Then it goes
+through each result checking it against the expected result as in
+cmp_result() above.
+
+=head3 ($premature, @results) = check_tests(\&test_sub, \@expects, $name)
+
+\&test_sub is a reference to a subroutine.
+
+\@expect is a ref to an array of hash refs which are expected test results.
+
+check_tests combines run_tests and cmp_tests into a single call. It also
+checks if the tests died at any stage.
+
+It returns the same values as run_tests, so you can further examine the test
+results if you need to.
+
+=head3 ($premature, @results) = check_test(\&test_sub, \%expect, $name)
+
+\&test_sub is a reference to a subroutine.
+
+\%expect is a ref to an hash of expected values for the test result.
+
+check_test is a wrapper around check_tests. It combines run_tests and
+cmp_tests into a single call, checking if the test died. It assumes
+that only a single test is run inside \&test_sub and include a test to
+make sure this is true.
+
+It returns the same values as run_tests, so you can further examine the test
+results if you need to.
+
+=head3 show_space()
+
+Turn on the escaping of characters as described in the SPACES AND TABS
+section.
+
+=head1 HOW IT WORKS
+
+Normally, a test module (let's call it Test:MyStyle) calls
+Test::Builder->new to get the Test::Builder object. Test::MyStyle calls
+methods on this object to record information about test results. When
+Test::Tester is loaded, it replaces Test::Builder's new() method with one
+which returns a Test::Tester::Delegate object. Most of the time this object
+behaves as the real Test::Builder object. Any methods that are called are
+delegated to the real Test::Builder object so everything works perfectly.
+However once we go into test mode, the method calls are no longer passed to
+the real Test::Builder object, instead they go to the Test::Tester::Capture
+object. This object seems exactly like the real Test::Builder object,
+except, instead of outputting test results and diagnostics, it just records
+all the information for later analysis.
+
+=head1 CAVEATS
+
+Support for calling Test::Builder->note is minimal. It's implemented
+as an empty stub, so modules that use it will not crash but the calls
+are not recorded for testing purposes like the others. Patches
+welcome.
+
+=head1 SEE ALSO
+
+L<Test::Builder> the source of testing goodness. L<Test::Builder::Tester>
+for an alternative approach to the problem tackled by Test::Tester -
+captures the strings output by Test::Builder. This means you cannot get
+separate access to the individual pieces of information and you must predict
+B<exactly> what your test will output.
+
+=head1 AUTHOR
+
+This module is copyright 2005 Fergal Daly <fergal@esatclear.ie>, some parts
+are based on other people's work.
+
+Plan handling lifted from Test::More. written by Michael G Schwern
+<schwern@pobox.com>.
+
+Test::Tester::Capture is a cut down and hacked up version of Test::Builder.
+Test::Builder was written by chromatic <chromatic@wgz.org> and Michael G
+Schwern <schwern@pobox.com>.
+
+=head1 LICENSE
+
+Under the same license as Perl itself
+
+See http://www.perl.com/perl/misc/Artistic.html
+
+=cut

t/lib/Test/Tester/Capture.pm

@@ -0,0 +1,241 @@
+use strict;
+
+package Test::Tester::Capture;
+
+our $VERSION = '1.302175';
+
+
+use Test::Builder;
+
+use vars qw( @ISA );
+@ISA = qw( Test::Builder );
+
+# Make Test::Tester::Capture thread-safe for ithreads.
+BEGIN {
+	use Config;
+	*share = sub { 0 };
+	*lock  = sub { 0 };
+}
+
+my $Curr_Test = 0;      share($Curr_Test);
+my @Test_Results = ();  share(@Test_Results);
+my $Prem_Diag = {diag => ""};	 share($Curr_Test);
+
+sub new
+{
+  # Test::Tester::Capgture::new used to just return __PACKAGE__
+  # because Test::Builder::new enforced its singleton nature by
+  # return __PACKAGE__. That has since changed, Test::Builder::new now
+  # returns a blessed has and around version 0.78, Test::Builder::todo
+  # started wanting to modify $self. To cope with this, we now return
+  # a blessed hash. This is a short-term hack, the correct thing to do
+  # is to detect which style of Test::Builder we're dealing with and
+  # act appropriately.
+
+  my $class = shift;
+  return bless {}, $class;
+}
+
+sub ok {
+	my($self, $test, $name) = @_;
+
+	my $ctx = $self->ctx;
+
+	# $test might contain an object which we don't want to accidentally
+	# store, so we turn it into a boolean.
+	$test = $test ? 1 : 0;
+
+	lock $Curr_Test;
+	$Curr_Test++;
+
+	my($pack, $file, $line) = $self->caller;
+
+	my $todo = $self->todo();
+
+	my $result = {};
+	share($result);
+
+	unless( $test ) {
+		@$result{ 'ok', 'actual_ok' } = ( ( $todo ? 1 : 0 ), 0 );
+	}
+	else {
+		@$result{ 'ok', 'actual_ok' } = ( 1, $test );
+	}
+
+	if( defined $name ) {
+		$name =~ s|#|\\#|g;	 # # in a name can confuse Test::Harness.
+		$result->{name} = $name;
+	}
+	else {
+		$result->{name} = '';
+	}
+
+	if( $todo ) {
+		my $what_todo = $todo;
+		$result->{reason} = $what_todo;
+		$result->{type}   = 'todo';
+	}
+	else {
+		$result->{reason} = '';
+		$result->{type}   = '';
+	}
+
+	$Test_Results[$Curr_Test-1] = $result;
+
+	unless( $test ) {
+		my $msg = $todo ? "Failed (TODO)" : "Failed";
+		$result->{fail_diag} = ("	$msg test ($file at line $line)\n");
+	} 
+
+	$result->{diag} = "";
+	$result->{_level} = $Test::Builder::Level;
+	$result->{_depth} = Test::Tester::find_run_tests();
+
+	$ctx->release;
+
+	return $test ? 1 : 0;
+}
+
+sub skip {
+	my($self, $why) = @_;
+	$why ||= '';
+
+	my $ctx = $self->ctx;
+
+	lock($Curr_Test);
+	$Curr_Test++;
+
+	my %result;
+	share(%result);
+	%result = (
+		'ok'	  => 1,
+		actual_ok => 1,
+		name	  => '',
+		type	  => 'skip',
+		reason	=> $why,
+		diag    => "",
+		_level   => $Test::Builder::Level,
+		_depth => Test::Tester::find_run_tests(),
+	);
+	$Test_Results[$Curr_Test-1] = \%result;
+
+	$ctx->release;
+	return 1;
+}
+
+sub todo_skip {
+	my($self, $why) = @_;
+	$why ||= '';
+
+	my $ctx = $self->ctx;
+
+	lock($Curr_Test);
+	$Curr_Test++;
+
+	my %result;
+	share(%result);
+	%result = (
+		'ok'	  => 1,
+		actual_ok => 0,
+		name	  => '',
+		type	  => 'todo_skip',
+		reason	=> $why,
+		diag    => "",
+		_level   => $Test::Builder::Level,
+		_depth => Test::Tester::find_run_tests(),
+	);
+
+	$Test_Results[$Curr_Test-1] = \%result;
+
+	$ctx->release;
+	return 1;
+}
+
+sub diag {
+	my($self, @msgs) = @_;
+	return unless @msgs;
+
+	# Prevent printing headers when compiling (i.e. -c)
+	return if $^C;
+
+	my $ctx = $self->ctx;
+
+	# Escape each line with a #.
+	foreach (@msgs) {
+		$_ = 'undef' unless defined;
+	}
+
+	push @msgs, "\n" unless $msgs[-1] =~ /\n\Z/;
+
+	my $result = $Curr_Test ? $Test_Results[$Curr_Test - 1] : $Prem_Diag;
+
+	$result->{diag} .= join("", @msgs);
+
+	$ctx->release;
+	return 0;
+}
+
+sub details {
+	return @Test_Results;
+}
+
+
+# Stub. Feel free to send me a patch to implement this.
+sub note {
+}
+
+sub explain {
+	return Test::Builder::explain(@_);
+}
+
+sub premature
+{
+	return $Prem_Diag->{diag};
+}
+
+sub current_test
+{
+	if (@_ > 1)
+	{
+		die "Don't try to change the test number!";
+	}
+	else
+	{
+		return $Curr_Test;
+	}
+}
+
+sub reset
+{
+	$Curr_Test = 0;
+	@Test_Results = ();
+	$Prem_Diag = {diag => ""};
+}
+
+1;
+
+__END__
+
+=head1 NAME
+
+Test::Tester::Capture - Help testing test modules built with Test::Builder
+
+=head1 DESCRIPTION
+
+This is a subclass of Test::Builder that overrides many of the methods so
+that they don't output anything. It also keeps track of its own set of test
+results so that you can use Test::Builder based modules to perform tests on
+other Test::Builder based modules.
+
+=head1 AUTHOR
+
+Most of the code here was lifted straight from Test::Builder and then had
+chunks removed by Fergal Daly <fergal@esatclear.ie>.
+
+=head1 LICENSE
+
+Under the same license as Perl itself
+
+See http://www.perl.com/perl/misc/Artistic.html
+
+=cut

t/lib/Test/Tester/CaptureRunner.pm

@@ -0,0 +1,79 @@
+# $Header: /home/fergal/my/cvs/Test-Tester/lib/Test/Tester/CaptureRunner.pm,v 1.3 2003/03/05 01:07:55 fergal Exp $
+use strict;
+
+package Test::Tester::CaptureRunner;
+
+our $VERSION = '1.302175';
+
+
+use Test::Tester::Capture;
+require Exporter;
+
+sub new
+{
+	my $pkg = shift;
+	my $self = bless {}, $pkg;
+	return $self;
+}
+
+sub run_tests
+{
+	my $self = shift;
+
+	my $test = shift;
+
+	capture()->reset;
+
+	$self->{StartLevel} = $Test::Builder::Level;
+	&$test();
+}
+
+sub get_results
+{
+	my $self = shift;
+	my @results = capture()->details;
+
+	my $start = $self->{StartLevel};
+	foreach my $res (@results)
+	{
+		next if defined $res->{depth};
+		my $depth = $res->{_depth} - $res->{_level} - $start - 3;
+#		print "my $depth = $res->{_depth} - $res->{_level} - $start - 1\n";
+		$res->{depth} = $depth;
+	}
+
+	return @results;
+}
+
+sub get_premature
+{
+	return capture()->premature;
+}
+
+sub capture
+{
+	return Test::Tester::Capture->new;
+}
+
+__END__
+
+=head1 NAME
+
+Test::Tester::CaptureRunner - Help testing test modules built with Test::Builder
+
+=head1 DESCRIPTION
+
+This stuff if needed to allow me to play with other ways of monitoring the
+test results.
+
+=head1 AUTHOR
+
+Copyright 2003 by Fergal Daly <fergal@esatclear.ie>.
+
+=head1 LICENSE
+
+Under the same license as Perl itself
+
+See http://www.perl.com/perl/misc/Artistic.html
+
+=cut

t/lib/Test/Tester/Delegate.pm

@@ -0,0 +1,45 @@
+use strict;
+use warnings;
+
+package Test::Tester::Delegate;
+
+our $VERSION = '1.302175';
+
+use Scalar::Util();
+
+use vars '$AUTOLOAD';
+
+sub new
+{
+	my $pkg = shift;
+
+	my $obj = shift;
+	my $self = bless {}, $pkg;
+
+	return $self;
+}
+
+sub AUTOLOAD
+{
+	my ($sub) = $AUTOLOAD =~ /.*::(.*?)$/;
+
+	return if $sub eq "DESTROY";
+
+	my $obj = $_[0]->{Object};
+
+	my $ref = $obj->can($sub);
+	shift(@_);
+	unshift(@_, $obj);
+	goto &$ref;
+}
+
+sub can {
+	my $this = shift;
+	my ($sub) = @_;
+
+	return $this->{Object}->can($sub) if Scalar::Util::blessed($this);
+
+	return $this->SUPER::can(@_);
+}
+
+1;

t/lib/Test/use/ok.pm

@@ -0,0 +1,64 @@
+package Test::use::ok;
+use 5.005;
+
+our $VERSION = '1.302175';
+
+
+__END__
+
+=head1 NAME
+
+Test::use::ok - Alternative to Test::More::use_ok
+
+=head1 SYNOPSIS
+
+    use ok 'Some::Module';
+
+=head1 DESCRIPTION
+
+According to the B<Test::More> documentation, it is recommended to run
+C<use_ok()> inside a C<BEGIN> block, so functions are exported at
+compile-time and prototypes are properly honored.
+
+That is, instead of writing this:
+
+    use_ok( 'Some::Module' );
+    use_ok( 'Other::Module' );
+
+One should write this:
+
+    BEGIN { use_ok( 'Some::Module' ); }
+    BEGIN { use_ok( 'Other::Module' ); }
+
+However, people often either forget to add C<BEGIN>, or mistakenly group
+C<use_ok> with other tests in a single C<BEGIN> block, which can create subtle
+differences in execution order.
+
+With this module, simply change all C<use_ok> in test scripts to C<use ok>,
+and they will be executed at C<BEGIN> time.  The explicit space after C<use>
+makes it clear that this is a single compile-time action.
+
+=head1 SEE ALSO
+
+L<Test::More>
+
+=head1 MAINTAINER
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=encoding utf8
+
+=head1 CC0 1.0 Universal
+
+To the extent possible under law, 唐鳳 has waived all copyright and related
+or neighboring rights to L<Test-use-ok>.
+
+This work is published from Taiwan.
+
+L<http://creativecommons.org/publicdomain/zero/1.0>
+
+=cut

t/lib/Test2.pm

@@ -0,0 +1,213 @@
+package Test2;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2 - Framework for writing test tools that all work together.
+
+=head1 DESCRIPTION
+
+Test2 is a new testing framework produced by forking L<Test::Builder>,
+completely refactoring it, adding many new features and capabilities.
+
+=head2 WHAT IS NEW?
+
+=over 4
+
+=item Easier to test new testing tools.
+
+From the beginning Test2 was built with introspection capabilities. With
+Test::Builder it was difficult at best to capture test tool output for
+verification. Test2 Makes it easy with C<Test2::API::intercept()>.
+
+=item Better diagnostics capabilities.
+
+Test2 uses an L<Test2::API::Context> object to track filename, line number, and
+tool details. This object greatly simplifies tracking for where errors should
+be reported.
+
+=item Event driven.
+
+Test2 based tools produce events which get passed through a processing system
+before being output by a formatter. This event system allows for rich plugin
+and extension support.
+
+=item More complete API.
+
+Test::Builder only provided a handful of methods for generating lines of TAP.
+Test2 took inventory of everything people were doing with Test::Builder that
+required hacking it up. Test2 made public API functions for nearly all the
+desired functionality people didn't previously have.
+
+=item Support for output other than TAP.
+
+Test::Builder assumed everything would end up as TAP. Test2 makes no such
+assumption. Test2 provides ways for you to specify alternative and custom
+formatters.
+
+=item Subtest implementation is more sane.
+
+The Test::Builder implementation of subtests was certifiably insane. Test2 uses
+a stacked event hub system that greatly improves how subtests are implemented.
+
+=item Support for threading/forking.
+
+Test2 support for forking and threading can be turned on using L<Test2::IPC>.
+Once turned on threading and forking operate sanely and work as one would
+expect.
+
+=back
+
+=head1 GETTING STARTED
+
+If you are interested in writing tests using new tools then you should look at
+L<Test2::Suite>. L<Test2::Suite> is a separate cpan distribution that contains
+many tools implemented on Test2.
+
+If you are interested in writing new tools you should take a look at
+L<Test2::API> first.
+
+=head1 NAMESPACE LAYOUT
+
+This describes the namespace layout for the Test2 ecosystem. Not all the
+namespaces listed here are part of the Test2 distribution, some are implemented
+in L<Test2::Suite>.
+
+=head2 Test2::Tools::
+
+This namespace is for sets of tools. Modules in this namespace should export
+tools like C<ok()> and C<is()>. Most things written for Test2 should go here.
+Modules in this namespace B<MUST NOT> export subs from other tools. See the
+L</Test2::Bundle::> namespace if you want to do that.
+
+=head2 Test2::Plugin::
+
+This namespace is for plugins. Plugins are modules that change or enhance the
+behavior of Test2. An example of a plugin is a module that sets the encoding to
+utf8 globally. Another example is a module that causes a bail-out event after
+the first test failure.
+
+=head2 Test2::Bundle::
+
+This namespace is for bundles of tools and plugins. Loading one of these may
+load multiple tools and plugins. Modules in this namespace should not implement
+tools directly. In general modules in this namespace should load tools and
+plugins, then re-export things into the consumers namespace.
+
+=head2 Test2::Require::
+
+This namespace is for modules that cause a test to be skipped when conditions
+do not allow it to run. Examples would be modules that skip the test on older
+perls, or when non-essential modules have not been installed.
+
+=head2 Test2::Formatter::
+
+Formatters live under this namespace. L<Test2::Formatter::TAP> is the only
+formatter currently. It is acceptable for third party distributions to create
+new formatters under this namespace.
+
+=head2 Test2::Event::
+
+Events live under this namespace. It is considered acceptable for third party
+distributions to add new event types in this namespace.
+
+=head2 Test2::Hub::
+
+Hub subclasses (and some hub utility objects) live under this namespace. It is
+perfectly reasonable for third party distributions to add new hub subclasses in
+this namespace.
+
+=head2 Test2::IPC::
+
+The IPC subsystem lives in this namespace. There are not many good reasons to
+add anything to this namespace, with exception of IPC drivers.
+
+=head3 Test2::IPC::Driver::
+
+IPC drivers live in this namespace. It is fine to create new IPC drivers and to
+put them in this namespace.
+
+=head2 Test2::Util::
+
+This namespace is for general utilities used by testing tools. Please be
+considerate when adding new modules to this namespace.
+
+=head2 Test2::API::
+
+This is for Test2 API and related packages.
+
+=head2 Test2::
+
+The Test2:: namespace is intended for extensions and frameworks. Tools,
+Plugins, etc should not go directly into this namespace. However extensions
+that are used to build tools and plugins may go here.
+
+In short: If the module exports anything that should be run directly by a test
+script it should probably NOT go directly into C<Test2::XXX>.
+
+=head1 SEE ALSO
+
+L<Test2::API> - Primary API functions.
+
+L<Test2::API::Context> - Detailed documentation of the context object.
+
+L<Test2::IPC> - The IPC system used for threading/fork support.
+
+L<Test2::Formatter> - Formatters such as TAP live here.
+
+L<Test2::Event> - Events live in this namespace.
+
+L<Test2::Hub> - All events eventually funnel through a hub. Custom hubs are how
+C<intercept()> and C<run_subtest()> are implemented.
+
+=head1 CONTACTING US
+
+Many Test2 developers and users lurk on L<irc://irc.perl.org/#perl-qa> and
+L<irc://irc.perl.org/#toolchain>. We also have a slack team that can be joined
+by anyone with an C<@cpan.org> email address L<https://perl-test2.slack.com/>
+If you do not have an C<@cpan.org> email you can ask for a slack invite by
+emailing Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/API/Breakage.pm

@@ -0,0 +1,180 @@
+package Test2::API::Breakage;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+
+use Test2::Util qw/pkg_to_file/;
+
+our @EXPORT_OK = qw{
+    upgrade_suggested
+    upgrade_required
+    known_broken
+};
+BEGIN { require Exporter; our @ISA = qw(Exporter) }
+
+sub upgrade_suggested {
+    return (
+        'Test::Exception'    => '0.42',
+        'Test::FITesque'     => '0.04',
+        'Test::Module::Used' => '0.2.5',
+        'Test::Moose::More'  => '0.025',
+    );
+}
+
+sub upgrade_required {
+    return (
+        'Test::Builder::Clutch'   => '0.07',
+        'Test::Dist::VersionSync' => '1.1.4',
+        'Test::Modern'            => '0.012',
+        'Test::SharedFork'        => '0.34',
+        'Test::Alien'             => '0.04',
+        'Test::UseAllModules'     => '0.14',
+        'Test::More::Prefix'      => '0.005',
+
+        'Test2::Tools::EventDumper' => 0.000007,
+        'Test2::Harness'            => 0.000013,
+
+        'Test::DBIx::Class::Schema'    => '1.0.9',
+        'Test::Clustericious::Cluster' => '0.30',
+    );
+}
+
+sub known_broken {
+    return (
+        'Net::BitTorrent'       => '0.052',
+        'Test::Able'            => '0.11',
+        'Test::Aggregate'       => '0.373',
+        'Test::Flatten'         => '0.11',
+        'Test::Group'           => '0.20',
+        'Test::ParallelSubtest' => '0.05',
+        'Test::Pretty'          => '0.32',
+        'Test::Wrapper'         => '0.3.0',
+
+        'Log::Dispatch::Config::TestLog' => '0.02',
+    );
+}
+
+# Not reportable:
+# Device::Chip => 0.07   - Tests will not pass, but not broken if already installed, also no fixed version we can upgrade to.
+
+sub report {
+    my $class = shift;
+    my ($require) = @_;
+
+    my %suggest  = __PACKAGE__->upgrade_suggested();
+    my %required = __PACKAGE__->upgrade_required();
+    my %broken   = __PACKAGE__->known_broken();
+
+    my @warn;
+    for my $mod (keys %suggest) {
+        my $file = pkg_to_file($mod);
+        next unless $INC{$file} || ($require && eval { require $file; 1 });
+        my $want = $suggest{$mod};
+        next if eval { $mod->VERSION($want); 1 };
+        my $error = $@;
+        chomp $error;
+        push @warn => " * Module '$mod' is outdated, we recommed updating above $want. error was: '$error'; INC is $INC{$file}";
+    }
+
+    for my $mod (keys %required) {
+        my $file = pkg_to_file($mod);
+        next unless $INC{$file} || ($require && eval { require $file; 1 });
+        my $want = $required{$mod};
+        next if eval { $mod->VERSION($want); 1 };
+        push @warn => " * Module '$mod' is outdated and known to be broken, please update to $want or higher.";
+    }
+
+    for my $mod (keys %broken) {
+        my $file = pkg_to_file($mod);
+        next unless $INC{$file} || ($require && eval { require $file; 1 });
+        my $tested = $broken{$mod};
+        push @warn => " * Module '$mod' is known to be broken in version $tested and below, newer versions have not been tested. You have: " . $mod->VERSION;
+    }
+
+    return @warn;
+}
+
+1;
+
+__END__
+
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::API::Breakage - What breaks at what version
+
+=head1 DESCRIPTION
+
+This module provides lists of modules that are broken, or have been broken in
+the past, when upgrading L<Test::Builder> to use L<Test2>.
+
+=head1 FUNCTIONS
+
+These can be imported, or called as methods on the class.
+
+=over 4
+
+=item %mod_ver = upgrade_suggested()
+
+=item %mod_ver = Test2::API::Breakage->upgrade_suggested()
+
+This returns key/value pairs. The key is the module name, the value is the
+version number. If the installed version of the module is at or below the
+specified one then an upgrade would be a good idea, but not strictly necessary.
+
+=item %mod_ver = upgrade_required()
+
+=item %mod_ver = Test2::API::Breakage->upgrade_required()
+
+This returns key/value pairs. The key is the module name, the value is the
+version number. If the installed version of the module is at or below the
+specified one then an upgrade is required for the module to work properly.
+
+=item %mod_ver = known_broken()
+
+=item %mod_ver = Test2::API::Breakage->known_broken()
+
+This returns key/value pairs. The key is the module name, the value is the
+version number. If the installed version of the module is at or below the
+specified one then the module will not work. A newer version may work, but is
+not tested or verified.
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/API/Instance.pm

@@ -0,0 +1,822 @@
+package Test2::API::Instance;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+our @CARP_NOT = qw/Test2::API Test2::API::Instance Test2::IPC::Driver Test2::Formatter/;
+use Carp qw/confess carp/;
+use Scalar::Util qw/reftype/;
+
+use Test2::Util qw/get_tid USE_THREADS CAN_FORK pkg_to_file try CAN_SIGSYS/;
+
+use Test2::EventFacet::Trace();
+use Test2::API::Stack();
+
+use Test2::Util::HashBase qw{
+    _pid _tid
+    no_wait
+    finalized loaded
+    ipc stack formatter
+    contexts
+
+    add_uuid_via
+
+    -preload
+
+    ipc_disabled
+    ipc_polling
+    ipc_drivers
+    ipc_timeout
+    formatters
+
+    exit_callbacks
+    post_load_callbacks
+    context_acquire_callbacks
+    context_init_callbacks
+    context_release_callbacks
+    pre_subtest_callbacks
+};
+
+sub DEFAULT_IPC_TIMEOUT() { 30 }
+
+sub pid { $_[0]->{+_PID} }
+sub tid { $_[0]->{+_TID} }
+
+# Wrap around the getters that should call _finalize.
+BEGIN {
+    for my $finalizer (IPC, FORMATTER) {
+        my $orig = __PACKAGE__->can($finalizer);
+        my $new  = sub {
+            my $self = shift;
+            $self->_finalize unless $self->{+FINALIZED};
+            $self->$orig;
+        };
+
+        no strict 'refs';
+        no warnings 'redefine';
+        *{$finalizer} = $new;
+    }
+}
+
+sub has_ipc { !!$_[0]->{+IPC} }
+
+sub import {
+    my $class = shift;
+    return unless @_;
+    my ($ref) = @_;
+    $$ref = $class->new;
+}
+
+sub init { $_[0]->reset }
+
+sub start_preload {
+    my $self = shift;
+
+    confess "preload cannot be started, Test2::API has already been initialized"
+        if $self->{+FINALIZED} || $self->{+LOADED};
+
+    return $self->{+PRELOAD} = 1;
+}
+
+sub stop_preload {
+    my $self = shift;
+
+    return 0 unless $self->{+PRELOAD};
+    $self->{+PRELOAD} = 0;
+
+    $self->post_preload_reset();
+
+    return 1;
+}
+
+sub post_preload_reset {
+    my $self = shift;
+
+    delete $self->{+_PID};
+    delete $self->{+_TID};
+
+    $self->{+ADD_UUID_VIA} = undef unless exists $self->{+ADD_UUID_VIA};
+
+    $self->{+CONTEXTS} = {};
+
+    $self->{+FORMATTERS} = [];
+
+    $self->{+FINALIZED} = undef;
+    $self->{+IPC}       = undef;
+    $self->{+IPC_DISABLED} = $ENV{T2_NO_IPC} ? 1 : 0;
+
+    $self->{+IPC_TIMEOUT} = DEFAULT_IPC_TIMEOUT() unless defined $self->{+IPC_TIMEOUT};
+
+    $self->{+LOADED} = 0;
+
+    $self->{+STACK} ||= Test2::API::Stack->new;
+}
+
+sub reset {
+    my $self = shift;
+
+    delete $self->{+_PID};
+    delete $self->{+_TID};
+
+    $self->{+ADD_UUID_VIA} = undef;
+
+    $self->{+CONTEXTS} = {};
+
+    $self->{+IPC_DRIVERS} = [];
+    $self->{+IPC_POLLING} = undef;
+
+    $self->{+FORMATTERS} = [];
+    $self->{+FORMATTER}  = undef;
+
+    $self->{+FINALIZED}    = undef;
+    $self->{+IPC}          = undef;
+    $self->{+IPC_DISABLED} = $ENV{T2_NO_IPC} ? 1 : 0;
+
+    $self->{+IPC_TIMEOUT} = DEFAULT_IPC_TIMEOUT() unless defined $self->{+IPC_TIMEOUT};
+
+    $self->{+NO_WAIT} = 0;
+    $self->{+LOADED}  = 0;
+
+    $self->{+EXIT_CALLBACKS}            = [];
+    $self->{+POST_LOAD_CALLBACKS}       = [];
+    $self->{+CONTEXT_ACQUIRE_CALLBACKS} = [];
+    $self->{+CONTEXT_INIT_CALLBACKS}    = [];
+    $self->{+CONTEXT_RELEASE_CALLBACKS} = [];
+    $self->{+PRE_SUBTEST_CALLBACKS}     = [];
+
+    $self->{+STACK} = Test2::API::Stack->new;
+}
+
+sub _finalize {
+    my $self = shift;
+    my ($caller) = @_;
+    $caller ||= [caller(1)];
+
+    confess "Attempt to initialize Test2::API during preload"
+        if $self->{+PRELOAD};
+
+    $self->{+FINALIZED} = $caller;
+
+    $self->{+_PID} = $$        unless defined $self->{+_PID};
+    $self->{+_TID} = get_tid() unless defined $self->{+_TID};
+
+    unless ($self->{+FORMATTER}) {
+        my ($formatter, $source);
+        if ($ENV{T2_FORMATTER}) {
+            $source = "set by the 'T2_FORMATTER' environment variable";
+
+            if ($ENV{T2_FORMATTER} =~ m/^(\+)?(.*)$/) {
+                $formatter = $1 ? $2 : "Test2::Formatter::$2"
+            }
+            else {
+                $formatter = '';
+            }
+        }
+        elsif (@{$self->{+FORMATTERS}}) {
+            ($formatter) = @{$self->{+FORMATTERS}};
+            $source = "Most recently added";
+        }
+        else {
+            $formatter = 'Test2::Formatter::TAP';
+            $source    = 'default formatter';
+        }
+
+        unless (ref($formatter) || $formatter->can('write')) {
+            my $file = pkg_to_file($formatter);
+            my ($ok, $err) = try { require $file };
+            unless ($ok) {
+                my $line   = "* COULD NOT LOAD FORMATTER '$formatter' ($source) *";
+                my $border = '*' x length($line);
+                die "\n\n  $border\n  $line\n  $border\n\n$err";
+            }
+        }
+
+        $self->{+FORMATTER} = $formatter;
+    }
+
+    # Turn on IPC if threads are on, drivers are registered, or the Test2::IPC
+    # module is loaded.
+    return if $self->{+IPC_DISABLED};
+    return unless USE_THREADS || $INC{'Test2/IPC.pm'} || @{$self->{+IPC_DRIVERS}};
+
+    # Turn on polling by default, people expect it.
+    $self->enable_ipc_polling;
+
+    unless (@{$self->{+IPC_DRIVERS}}) {
+        my ($ok, $error) = try { require Test2::IPC::Driver::Files };
+        die $error unless $ok;
+        push @{$self->{+IPC_DRIVERS}} => 'Test2::IPC::Driver::Files';
+    }
+
+    for my $driver (@{$self->{+IPC_DRIVERS}}) {
+        next unless $driver->can('is_viable') && $driver->is_viable;
+        $self->{+IPC} = $driver->new or next;
+        return;
+    }
+
+    die "IPC has been requested, but no viable drivers were found. Aborting...\n";
+}
+
+sub formatter_set { $_[0]->{+FORMATTER} ? 1 : 0 }
+
+sub add_formatter {
+    my $self = shift;
+    my ($formatter) = @_;
+    unshift @{$self->{+FORMATTERS}} => $formatter;
+
+    return unless $self->{+FINALIZED};
+
+    # Why is the @CARP_NOT entry not enough?
+    local %Carp::Internal = %Carp::Internal;
+    $Carp::Internal{'Test2::Formatter'} = 1;
+
+    carp "Formatter $formatter loaded too late to be used as the global formatter";
+}
+
+sub add_context_acquire_callback {
+    my $self =  shift;
+    my ($code) = @_;
+
+    my $rtype = reftype($code) || "";
+
+    confess "Context-acquire callbacks must be coderefs"
+        unless $code && $rtype eq 'CODE';
+
+    push @{$self->{+CONTEXT_ACQUIRE_CALLBACKS}} => $code;
+}
+
+sub add_context_init_callback {
+    my $self =  shift;
+    my ($code) = @_;
+
+    my $rtype = reftype($code) || "";
+
+    confess "Context-init callbacks must be coderefs"
+        unless $code && $rtype eq 'CODE';
+
+    push @{$self->{+CONTEXT_INIT_CALLBACKS}} => $code;
+}
+
+sub add_context_release_callback {
+    my $self =  shift;
+    my ($code) = @_;
+
+    my $rtype = reftype($code) || "";
+
+    confess "Context-release callbacks must be coderefs"
+        unless $code && $rtype eq 'CODE';
+
+    push @{$self->{+CONTEXT_RELEASE_CALLBACKS}} => $code;
+}
+
+sub add_post_load_callback {
+    my $self = shift;
+    my ($code) = @_;
+
+    my $rtype = reftype($code) || "";
+
+    confess "Post-load callbacks must be coderefs"
+        unless $code && $rtype eq 'CODE';
+
+    push @{$self->{+POST_LOAD_CALLBACKS}} => $code;
+    $code->() if $self->{+LOADED};
+}
+
+sub add_pre_subtest_callback {
+    my $self =  shift;
+    my ($code) = @_;
+
+    my $rtype = reftype($code) || "";
+
+    confess "Pre-subtest callbacks must be coderefs"
+        unless $code && $rtype eq 'CODE';
+
+    push @{$self->{+PRE_SUBTEST_CALLBACKS}} => $code;
+}
+
+sub load {
+    my $self = shift;
+    unless ($self->{+LOADED}) {
+        confess "Attempt to initialize Test2::API during preload"
+            if $self->{+PRELOAD};
+
+        $self->{+_PID} = $$        unless defined $self->{+_PID};
+        $self->{+_TID} = get_tid() unless defined $self->{+_TID};
+
+        # This is for https://github.com/Test-More/test-more/issues/16
+        # and https://rt.perl.org/Public/Bug/Display.html?id=127774
+        # END blocks run in reverse order. This insures the END block is loaded
+        # as late as possible. It will not solve all cases, but it helps.
+        eval "END { Test2::API::test2_set_is_end() }; 1" or die $@;
+
+        $self->{+LOADED} = 1;
+        $_->() for @{$self->{+POST_LOAD_CALLBACKS}};
+    }
+    return $self->{+LOADED};
+}
+
+sub add_exit_callback {
+    my $self = shift;
+    my ($code) = @_;
+    my $rtype = reftype($code) || "";
+
+    confess "End callbacks must be coderefs"
+        unless $code && $rtype eq 'CODE';
+
+    push @{$self->{+EXIT_CALLBACKS}} => $code;
+}
+
+sub ipc_disable {
+    my $self = shift;
+
+    confess "Attempt to disable IPC after it has been initialized"
+        if $self->{+IPC};
+
+    $self->{+IPC_DISABLED} = 1;
+}
+
+sub add_ipc_driver {
+    my $self = shift;
+    my ($driver) = @_;
+    unshift @{$self->{+IPC_DRIVERS}} => $driver;
+
+    return unless $self->{+FINALIZED};
+
+    # Why is the @CARP_NOT entry not enough?
+    local %Carp::Internal = %Carp::Internal;
+    $Carp::Internal{'Test2::IPC::Driver'} = 1;
+
+    carp "IPC driver $driver loaded too late to be used as the global ipc driver";
+}
+
+sub enable_ipc_polling {
+    my $self = shift;
+
+    $self->{+_PID} = $$        unless defined $self->{+_PID};
+    $self->{+_TID} = get_tid() unless defined $self->{+_TID};
+
+    $self->add_context_init_callback(
+        # This is called every time a context is created, it needs to be fast.
+        # $_[0] is a context object
+        sub {
+            return unless $self->{+IPC_POLLING};
+            return unless $self->{+IPC};
+            return unless $self->{+IPC}->pending();
+            return $_[0]->{hub}->cull;
+        }
+    ) unless defined $self->ipc_polling;
+
+    $self->set_ipc_polling(1);
+}
+
+sub get_ipc_pending {
+    my $self = shift;
+    return -1 unless $self->{+IPC};
+    $self->{+IPC}->pending();
+}
+
+sub _check_pid {
+    my $self = shift;
+    my ($pid) = @_;
+    return kill(0, $pid);
+}
+
+sub set_ipc_pending {
+    my $self = shift;
+    return unless $self->{+IPC};
+    my ($val) = @_;
+
+    confess "value is required for set_ipc_pending"
+        unless $val;
+
+    $self->{+IPC}->set_pending($val);
+}
+
+sub disable_ipc_polling {
+    my $self = shift;
+    return unless defined $self->{+IPC_POLLING};
+    $self->{+IPC_POLLING} = 0;
+}
+
+sub _ipc_wait {
+    my ($timeout) = @_;
+    my $fail = 0;
+
+    $timeout = DEFAULT_IPC_TIMEOUT() unless defined $timeout;
+
+    my $ok = eval {
+        if (CAN_FORK) {
+            local $SIG{ALRM} = sub { die "Timeout waiting on child processes" };
+            alarm $timeout;
+
+            while (1) {
+                my $pid = CORE::wait();
+                my $err = $?;
+                last if $pid == -1;
+                next unless $err;
+                $fail++;
+
+                my $sig = $err & 127;
+                my $exit = $err >> 8;
+                warn "Process $pid did not exit cleanly (wstat: $err, exit: $exit, sig: $sig)\n";
+            }
+
+            alarm 0;
+        }
+
+        if (USE_THREADS) {
+            my $start = time;
+
+            while (1) {
+                last unless threads->list();
+                die "Timeout waiting on child thread" if time - $start >= $timeout;
+                sleep 1;
+                for my $t (threads->list) {
+                    # threads older than 1.34 do not have this :-(
+                    next if $t->can('is_joinable') && !$t->is_joinable;
+                    $t->join;
+                    # In older threads we cannot check if a thread had an error unless
+                    # we control it and its return.
+                    my $err = $t->can('error') ? $t->error : undef;
+                    next unless $err;
+                    my $tid = $t->tid();
+                    $fail++;
+                    chomp($err);
+                    warn "Thread $tid did not end cleanly: $err\n";
+                }
+            }
+        }
+
+        1;
+    };
+    my $error = $@;
+
+    return 0 if $ok && !$fail;
+    warn $error unless $ok;
+    return 255;
+}
+
+sub set_exit {
+    my $self = shift;
+
+    return if $self->{+PRELOAD};
+
+    my $exit     = $?;
+    my $new_exit = $exit;
+
+    if ($INC{'Test/Builder.pm'} && $Test::Builder::VERSION ne $Test2::API::VERSION) {
+        print STDERR <<"        EOT";
+
+********************************************************************************
+*                                                                              *
+*            Test::Builder -- Test2::API version mismatch detected             *
+*                                                                              *
+********************************************************************************
+   Test2::API Version: $Test2::API::VERSION
+Test::Builder Version: $Test::Builder::VERSION
+
+This is not a supported configuration, you will have problems.
+
+        EOT
+    }
+
+    for my $ctx (values %{$self->{+CONTEXTS}}) {
+        next unless $ctx;
+
+        next if $ctx->_aborted && ${$ctx->_aborted};
+
+        # Only worry about contexts in this PID
+        my $trace = $ctx->trace || next;
+        next unless $trace->pid && $trace->pid == $$;
+
+        # Do not worry about contexts that have no hub
+        my $hub = $ctx->hub  || next;
+
+        # Do not worry if the state came to a sudden end.
+        next if $hub->bailed_out;
+        next if defined $hub->skip_reason;
+
+        # now we worry
+        $trace->alert("context object was never released! This means a testing tool is behaving very badly");
+
+        $exit     = 255;
+        $new_exit = 255;
+    }
+
+    if (!defined($self->{+_PID}) or !defined($self->{+_TID}) or $self->{+_PID} != $$ or $self->{+_TID} != get_tid()) {
+        $? = $exit;
+        return;
+    }
+
+    my @hubs = $self->{+STACK} ? $self->{+STACK}->all : ();
+
+    if (@hubs and $self->{+IPC} and !$self->{+NO_WAIT}) {
+        local $?;
+        my %seen;
+        for my $hub (reverse @hubs) {
+            my $ipc = $hub->ipc or next;
+            next if $seen{$ipc}++;
+            $ipc->waiting();
+        }
+
+        my $ipc_exit = _ipc_wait($self->{+IPC_TIMEOUT});
+        $new_exit ||= $ipc_exit;
+    }
+
+    # None of this is necessary if we never got a root hub
+    if(my $root = shift @hubs) {
+        my $trace = Test2::EventFacet::Trace->new(
+            frame  => [__PACKAGE__, __FILE__, 0, __PACKAGE__ . '::END'],
+            detail => __PACKAGE__ . ' END Block finalization',
+        );
+        my $ctx = Test2::API::Context->new(
+            trace => $trace,
+            hub   => $root,
+        );
+
+        if (@hubs) {
+            $ctx->diag("Test ended with extra hubs on the stack!");
+            $new_exit  = 255;
+        }
+
+        unless ($root->no_ending) {
+            local $?;
+            $root->finalize($trace) unless $root->ended;
+            $_->($ctx, $exit, \$new_exit) for @{$self->{+EXIT_CALLBACKS}};
+            $new_exit ||= $root->failed;
+            $new_exit ||= 255 unless $root->is_passing;
+        }
+    }
+
+    $new_exit = 255 if $new_exit > 255;
+
+    if ($new_exit && eval { require Test2::API::Breakage; 1 }) {
+        my @warn = Test2::API::Breakage->report();
+
+        if (@warn) {
+            print STDERR "\nYou have loaded versions of test modules known to have problems with Test2.\nThis could explain some test failures.\n";
+            print STDERR "$_\n" for @warn;
+            print STDERR "\n";
+        }
+    }
+
+    $? = $new_exit;
+}
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::API::Instance - Object used by Test2::API under the hood
+
+=head1 DESCRIPTION
+
+This object encapsulates the global shared state tracked by
+L<Test2>. A single global instance of this package is stored (and
+obscured) by the L<Test2::API> package.
+
+There is no reason to directly use this package. This package is documented for
+completeness. This package can change, or go away completely at any time.
+Directly using, or monkeypatching this package is not supported in any way
+shape or form.
+
+=head1 SYNOPSIS
+
+    use Test2::API::Instance;
+
+    my $obj = Test2::API::Instance->new;
+
+=over 4
+
+=item $pid = $obj->pid
+
+PID of this instance.
+
+=item $obj->tid
+
+Thread ID of this instance.
+
+=item $obj->reset()
+
+Reset the object to defaults.
+
+=item $obj->load()
+
+Set the internal state to loaded, and run and stored post-load callbacks.
+
+=item $bool = $obj->loaded
+
+Check if the state is set to loaded.
+
+=item $arrayref = $obj->post_load_callbacks
+
+Get the post-load callbacks.
+
+=item $obj->add_post_load_callback(sub { ... })
+
+Add a post-load callback. If C<load()> has already been called then the callback will
+be immediately executed. If C<load()> has not been called then the callback will be
+stored and executed later when C<load()> is called.
+
+=item $hashref = $obj->contexts()
+
+Get a hashref of all active contexts keyed by hub id.
+
+=item $arrayref = $obj->context_acquire_callbacks
+
+Get all context acquire callbacks.
+
+=item $arrayref = $obj->context_init_callbacks
+
+Get all context init callbacks.
+
+=item $arrayref = $obj->context_release_callbacks
+
+Get all context release callbacks.
+
+=item $arrayref = $obj->pre_subtest_callbacks
+
+Get all pre-subtest callbacks.
+
+=item $obj->add_context_init_callback(sub { ... })
+
+Add a context init callback. Subs are called every time a context is created. Subs
+get the newly created context as their only argument.
+
+=item $obj->add_context_release_callback(sub { ... })
+
+Add a context release callback. Subs are called every time a context is released. Subs
+get the released context as their only argument. These callbacks should not
+call release on the context.
+
+=item $obj->add_pre_subtest_callback(sub { ... })
+
+Add a pre-subtest callback. Subs are called every time a subtest is
+going to be run. Subs get the subtest name, coderef, and any
+arguments.
+
+=item $obj->set_exit()
+
+This is intended to be called in an C<END { ... }> block. This will look at
+test state and set $?. This will also call any end callbacks, and wait on child
+processes/threads.
+
+=item $obj->set_ipc_pending($val)
+
+Tell other processes and threads there is a pending event. C<$val> should be a
+unique value no other thread/process will generate.
+
+B<Note:> This will also make the current process see a pending event.
+
+=item $pending = $obj->get_ipc_pending()
+
+This returns -1 if it is not possible to know.
+
+This returns 0 if there are no pending events.
+
+This returns 1 if there are pending events.
+
+=item $timeout = $obj->ipc_timeout;
+
+=item $obj->set_ipc_timeout($timeout);
+
+How long to wait for child processes and threads before aborting.
+
+=item $drivers = $obj->ipc_drivers
+
+Get the list of IPC drivers.
+
+=item $obj->add_ipc_driver($DRIVER_CLASS)
+
+Add an IPC driver to the list. The most recently added IPC driver will become
+the global one during initialization. If a driver is added after initialization
+has occurred a warning will be generated:
+
+    "IPC driver $driver loaded too late to be used as the global ipc driver"
+
+=item $bool = $obj->ipc_polling
+
+Check if polling is enabled.
+
+=item $obj->enable_ipc_polling
+
+Turn on polling. This will cull events from other processes and threads every
+time a context is created.
+
+=item $obj->disable_ipc_polling
+
+Turn off IPC polling.
+
+=item $bool = $obj->no_wait
+
+=item $bool = $obj->set_no_wait($bool)
+
+Get/Set no_wait. This option is used to turn off process/thread waiting at exit.
+
+=item $arrayref = $obj->exit_callbacks
+
+Get the exit callbacks.
+
+=item $obj->add_exit_callback(sub { ... })
+
+Add an exit callback. This callback will be called by C<set_exit()>.
+
+=item $bool = $obj->finalized
+
+Check if the object is finalized. Finalization happens when either C<ipc()>,
+C<stack()>, or C<format()> are called on the object. Once finalization happens
+these fields are considered unchangeable (not enforced here, enforced by
+L<Test2>).
+
+=item $ipc = $obj->ipc
+
+Get the one true IPC instance.
+
+=item $obj->ipc_disable
+
+Turn IPC off
+
+=item $bool = $obj->ipc_disabled
+
+Check if IPC is disabled
+
+=item $stack = $obj->stack
+
+Get the one true hub stack.
+
+=item $formatter = $obj->formatter
+
+Get the global formatter. By default this is the C<'Test2::Formatter::TAP'>
+package. This could be any package that implements the C<write()> method. This
+can also be an instantiated object.
+
+=item $bool = $obj->formatter_set()
+
+Check if a formatter has been set.
+
+=item $obj->add_formatter($class)
+
+=item $obj->add_formatter($obj)
+
+Add a formatter. The most recently added formatter will become the global one
+during initialization. If a formatter is added after initialization has occurred
+a warning will be generated:
+
+    "Formatter $formatter loaded too late to be used as the global formatter"
+
+=item $obj->set_add_uuid_via(sub { ... })
+
+=item $sub = $obj->add_uuid_via()
+
+This allows you to provide a UUID generator. If provided UUIDs will be attached
+to all events, hubs, and contexts. This is useful for storing, tracking, and
+linking these objects.
+
+The sub you provide should always return a unique identifier. Most things will
+expect a proper UUID string, however nothing in Test2::API enforces this.
+
+The sub will receive exactly 1 argument, the type of thing being tagged
+'context', 'hub', or 'event'. In the future additional things may be tagged, in
+which case new strings will be passed in. These are purely informative, you can
+(and usually should) ignore them.
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/API/Stack.pm

@@ -0,0 +1,226 @@
+package Test2::API::Stack;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+
+use Test2::Hub();
+
+use Carp qw/confess/;
+
+sub new {
+    my $class = shift;
+    return bless [], $class;
+}
+
+sub new_hub {
+    my $self = shift;
+    my %params = @_;
+
+    my $class = delete $params{class} || 'Test2::Hub';
+
+    my $hub = $class->new(%params);
+
+    if (@$self) {
+        $hub->inherit($self->[-1], %params);
+    }
+    else {
+        require Test2::API;
+        $hub->format(Test2::API::test2_formatter()->new_root)
+            unless $hub->format || exists($params{formatter});
+
+        my $ipc = Test2::API::test2_ipc();
+        if ($ipc && !$hub->ipc && !exists($params{ipc})) {
+            $hub->set_ipc($ipc);
+            $ipc->add_hub($hub->hid);
+        }
+    }
+
+    push @$self => $hub;
+
+    $hub;
+}
+
+sub top {
+    my $self = shift;
+    return $self->new_hub unless @$self;
+    return $self->[-1];
+}
+
+sub peek {
+    my $self = shift;
+    return @$self ? $self->[-1] : undef;
+}
+
+sub cull {
+    my $self = shift;
+    $_->cull for reverse @$self;
+}
+
+sub all {
+    my $self = shift;
+    return @$self;
+}
+
+sub root {
+    my $self = shift;
+    return unless @$self;
+    return $self->[0];
+}
+
+sub clear {
+    my $self = shift;
+    @$self = ();
+}
+
+# Do these last without keywords in order to prevent them from getting used
+# when we want the real push/pop.
+
+{
+    no warnings 'once';
+
+    *push = sub {
+        my $self = shift;
+        my ($hub) = @_;
+        $hub->inherit($self->[-1]) if @$self;
+        push @$self => $hub;
+    };
+
+    *pop = sub {
+        my $self = shift;
+        my ($hub) = @_;
+        confess "No hubs on the stack"
+            unless @$self;
+        confess "You cannot pop the root hub"
+            if 1 == @$self;
+        confess "Hub stack mismatch, attempted to pop incorrect hub"
+            unless $self->[-1] == $hub;
+        pop @$self;
+    };
+}
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::API::Stack - Object to manage a stack of L<Test2::Hub>
+instances.
+
+=head1 ***INTERNALS NOTE***
+
+B<The internals of this package are subject to change at any time!> The public
+methods provided will not change in backwards incompatible ways, but the
+underlying implementation details might. B<Do not break encapsulation here!>
+
+=head1 DESCRIPTION
+
+This module is used to represent and manage a stack of L<Test2::Hub>
+objects. Hubs are usually in a stack so that you can push a new hub into place
+that can intercept and handle events differently than the primary hub.
+
+=head1 SYNOPSIS
+
+    my $stack = Test2::API::Stack->new;
+    my $hub = $stack->top;
+
+=head1 METHODS
+
+=over 4
+
+=item $stack = Test2::API::Stack->new()
+
+This will create a new empty stack instance. All arguments are ignored.
+
+=item $hub = $stack->new_hub()
+
+=item $hub = $stack->new_hub(%params)
+
+=item $hub = $stack->new_hub(%params, class => $class)
+
+This will generate a new hub and push it to the top of the stack. Optionally
+you can provide arguments that will be passed into the constructor for the
+L<Test2::Hub> object.
+
+If you specify the C<< 'class' => $class >> argument, the new hub will be an
+instance of the specified class.
+
+Unless your parameters specify C<'formatter'> or C<'ipc'> arguments, the
+formatter and IPC instance will be inherited from the current top hub. You can
+set the parameters to C<undef> to avoid having a formatter or IPC instance.
+
+If there is no top hub, and you do not ask to leave IPC and formatter undef,
+then a new formatter will be created, and the IPC instance from
+L<Test2::API> will be used.
+
+=item $hub = $stack->top()
+
+This will return the top hub from the stack. If there is no top hub yet this
+will create it.
+
+=item $hub = $stack->peek()
+
+This will return the top hub from the stack. If there is no top hub yet this
+will return undef.
+
+=item $stack->cull
+
+This will call C<< $hub->cull >> on all hubs in the stack.
+
+=item @hubs = $stack->all
+
+This will return all the hubs in the stack as a list.
+
+=item $stack->clear
+
+This will completely remove all hubs from the stack. Normally you do not want
+to do this, but there are a few valid reasons for it.
+
+=item $stack->push($hub)
+
+This will push the new hub onto the stack.
+
+=item $stack->pop($hub)
+
+This will pop a hub from the stack, if the hub at the top of the stack does not
+match the hub you expect (passed in as an argument) it will throw an exception.
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/Event.pm

@@ -0,0 +1,778 @@
+package Test2::Event;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+use Scalar::Util qw/blessed reftype/;
+use Carp qw/croak/;
+
+use Test2::Util::HashBase qw/trace -amnesty uuid -_eid -hubs/;
+use Test2::Util::ExternalMeta qw/meta get_meta set_meta delete_meta/;
+use Test2::Util qw/pkg_to_file gen_uid/;
+
+use Test2::EventFacet::About();
+use Test2::EventFacet::Amnesty();
+use Test2::EventFacet::Assert();
+use Test2::EventFacet::Control();
+use Test2::EventFacet::Error();
+use Test2::EventFacet::Info();
+use Test2::EventFacet::Meta();
+use Test2::EventFacet::Parent();
+use Test2::EventFacet::Plan();
+use Test2::EventFacet::Trace();
+use Test2::EventFacet::Hub();
+
+# Legacy tools will expect this to be loaded now
+require Test2::Util::Trace;
+
+my %LOADED_FACETS = (
+    'about'   => 'Test2::EventFacet::About',
+    'amnesty' => 'Test2::EventFacet::Amnesty',
+    'assert'  => 'Test2::EventFacet::Assert',
+    'control' => 'Test2::EventFacet::Control',
+    'errors'  => 'Test2::EventFacet::Error',
+    'info'    => 'Test2::EventFacet::Info',
+    'meta'    => 'Test2::EventFacet::Meta',
+    'parent'  => 'Test2::EventFacet::Parent',
+    'plan'    => 'Test2::EventFacet::Plan',
+    'trace'   => 'Test2::EventFacet::Trace',
+    'hubs'    => 'Test2::EventFacet::Hub',
+);
+
+sub FACET_TYPES { sort values %LOADED_FACETS }
+
+sub load_facet {
+    my $class = shift;
+    my ($facet) = @_;
+
+    return $LOADED_FACETS{$facet} if exists $LOADED_FACETS{$facet};
+
+    my @check = ($facet);
+    if ('s' eq substr($facet, -1, 1)) {
+        push @check => substr($facet, 0, -1);
+    }
+    else {
+        push @check => $facet . 's';
+    }
+
+    my $found;
+    for my $check (@check) {
+        my $mod  = "Test2::EventFacet::" . ucfirst($facet);
+        my $file = pkg_to_file($mod);
+        next unless eval { require $file; 1 };
+        $found = $mod;
+        last;
+    }
+
+    return undef unless $found;
+    $LOADED_FACETS{$facet} = $found;
+}
+
+sub causes_fail      { 0 }
+sub increments_count { 0 }
+sub diagnostics      { 0 }
+sub no_display       { 0 }
+sub subtest_id       { undef }
+
+sub callback { }
+
+sub terminate { () }
+sub global    { () }
+sub sets_plan { () }
+
+sub summary { ref($_[0]) }
+
+sub related {
+    my $self = shift;
+    my ($event) = @_;
+
+    my $tracea = $self->trace  or return undef;
+    my $traceb = $event->trace or return undef;
+
+    my $uuida = $tracea->uuid;
+    my $uuidb = $traceb->uuid;
+    if ($uuida && $uuidb) {
+        return 1 if $uuida eq $uuidb;
+        return 0;
+    }
+
+    my $siga = $tracea->signature or return undef;
+    my $sigb = $traceb->signature or return undef;
+
+    return 1 if $siga eq $sigb;
+    return 0;
+}
+
+sub add_hub {
+    my $self = shift;
+    unshift @{$self->{+HUBS}} => @_;
+}
+
+sub add_amnesty {
+    my $self = shift;
+
+    for my $am (@_) {
+        $am = {%$am} if ref($am) ne 'ARRAY';
+        $am = Test2::EventFacet::Amnesty->new($am);
+
+        push @{$self->{+AMNESTY}} => $am;
+    }
+}
+
+sub eid { $_[0]->{+_EID} ||= gen_uid() }
+
+sub common_facet_data {
+    my $self = shift;
+
+    my %out;
+
+    $out{about} = {package => ref($self) || undef};
+    if (my $uuid = $self->uuid) {
+        $out{about}->{uuid} = $uuid;
+    }
+
+    $out{about}->{eid} = $self->{+_EID} || $self->eid;
+
+    if (my $trace = $self->trace) {
+        $out{trace} = { %$trace };
+    }
+
+    if (my $hubs = $self->hubs) {
+        $out{hubs} = $hubs;
+    }
+
+    $out{amnesty} = [map {{ %{$_} }} @{$self->{+AMNESTY}}]
+        if $self->{+AMNESTY};
+
+    if (my $meta = $self->meta_facet_data) {
+        $out{meta} = $meta;
+    }
+
+    return \%out;
+}
+
+sub meta_facet_data {
+    my $self = shift;
+
+    my $key = Test2::Util::ExternalMeta::META_KEY();
+
+    my $hash = $self->{$key} or return undef;
+    return {%$hash};
+}
+
+sub facet_data {
+    my $self = shift;
+
+    my $out = $self->common_facet_data;
+
+    $out->{about}->{details}    = $self->summary    || undef;
+    $out->{about}->{no_display} = $self->no_display || undef;
+
+    # Might be undef, we want to preserve that
+    my $terminate = $self->terminate;
+    $out->{control} = {
+        global    => $self->global    || 0,
+        terminate => $terminate,
+        has_callback => $self->can('callback') == \&callback ? 0 : 1,
+    };
+
+    $out->{assert} = {
+        no_debug => 1,                     # Legacy behavior
+        pass     => $self->causes_fail ? 0 : 1,
+        details  => $self->summary,
+    } if $self->increments_count;
+
+    $out->{parent} = {hid => $self->subtest_id} if $self->subtest_id;
+
+    if (my @plan = $self->sets_plan) {
+        $out->{plan} = {};
+
+        $out->{plan}->{count}   = $plan[0] if defined $plan[0];
+        $out->{plan}->{details} = $plan[2] if defined $plan[2];
+
+        if ($plan[1]) {
+            $out->{plan}->{skip} = 1 if $plan[1] eq 'SKIP';
+            $out->{plan}->{none} = 1 if $plan[1] eq 'NO PLAN';
+        }
+
+        $out->{control}->{terminate} ||= 0 if $out->{plan}->{skip};
+    }
+
+    if ($self->causes_fail && !$out->{assert}) {
+        $out->{errors} = [
+            {
+                tag     => 'FAIL',
+                fail    => 1,
+                details => $self->summary,
+            }
+        ];
+    }
+
+    my %IGNORE = (trace => 1, about => 1, control => 1);
+    my $do_info = !grep { !$IGNORE{$_} } keys %$out;
+
+    if ($do_info && !$self->no_display && $self->diagnostics) {
+        $out->{info} = [
+            {
+                tag     => 'DIAG',
+                debug   => 1,
+                details => $self->summary,
+            }
+        ];
+    }
+
+    return $out;
+}
+
+sub facets {
+    my $self = shift;
+    my %out;
+
+    my $data = $self->facet_data;
+    my @errors = $self->validate_facet_data($data);
+    die join "\n" => @errors if @errors;
+
+    for my $facet (keys %$data) {
+        my $class = $self->load_facet($facet);
+        my $val = $data->{$facet};
+
+        unless($class) {
+            $out{$facet} = $val;
+            next;
+        }
+
+        my $is_list = reftype($val) eq 'ARRAY' ? 1 : 0;
+        if ($is_list) {
+            $out{$facet} = [map { $class->new($_) } @$val];
+        }
+        else {
+            $out{$facet} = $class->new($val);
+        }
+    }
+
+    return \%out;
+}
+
+sub validate_facet_data {
+    my $class_or_self = shift;
+    my ($f, %params);
+
+    $f = shift if @_ && (reftype($_[0]) || '') eq 'HASH';
+    %params = @_;
+
+    $f ||= $class_or_self->facet_data if blessed($class_or_self);
+    croak "No facet data" unless $f;
+
+    my @errors;
+
+    for my $k (sort keys %$f) {
+        my $fclass = $class_or_self->load_facet($k);
+
+        push @errors => "Could not find a facet class for facet '$k'"
+            if $params{require_facet_class} && !$fclass;
+
+        next unless $fclass;
+
+        my $v = $f->{$k};
+        next unless defined($v); # undef is always fine
+
+        my $is_list = $fclass->is_list();
+        my $got_list = reftype($v) eq 'ARRAY' ? 1 : 0;
+
+        push @errors => "Facet '$k' should be a list, but got a single item ($v)"
+            if $is_list && !$got_list;
+
+        push @errors => "Facet '$k' should not be a list, but got a a list ($v)"
+            if $got_list && !$is_list;
+    }
+
+    return @errors;
+}
+
+sub nested {
+    my $self = shift;
+
+    Carp::cluck("Use of Test2::Event->nested() is deprecated, use Test2::Event->trace->nested instead")
+        if $ENV{AUTHOR_TESTING};
+
+    if (my $hubs = $self->{+HUBS}) {
+        return $hubs->[0]->{nested} if @$hubs;
+    }
+
+    my $trace = $self->{+TRACE} or return undef;
+    return $trace->{nested};
+}
+
+sub in_subtest {
+    my $self = shift;
+
+    Carp::cluck("Use of Test2::Event->in_subtest() is deprecated, use Test2::Event->trace->hid instead")
+        if $ENV{AUTHOR_TESTING};
+
+    my $hubs = $self->{+HUBS};
+    if ($hubs && @$hubs) {
+        return undef unless $hubs->[0]->{nested};
+        return $hubs->[0]->{hid}
+    }
+
+    my $trace = $self->{+TRACE} or return undef;
+    return undef unless $trace->{nested};
+    return $trace->{hid};
+}
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::Event - Base class for events
+
+=head1 DESCRIPTION
+
+Base class for all event objects that get passed through
+L<Test2>.
+
+=head1 SYNOPSIS
+
+    package Test2::Event::MyEvent;
+    use strict;
+    use warnings;
+
+    # This will make our class an event subclass (required)
+    use base 'Test2::Event';
+
+    # Add some accessors (optional)
+    # You are not obligated to use HashBase, you can use any object tool you
+    # want, or roll your own accessors.
+    use Test2::Util::HashBase qw/foo bar baz/;
+
+    # Use this if you want the legacy API to be written for you, for this to
+    # work you will need to implement a facet_data() method.
+    use Test2::Util::Facets2Legacy;
+
+    # Chance to initialize some defaults
+    sub init {
+        my $self = shift;
+        # no other args in @_
+
+        $self->set_foo('xxx') unless defined $self->foo;
+
+        ...
+    }
+
+    # This is the new way for events to convey data to the Test2 system
+    sub facet_data {
+        my $self = shift;
+
+        # Get common facets such as 'about', 'trace' 'amnesty', and 'meta'
+        my $facet_data = $self->common_facet_data();
+
+        # Are you making an assertion?
+        $facet_data->{assert} = {pass => 1, details => 'my assertion'};
+        ...
+
+        return $facet_data;
+    }
+
+    1;
+
+=head1 METHODS
+
+=head2 GENERAL
+
+=over 4
+
+=item $trace = $e->trace
+
+Get a snapshot of the L<Test2::EventFacet::Trace> as it was when this event was
+generated
+
+=item $bool_or_undef = $e->related($e2)
+
+Check if 2 events are related. In this case related means their traces share a
+signature meaning they were created with the same context (or at the very least
+by contexts which share an id, which is the same thing unless someone is doing
+something very bad).
+
+This can be used to reliably link multiple events created by the same tool. For
+instance a failing test like C<ok(0, "fail"> will generate 2 events, one being
+a L<Test2::Event::Ok>, the other being a L<Test2::Event::Diag>, both of these
+events are related having been created under the same context and by the same
+initial tool (though multiple tools may have been nested under the initial
+one).
+
+This will return C<undef> if the relationship cannot be checked, which happens
+if either event has an incomplete or missing trace. This will return C<0> if
+the traces are complete, but do not match. C<1> will be returned if there is a
+match.
+
+=item $e->add_amnesty({tag => $TAG, details => $DETAILS});
+
+This can be used to add amnesty to this event. Amnesty only effects failing
+assertions in most cases, but some formatters may display them for passing
+assertions, or even non-assertions as well.
+
+Amnesty will prevent a failed assertion from causing the overall test to fail.
+In other words it marks a failure as expected and allowed.
+
+B<Note:> This is how 'TODO' is implemented under the hood. TODO is essentially
+amnesty with the 'TODO' tag. The details are the reason for the TODO.
+
+=item $uuid = $e->uuid
+
+If UUID tagging is enabled (See L<Test::API>) then any event that has made its
+way through a hub will be tagged with a UUID. A newly created event will not
+yet be tagged in most cases.
+
+=item $class = $e->load_facet($name)
+
+This method is used to load a facet by name (or key). It will attempt to load
+the facet class, if it succeeds it will return the class it loaded. If it fails
+it will return C<undef>. This caches the result at the class level so that
+future calls will be faster.
+
+The C<$name> variable should be the key used to access the facet in a facets
+hashref. For instance the assertion facet has the key 'assert', the information
+facet has the 'info' key, and the error facet has the key 'errors'. You may
+include or omit the 's' at the end of the name, the method is smart enough to
+try both the 's' and no-'s' forms, it will check what you provided first, and
+if that is not found it will add or strip the 's and try again.
+
+=item @classes = $e->FACET_TYPES()
+
+=item @classes = Test2::Event->FACET_TYPES()
+
+This returns a list of all facets that have been loaded using the
+C<load_facet()> method. This will not return any classes that have not been
+loaded, or have been loaded directly without a call to C<load_facet()>.
+
+B<Note:> The core facet types are automatically loaded and populated in this
+list.
+
+=back
+
+=head2 NEW API
+
+=over 4
+
+=item $hashref = $e->common_facet_data();
+
+This can be used by subclasses to generate a starting facet data hashref. This
+will populate the hashref with the trace, meta, amnesty, and about facets.
+These facets are nearly always produced the same way for all events.
+
+=item $hashref = $e->facet_data()
+
+If you do not override this then the default implementation will attempt to
+generate facets from the legacy API. This generation is limited only to what
+the legacy API can provide. It is recommended that you override this method and
+write out explicit facet data.
+
+=item $hashref = $e->facets()
+
+This takes the hashref from C<facet_data()> and blesses each facet into the
+proper C<Test2::EventFacet::*> subclass. If no class can be found for any given
+facet it will be passed along unchanged.
+
+=item @errors = $e->validate_facet_data();
+
+=item @errors = $e->validate_facet_data(%params);
+
+=item @errors = $e->validate_facet_data(\%facets, %params);
+
+=item @errors = Test2::Event->validate_facet_data(%params);
+
+=item @errors = Test2::Event->validate_facet_data(\%facets, %params);
+
+This method will validate facet data and return a list of errors. If no errors
+are found this will return an empty list.
+
+This can be called as an object method with no arguments, in which case the
+C<facet_data()> method will be called to get the facet data to be validated.
+
+When used as an object method the C<\%facet_data> argument may be omitted.
+
+When used as a class method the C<\%facet_data> argument is required.
+
+Remaining arguments will be slurped into a C<%params> hash.
+
+Currently only 1 parameter is defined:
+
+=over 4
+
+=item require_facet_class => $BOOL
+
+When set to true (default is false) this will reject any facets where a facet
+class cannot be found. Normally facets without classes are assumed to be custom
+and are ignored.
+
+=back
+
+=back
+
+=head3 WHAT ARE FACETS?
+
+Facets are how events convey their purpose to the Test2 internals and
+formatters. An event without facets will have no intentional effect on the
+overall test state, and will not be displayed at all by most formatters, except
+perhaps to say that an event of an unknown type was seen.
+
+Facets are produced by the C<facet_data()> subroutine, which you should
+nearly-always override. C<facet_data()> is expected to return a hashref where
+each key is the facet type, and the value is either a hashref with the data for
+that facet, or an array of hashrefs. Some facets must be defined as single
+hashrefs, some must be defined as an array of hashrefs, No facets allow both.
+
+C<facet_data()> B<MUST NOT> bless the data it returns, the main hashref, and
+nested facet hashrefs B<MUST> be bare, though items contained within each
+facet may be blessed. The data returned by this method B<should> also be copies
+of the internal data in order to prevent accidental state modification.
+
+C<facets()> takes the data from C<facet_data()> and blesses it into the
+C<Test2::EventFacet::*> packages. This is rarely used however, the EventFacet
+packages are primarily for convenience and documentation. The EventFacet
+classes are not used at all internally, instead the raw data is used.
+
+Here is a list of facet types by package. The packages are not used internally,
+but are where the documentation for each type is kept.
+
+B<Note:> Every single facet type has the C<'details'> field. This field is
+always intended for human consumption, and when provided, should explain the
+'why' for the facet. All other fields are facet specific.
+
+=over 4
+
+=item about => {...}
+
+L<Test2::EventFacet::About>
+
+This contains information about the event itself such as the event package
+name. The C<details> field for this facet is an overall summary of the event.
+
+=item assert => {...}
+
+L<Test2::EventFacet::Assert>
+
+This facet is used if an assertion was made. The C<details> field of this facet
+is the description of the assertion.
+
+=item control => {...}
+
+L<Test2::EventFacet::Control>
+
+This facet is used to tell the L<Test2::Event::Hub> about special actions the
+event causes. Things like halting all testing, terminating the current test,
+etc. In this facet the C<details> field explains why any special action was
+taken.
+
+B<Note:> This is how bail-out is implemented.
+
+=item meta => {...}
+
+L<Test2::EventFacet::Meta>
+
+The meta facet contains all the meta-data attached to the event. In this case
+the C<details> field has no special meaning, but may be present if something
+sets the 'details' meta-key on the event.
+
+=item parent => {...}
+
+L<Test2::EventFacet::Parent>
+
+This facet contains nested events and similar details for subtests. In this
+facet the C<details> field will typically be the name of the subtest.
+
+=item plan => {...}
+
+L<Test2::EventFacet::Plan>
+
+This facet tells the system that a plan has been set. The C<details> field of
+this is usually left empty, but when present explains why the plan is what it
+is, this is most useful if the plan is to skip-all.
+
+=item trace => {...}
+
+L<Test2::EventFacet::Trace>
+
+This facet contains information related to when and where the event was
+generated. This is how the test file and line number of a failure is known.
+This facet can also help you to tell if tests are related.
+
+In this facet the C<details> field overrides the "failed at test_file.t line
+42." message provided on assertion failure.
+
+=item amnesty => [{...}, ...]
+
+L<Test2::EventFacet::Amnesty>
+
+The amnesty facet is a list instead of a single item, this is important as
+amnesty can come from multiple places at once.
+
+For each instance of amnesty the C<details> field explains why amnesty was
+granted.
+
+B<Note:> Outside of formatters amnesty only acts to forgive a failing
+assertion.
+
+=item errors => [{...}, ...]
+
+L<Test2::EventFacet::Error>
+
+The errors facet is a list instead of a single item, any number of errors can
+be listed. In this facet C<details> describes the error, or may contain the raw
+error message itself (such as an exception). In perl exception may be blessed
+objects, as such the raw data for this facet may contain nested items which are
+blessed.
+
+Not all errors are considered fatal, there is a C<fail> field that must be set
+for an error to cause the test to fail.
+
+B<Note:> This facet is unique in that the field name is 'errors' while the
+package is 'Error'. This is because this is the only facet type that is both a
+list, and has a name where the plural is not the same as the singular. This may
+cause some confusion, but I feel it will be less confusing than the
+alternative.
+
+=item info => [{...}, ...]
+
+L<Test2::EventFacet::Info>
+
+The 'info' facet is a list instead of a single item, any quantity of extra
+information can be attached to an event. Some information may be critical
+diagnostics, others may be simply commentary in nature, this is determined by
+the C<debug> flag.
+
+For this facet the C<details> flag is the info itself. This info may be a
+string, or it may be a data structure to display. This is one of the few facet
+types that may contain blessed items.
+
+=back
+
+=head2 LEGACY API
+
+=over 4
+
+=item $bool = $e->causes_fail
+
+Returns true if this event should result in a test failure. In general this
+should be false.
+
+=item $bool = $e->increments_count
+
+Should be true if this event should result in a test count increment.
+
+=item $e->callback($hub)
+
+If your event needs to have extra effects on the L<Test2::Hub> you can override
+this method.
+
+This is called B<BEFORE> your event is passed to the formatter.
+
+=item $num = $e->nested
+
+If this event is nested inside of other events, this should be the depth of
+nesting. (This is mainly for subtests)
+
+=item $bool = $e->global
+
+Set this to true if your event is global, that is ALL threads and processes
+should see it no matter when or where it is generated. This is not a common
+thing to want, it is used by bail-out and skip_all to end testing.
+
+=item $code = $e->terminate
+
+This is called B<AFTER> your event has been passed to the formatter. This
+should normally return undef, only change this if your event should cause the
+test to exit immediately.
+
+If you want this event to cause the test to exit you should return the exit
+code here. Exit code of 0 means exit success, any other integer means exit with
+failure.
+
+This is used by L<Test2::Event::Plan> to exit 0 when the plan is
+'skip_all'. This is also used by L<Test2::Event:Bail> to force the test
+to exit with a failure.
+
+This is called after the event has been sent to the formatter in order to
+ensure the event is seen and understood.
+
+=item $msg = $e->summary
+
+This is intended to be a human readable summary of the event. This should
+ideally only be one line long, but you can use multiple lines if necessary. This
+is intended for human consumption. You do not need to make it easy for machines
+to understand.
+
+The default is to simply return the event package name.
+
+=item ($count, $directive, $reason) = $e->sets_plan()
+
+Check if this event sets the testing plan. It will return an empty list if it
+does not. If it does set the plan it will return a list of 1 to 3 items in
+order: Expected Test Count, Test Directive, Reason for directive.
+
+=item $bool = $e->diagnostics
+
+True if the event contains diagnostics info. This is useful because a
+non-verbose harness may choose to hide events that are not in this category.
+Some formatters may choose to send these to STDERR instead of STDOUT to ensure
+they are seen.
+
+=item $bool = $e->no_display
+
+False by default. This will return true on events that should not be displayed
+by formatters.
+
+=item $id = $e->in_subtest
+
+If the event is inside a subtest this should have the subtest ID.
+
+=item $id = $e->subtest_id
+
+If the event is a final subtest event, this should contain the subtest ID.
+
+=back
+
+=head1 THIRD PARTY META-DATA
+
+This object consumes L<Test2::Util::ExternalMeta> which provides a consistent
+way for you to attach meta-data to instances of this class. This is useful for
+tools, plugins, and other extensions.
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/Event/Bail.pm

@@ -0,0 +1,109 @@
+package Test2::Event::Bail;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+
+BEGIN { require Test2::Event; our @ISA = qw(Test2::Event) }
+use Test2::Util::HashBase qw{reason buffered};
+
+# Make sure the tests terminate
+sub terminate { 255 };
+
+sub global { 1 };
+
+sub causes_fail { 1 }
+
+sub summary {
+    my $self = shift;
+    return "Bail out!  " . $self->{+REASON}
+        if $self->{+REASON};
+
+    return "Bail out!";
+}
+
+sub diagnostics { 1 }
+
+sub facet_data {
+    my $self = shift;
+    my $out = $self->common_facet_data;
+
+    $out->{control} = {
+        global    => 1,
+        halt      => 1,
+        details   => $self->{+REASON},
+        terminate => 255,
+    };
+
+    return $out;
+}
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::Event::Bail - Bailout!
+
+=head1 DESCRIPTION
+
+The bailout event is generated when things go horribly wrong and you need to
+halt all testing in the current file.
+
+=head1 SYNOPSIS
+
+    use Test2::API qw/context/;
+    use Test2::Event::Bail;
+
+    my $ctx = context();
+    my $event = $ctx->bail('Stuff is broken');
+
+=head1 METHODS
+
+Inherits from L<Test2::Event>. Also defines:
+
+=over 4
+
+=item $reason = $e->reason
+
+The reason for the bailout.
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/Event/Diag.pm

@@ -0,0 +1,99 @@
+package Test2::Event::Diag;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+
+BEGIN { require Test2::Event; our @ISA = qw(Test2::Event) }
+use Test2::Util::HashBase qw/message/;
+
+sub init {
+    $_[0]->{+MESSAGE} = 'undef' unless defined $_[0]->{+MESSAGE};
+}
+
+sub summary { $_[0]->{+MESSAGE} }
+
+sub diagnostics { 1 }
+
+sub facet_data {
+    my $self = shift;
+
+    my $out = $self->common_facet_data;
+
+    $out->{info} = [
+        {
+            tag     => 'DIAG',
+            debug   => 1,
+            details => $self->{+MESSAGE},
+        }
+    ];
+
+    return $out;
+}
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::Event::Diag - Diag event type
+
+=head1 DESCRIPTION
+
+Diagnostics messages, typically rendered to STDERR.
+
+=head1 SYNOPSIS
+
+    use Test2::API qw/context/;
+    use Test2::Event::Diag;
+
+    my $ctx = context();
+    my $event = $ctx->diag($message);
+
+=head1 ACCESSORS
+
+=over 4
+
+=item $diag->message
+
+The message for the diag.
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/Event/Encoding.pm

@@ -0,0 +1,97 @@
+package Test2::Event::Encoding;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+use Carp qw/croak/;
+
+BEGIN { require Test2::Event; our @ISA = qw(Test2::Event) }
+use Test2::Util::HashBase qw/encoding/;
+
+sub init {
+    my $self = shift;
+    defined $self->{+ENCODING} or croak "'encoding' is a required attribute";
+}
+
+sub summary { 'Encoding set to ' . $_[0]->{+ENCODING} }
+
+sub facet_data {
+    my $self = shift;
+    my $out = $self->common_facet_data;
+    $out->{control}->{encoding} = $self->{+ENCODING};
+    $out->{about}->{details} = $self->summary;
+    return $out;
+}
+
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::Event::Encoding - Set the encoding for the output stream
+
+=head1 DESCRIPTION
+
+The encoding event is generated when a test file wants to specify the encoding
+to be used when formatting its output. This event is intended to be produced
+by formatter classes and used for interpreting test names, message contents,
+etc.
+
+=head1 SYNOPSIS
+
+    use Test2::API qw/context/;
+    use Test2::Event::Encoding;
+
+    my $ctx = context();
+    my $event = $ctx->send_event('Encoding', encoding => 'UTF-8');
+
+=head1 METHODS
+
+Inherits from L<Test2::Event>. Also defines:
+
+=over 4
+
+=item $encoding = $e->encoding
+
+The encoding being specified.
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/Event/Exception.pm

@@ -0,0 +1,113 @@
+package Test2::Event::Exception;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+
+BEGIN { require Test2::Event; our @ISA = qw(Test2::Event) }
+use Test2::Util::HashBase qw{error};
+
+sub init {
+    my $self = shift;
+    $self->{+ERROR} = "$self->{+ERROR}";
+}
+
+sub causes_fail { 1 }
+
+sub summary {
+    my $self = shift;
+    chomp(my $msg = "Exception: " . $self->{+ERROR});
+    return $msg;
+}
+
+sub diagnostics { 1 }
+
+sub facet_data {
+    my $self = shift;
+    my $out = $self->common_facet_data;
+
+    $out->{errors} = [
+        {
+            tag     => 'ERROR',
+            fail    => 1,
+            details => $self->{+ERROR},
+        }
+    ];
+
+    return $out;
+}
+
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::Event::Exception - Exception event
+
+=head1 DESCRIPTION
+
+An exception event will display to STDERR, and will prevent the overall test
+file from passing.
+
+=head1 SYNOPSIS
+
+    use Test2::API qw/context/;
+    use Test2::Event::Exception;
+
+    my $ctx = context();
+    my $event = $ctx->send_event('Exception', error => 'Stuff is broken');
+
+=head1 METHODS
+
+Inherits from L<Test2::Event>. Also defines:
+
+=over 4
+
+=item $reason = $e->error
+
+The reason for the exception.
+
+=back
+
+=head1 CAVEATS
+
+Be aware that all exceptions are stringified during construction.
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/Event/Fail.pm

@@ -0,0 +1,118 @@
+package Test2::Event::Fail;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+use Test2::EventFacet::Info;
+
+BEGIN {
+    require Test2::Event;
+    our @ISA = qw(Test2::Event);
+    *META_KEY = \&Test2::Util::ExternalMeta::META_KEY;
+}
+
+use Test2::Util::HashBase qw{ -name -info };
+
+#############
+# Old API
+sub summary          { "fail" }
+sub increments_count { 1 }
+sub diagnostics      { 0 }
+sub no_display       { 0 }
+sub subtest_id       { undef }
+sub terminate        { () }
+sub global           { () }
+sub sets_plan        { () }
+
+sub causes_fail {
+    my $self = shift;
+    return 0 if $self->{+AMNESTY} && @{$self->{+AMNESTY}};
+    return 1;
+}
+
+#############
+# New API
+
+sub add_info {
+    my $self = shift;
+
+    for my $in (@_) {
+        $in = {%$in} if ref($in) ne 'ARRAY';
+        $in = Test2::EventFacet::Info->new($in);
+
+        push @{$self->{+INFO}} => $in;
+    }
+}
+
+sub facet_data {
+    my $self = shift;
+    my $out = $self->common_facet_data;
+
+    $out->{about}->{details} = 'fail';
+
+    $out->{assert} = {pass => 0, details => $self->{+NAME}};
+
+    $out->{info} = [map {{ %{$_} }} @{$self->{+INFO}}] if $self->{+INFO};
+
+    return $out;
+}
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::Event::Fail - Event for a simple failed assertion
+
+=head1 DESCRIPTION
+
+This is an optimal representation of a failed assertion.
+
+=head1 SYNOPSIS
+
+    use Test2::API qw/context/;
+
+    sub fail {
+        my ($name) = @_;
+        my $ctx = context();
+        $ctx->fail($name);
+        $ctx->release;
+    }
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/Event/Generic.pm

@@ -0,0 +1,280 @@
+package Test2::Event::Generic;
+use strict;
+use warnings;
+
+use Carp qw/croak/;
+use Scalar::Util qw/reftype/;
+
+our $VERSION = '1.302175';
+
+BEGIN { require Test2::Event; our @ISA = qw(Test2::Event) }
+use Test2::Util::HashBase;
+
+my @FIELDS = qw{
+    causes_fail increments_count diagnostics no_display callback terminate
+    global sets_plan summary facet_data
+};
+my %DEFAULTS = (
+    causes_fail      => 0,
+    increments_count => 0,
+    diagnostics      => 0,
+    no_display       => 0,
+);
+
+sub init {
+    my $self = shift;
+
+    for my $field (@FIELDS) {
+        my $val = defined $self->{$field} ? delete $self->{$field} : $DEFAULTS{$field};
+        next unless defined $val;
+
+        my $set = "set_$field";
+        $self->$set($val);
+    }
+}
+
+for my $field (@FIELDS) {
+    no strict 'refs';
+
+    *$field = sub { exists $_[0]->{$field} ? $_[0]->{$field} : () }
+        unless exists &{$field};
+
+    *{"set_$field"} = sub { $_[0]->{$field} = $_[1] }
+        unless exists &{"set_$field"};
+}
+
+sub can {
+    my $self = shift;
+    my ($name) = @_;
+    return $self->SUPER::can($name) unless $name eq 'callback';
+    return $self->{callback} || \&Test2::Event::callback;
+}
+
+sub facet_data {
+    my $self = shift;
+    return $self->{facet_data} || $self->SUPER::facet_data();
+}
+
+sub summary {
+    my $self = shift;
+    return $self->{summary} if defined $self->{summary};
+    $self->SUPER::summary();
+}
+
+sub sets_plan {
+    my $self = shift;
+    return unless $self->{sets_plan};
+    return @{$self->{sets_plan}};
+}
+
+sub callback {
+    my $self = shift;
+    my $cb = $self->{callback} || return;
+    $self->$cb(@_);
+}
+
+sub set_global {
+    my $self = shift;
+    my ($bool) = @_;
+
+    if(!defined $bool) {
+        delete $self->{global};
+        return undef;
+    }
+
+    $self->{global} = $bool;
+}
+
+sub set_callback {
+    my $self = shift;
+    my ($cb) = @_;
+
+    if(!defined $cb) {
+        delete $self->{callback};
+        return undef;
+    }
+
+    croak "callback must be a code reference"
+        unless ref($cb) && reftype($cb) eq 'CODE';
+
+    $self->{callback} = $cb;
+}
+
+sub set_terminate {
+    my $self = shift;
+    my ($exit) = @_;
+
+    if(!defined $exit) {
+        delete $self->{terminate};
+        return undef;
+    }
+
+    croak "terminate must be a positive integer"
+       unless $exit =~ m/^\d+$/;
+
+    $self->{terminate} = $exit;
+}
+
+sub set_sets_plan {
+    my $self = shift;
+    my ($plan) = @_;
+
+    if(!defined $plan) {
+        delete $self->{sets_plan};
+        return undef;
+    }
+
+    croak "'sets_plan' must be an array reference"
+        unless ref($plan) && reftype($plan) eq 'ARRAY';
+
+    $self->{sets_plan} = $plan;
+}
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::Event::Generic - Generic event type.
+
+=head1 DESCRIPTION
+
+This is a generic event that lets you customize all fields in the event API.
+This is useful if you have need for a custom event that does not make sense as
+a published reusable event subclass.
+
+=head1 SYNOPSIS
+
+    use Test2::API qw/context/;
+
+    sub send_custom_fail {
+        my $ctx = shift;
+
+        $ctx->send_event('Generic', causes_fail => 1, summary => 'The sky is falling');
+
+        $ctx->release;
+    }
+
+    send_custom_fail();
+
+=head1 METHODS
+
+=over 4
+
+=item $e->facet_data($data)
+
+=item $data = $e->facet_data
+
+Get or set the facet data (see L<Test2::Event>). If no facet_data is set then
+C<< Test2::Event->facet_data >> will be called to produce facets from the other
+data.
+
+=item $e->callback($hub)
+
+Call the custom callback if one is set, otherwise this does nothing.
+
+=item $e->set_callback(sub { ... })
+
+Set the custom callback. The custom callback must be a coderef. The first
+argument to your callback will be the event itself, the second will be the
+L<Test2::Event::Hub> that is using the callback.
+
+=item $bool = $e->causes_fail
+
+=item $e->set_causes_fail($bool)
+
+Get/Set the C<causes_fail> attribute. This defaults to C<0>.
+
+=item $bool = $e->diagnostics
+
+=item $e->set_diagnostics($bool)
+
+Get/Set the C<diagnostics> attribute. This defaults to C<0>.
+
+=item $bool_or_undef = $e->global
+
+=item @bool_or_empty = $e->global
+
+=item $e->set_global($bool_or_undef)
+
+Get/Set the C<diagnostics> attribute. This defaults to an empty list which is
+undef in scalar context.
+
+=item $bool = $e->increments_count
+
+=item $e->set_increments_count($bool)
+
+Get/Set the C<increments_count> attribute. This defaults to C<0>.
+
+=item $bool = $e->no_display
+
+=item $e->set_no_display($bool)
+
+Get/Set the C<no_display> attribute. This defaults to C<0>.
+
+=item @plan = $e->sets_plan
+
+Get the plan if this event sets one. The plan is a list of up to 3 items:
+C<($count, $directive, $reason)>. C<$count> must be defined, the others may be
+undef, or may not exist at all.
+
+=item $e->set_sets_plan(\@plan)
+
+Set the plan. You must pass in an arrayref with up to 3 elements.
+
+=item $summary = $e->summary
+
+=item $e->set_summary($summary_or_undef)
+
+Get/Set the summary. This will default to the event package
+C<'Test2::Event::Generic'>. You can set it to any value. Setting this to
+C<undef> will reset it to the default.
+
+=item $int_or_undef = $e->terminate
+
+=item @int_or_empty = $e->terminate
+
+=item $e->set_terminate($int_or_undef)
+
+This will get/set the C<terminate> attribute. This defaults to undef in scalar
+context, or an empty list in list context. Setting this to undef will clear it
+completely. This must be set to a positive integer (0 or larger).
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/Event/Note.pm

@@ -0,0 +1,97 @@
+package Test2::Event::Note;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+
+BEGIN { require Test2::Event; our @ISA = qw(Test2::Event) }
+use Test2::Util::HashBase qw/message/;
+
+sub init {
+    $_[0]->{+MESSAGE} = 'undef' unless defined $_[0]->{+MESSAGE};
+}
+
+sub summary { $_[0]->{+MESSAGE} }
+
+sub facet_data {
+    my $self = shift;
+
+    my $out = $self->common_facet_data;
+
+    $out->{info} = [
+        {
+            tag     => 'NOTE',
+            debug   => 0,
+            details => $self->{+MESSAGE},
+        }
+    ];
+
+    return $out;
+}
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::Event::Note - Note event type
+
+=head1 DESCRIPTION
+
+Notes, typically rendered to STDOUT.
+
+=head1 SYNOPSIS
+
+    use Test2::API qw/context/;
+    use Test2::Event::Note;
+
+    my $ctx = context();
+    my $event = $ctx->Note($message);
+
+=head1 ACCESSORS
+
+=over 4
+
+=item $note->message
+
+The message for the note.
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/Event/Ok.pm

@@ -0,0 +1,162 @@
+package Test2::Event::Ok;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+
+BEGIN { require Test2::Event; our @ISA = qw(Test2::Event) }
+use Test2::Util::HashBase qw{
+    pass effective_pass name todo
+};
+
+sub init {
+    my $self = shift;
+
+    # Do not store objects here, only true or false
+    $self->{+PASS} = $self->{+PASS} ? 1 : 0;
+    $self->{+EFFECTIVE_PASS} = $self->{+PASS} || (defined($self->{+TODO}) ? 1 : 0);
+}
+
+{
+    no warnings 'redefine';
+    sub set_todo {
+        my $self = shift;
+        my ($todo) = @_;
+        $self->{+TODO} = $todo;
+        $self->{+EFFECTIVE_PASS} = defined($todo) ? 1 : $self->{+PASS};
+    }
+}
+
+sub increments_count { 1 };
+
+sub causes_fail { !$_[0]->{+EFFECTIVE_PASS} }
+
+sub summary {
+    my $self = shift;
+
+    my $name = $self->{+NAME} || "Nameless Assertion";
+
+    my $todo = $self->{+TODO};
+    if ($todo) {
+        $name .= " (TODO: $todo)";
+    }
+    elsif (defined $todo) {
+        $name .= " (TODO)"
+    }
+
+    return $name;
+}
+
+sub extra_amnesty {
+    my $self = shift;
+    return unless defined($self->{+TODO}) || ($self->{+EFFECTIVE_PASS} && !$self->{+PASS});
+    return {
+        tag       => 'TODO',
+        details   => $self->{+TODO},
+    };
+}
+
+sub facet_data {
+    my $self = shift;
+
+    my $out = $self->common_facet_data;
+
+    $out->{assert}  = {
+        no_debug => 1,                # Legacy behavior
+        pass     => $self->{+PASS},
+        details  => $self->{+NAME},
+    };
+
+    if (my @exra_amnesty = $self->extra_amnesty) {
+        unshift @{$out->{amnesty}} => @exra_amnesty;
+    }
+
+    return $out;
+}
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::Event::Ok - Ok event type
+
+=head1 DESCRIPTION
+
+Ok events are generated whenever you run a test that produces a result.
+Examples are C<ok()>, and C<is()>.
+
+=head1 SYNOPSIS
+
+    use Test2::API qw/context/;
+    use Test2::Event::Ok;
+
+    my $ctx = context();
+    my $event = $ctx->ok($bool, $name, \@diag);
+
+or:
+
+    my $ctx   = context();
+    my $event = $ctx->send_event(
+        'Ok',
+        pass => $bool,
+        name => $name,
+    );
+
+=head1 ACCESSORS
+
+=over 4
+
+=item $rb = $e->pass
+
+The original true/false value of whatever was passed into the event (but
+reduced down to 1 or 0).
+
+=item $name = $e->name
+
+Name of the test.
+
+=item $b = $e->effective_pass
+
+This is the true/false value of the test after TODO and similar modifiers are
+taken into account.
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/Event/Pass.pm

@@ -0,0 +1,114 @@
+package Test2::Event::Pass;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+use Test2::EventFacet::Info;
+
+BEGIN {
+    require Test2::Event;
+    our @ISA = qw(Test2::Event);
+    *META_KEY = \&Test2::Util::ExternalMeta::META_KEY;
+}
+
+use Test2::Util::HashBase qw{ -name -info };
+
+##############
+# Old API
+sub summary          { "pass" }
+sub increments_count { 1 }
+sub causes_fail      { 0 }
+sub diagnostics      { 0 }
+sub no_display       { 0 }
+sub subtest_id       { undef }
+sub terminate        { () }
+sub global           { () }
+sub sets_plan        { () }
+
+##############
+# New API
+
+sub add_info {
+    my $self = shift;
+
+    for my $in (@_) {
+        $in = {%$in} if ref($in) ne 'ARRAY';
+        $in = Test2::EventFacet::Info->new($in);
+
+        push @{$self->{+INFO}} => $in;
+    }
+}
+
+sub facet_data {
+    my $self = shift;
+
+    my $out = $self->common_facet_data;
+
+    $out->{about}->{details} = 'pass';
+
+    $out->{assert} = {pass => 1, details => $self->{+NAME}};
+
+    $out->{info} = [map {{ %{$_} }} @{$self->{+INFO}}] if $self->{+INFO};
+
+    return $out;
+}
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::Event::Pass - Event for a simple passing assertion
+
+=head1 DESCRIPTION
+
+This is an optimal representation of a passing assertion.
+
+=head1 SYNOPSIS
+
+    use Test2::API qw/context/;
+
+    sub pass {
+        my ($name) = @_;
+        my $ctx = context();
+        $ctx->pass($name);
+        $ctx->release;
+    }
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/Event/Plan.pm

@@ -0,0 +1,169 @@
+package Test2::Event::Plan;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+
+BEGIN { require Test2::Event; our @ISA = qw(Test2::Event) }
+use Test2::Util::HashBase qw{max directive reason};
+
+use Carp qw/confess/;
+
+my %ALLOWED = (
+    'SKIP'    => 1,
+    'NO PLAN' => 1,
+);
+
+sub init {
+    if ($_[0]->{+DIRECTIVE}) {
+        $_[0]->{+DIRECTIVE} = 'SKIP'    if $_[0]->{+DIRECTIVE} eq 'skip_all';
+        $_[0]->{+DIRECTIVE} = 'NO PLAN' if $_[0]->{+DIRECTIVE} eq 'no_plan';
+
+        confess "'" . $_[0]->{+DIRECTIVE} . "' is not a valid plan directive"
+            unless $ALLOWED{$_[0]->{+DIRECTIVE}};
+    }
+    else {
+        confess "Cannot have a reason without a directive!"
+            if defined $_[0]->{+REASON};
+
+        confess "No number of tests specified"
+            unless defined $_[0]->{+MAX};
+
+        confess "Plan test count '" . $_[0]->{+MAX}  . "' does not appear to be a valid positive integer"
+            unless $_[0]->{+MAX} =~ m/^\d+$/;
+
+        $_[0]->{+DIRECTIVE} = '';
+    }
+}
+
+sub sets_plan {
+    my $self = shift;
+    return (
+        $self->{+MAX},
+        $self->{+DIRECTIVE},
+        $self->{+REASON},
+    );
+}
+
+sub terminate {
+    my $self = shift;
+    # On skip_all we want to terminate the hub
+    return 0 if $self->{+DIRECTIVE} && $self->{+DIRECTIVE} eq 'SKIP';
+    return undef;
+}
+
+sub summary {
+    my $self = shift;
+    my $max = $self->{+MAX};
+    my $directive = $self->{+DIRECTIVE};
+    my $reason = $self->{+REASON};
+
+    return "Plan is $max assertions"
+        if $max || !$directive;
+
+    return "Plan is '$directive', $reason"
+        if $reason;
+
+    return "Plan is '$directive'";
+}
+
+sub facet_data {
+    my $self = shift;
+
+    my $out = $self->common_facet_data;
+
+    $out->{control}->{terminate} = $self->{+DIRECTIVE} eq 'SKIP' ? 0 : undef
+        unless defined $out->{control}->{terminate};
+
+    $out->{plan} = {count => $self->{+MAX}};
+    $out->{plan}->{details} = $self->{+REASON} if defined $self->{+REASON};
+
+    if (my $dir = $self->{+DIRECTIVE}) {
+        $out->{plan}->{skip} = 1 if $dir eq 'SKIP';
+        $out->{plan}->{none} = 1 if $dir eq 'NO PLAN';
+    }
+
+    return $out;
+}
+
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::Event::Plan - The event of a plan
+
+=head1 DESCRIPTION
+
+Plan events are fired off whenever a plan is declared, done testing is called,
+or a subtext completes.
+
+=head1 SYNOPSIS
+
+    use Test2::API qw/context/;
+    use Test2::Event::Plan;
+
+    my $ctx = context();
+
+    # Plan for 10 tests to run
+    my $event = $ctx->plan(10);
+
+    # Plan to skip all tests (will exit 0)
+    $ctx->plan(0, skip_all => "These tests need to be skipped");
+
+=head1 ACCESSORS
+
+=over 4
+
+=item $num = $plan->max
+
+Get the number of expected tests
+
+=item $dir = $plan->directive
+
+Get the directive (such as TODO, skip_all, or no_plan).
+
+=item $reason = $plan->reason
+
+Get the reason for the directive.
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/Event/Skip.pm

@@ -0,0 +1,127 @@
+package Test2::Event::Skip;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+
+BEGIN { require Test2::Event::Ok; our @ISA = qw(Test2::Event::Ok) }
+use Test2::Util::HashBase qw{reason};
+
+sub init {
+    my $self = shift;
+    $self->SUPER::init;
+    $self->{+EFFECTIVE_PASS} = 1;
+}
+
+sub causes_fail { 0 }
+
+sub summary {
+    my $self = shift;
+    my $out = $self->SUPER::summary(@_);
+
+    if (my $reason = $self->reason) {
+        $out .= " (SKIP: $reason)";
+    }
+    else {
+        $out .= " (SKIP)";
+    }
+
+    return $out;
+}
+
+sub extra_amnesty {
+    my $self = shift;
+
+    my @out;
+
+    push @out => {
+        tag       => 'TODO',
+        details   => $self->{+TODO},
+    } if defined $self->{+TODO};
+
+    push @out => {
+        tag       => 'skip',
+        details   => $self->{+REASON},
+        inherited => 0,
+    };
+
+    return @out;
+}
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::Event::Skip - Skip event type
+
+=head1 DESCRIPTION
+
+Skip events bump test counts just like L<Test2::Event::Ok> events, but
+they can never fail.
+
+=head1 SYNOPSIS
+
+    use Test2::API qw/context/;
+    use Test2::Event::Skip;
+
+    my $ctx = context();
+    my $event = $ctx->skip($name, $reason);
+
+or:
+
+    my $ctx   = context();
+    my $event = $ctx->send_event(
+        'Skip',
+        name   => $name,
+        reason => $reason,
+    );
+
+=head1 ACCESSORS
+
+=over 4
+
+=item $reason = $e->reason
+
+The original true/false value of whatever was passed into the event (but
+reduced down to 1 or 0).
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://www.perl.com/perl/misc/Artistic.html>
+
+=cut

t/lib/Test2/Event/Subtest.pm

@@ -0,0 +1,160 @@
+package Test2::Event::Subtest;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+BEGIN { require Test2::Event::Ok; our @ISA = qw(Test2::Event::Ok) }
+use Test2::Util::HashBase qw{subevents buffered subtest_id subtest_uuid};
+
+sub init {
+    my $self = shift;
+    $self->SUPER::init();
+    $self->{+SUBEVENTS} ||= [];
+    if ($self->{+EFFECTIVE_PASS}) {
+        $_->set_effective_pass(1) for grep { $_->can('effective_pass') } @{$self->{+SUBEVENTS}};
+    }
+}
+
+{
+    no warnings 'redefine';
+
+    sub set_subevents {
+        my $self      = shift;
+        my @subevents = @_;
+
+        if ($self->{+EFFECTIVE_PASS}) {
+            $_->set_effective_pass(1) for grep { $_->can('effective_pass') } @subevents;
+        }
+
+        $self->{+SUBEVENTS} = \@subevents;
+    }
+
+    sub set_effective_pass {
+        my $self = shift;
+        my ($pass) = @_;
+
+        if ($pass) {
+            $_->set_effective_pass(1) for grep { $_->can('effective_pass') } @{$self->{+SUBEVENTS}};
+        }
+        elsif ($self->{+EFFECTIVE_PASS} && !$pass) {
+            for my $s (grep { $_->can('effective_pass') } @{$self->{+SUBEVENTS}}) {
+                $_->set_effective_pass(0) unless $s->can('todo') && defined $s->todo;
+            }
+        }
+
+        $self->{+EFFECTIVE_PASS} = $pass;
+    }
+}
+
+sub summary {
+    my $self = shift;
+
+    my $name = $self->{+NAME} || "Nameless Subtest";
+
+    my $todo = $self->{+TODO};
+    if ($todo) {
+        $name .= " (TODO: $todo)";
+    }
+    elsif (defined $todo) {
+        $name .= " (TODO)";
+    }
+
+    return $name;
+}
+
+sub facet_data {
+    my $self = shift;
+
+    my $out = $self->SUPER::facet_data();
+
+    $out->{parent} = {
+        hid      => $self->subtest_id,
+        children => [map {$_->facet_data} @{$self->{+SUBEVENTS}}],
+        buffered => $self->{+BUFFERED},
+    };
+
+    return $out;
+}
+
+sub add_amnesty {
+    my $self = shift;
+
+    for my $am (@_) {
+        $am = {%$am} if ref($am) ne 'ARRAY';
+        $am = Test2::EventFacet::Amnesty->new($am);
+
+        push @{$self->{+AMNESTY}} => $am;
+
+        for my $e (@{$self->{+SUBEVENTS}}) {
+            $e->add_amnesty($am->clone(inherited => 1));
+        }
+    }
+}
+
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::Event::Subtest - Event for subtest types
+
+=head1 DESCRIPTION
+
+This class represents a subtest. This class is a subclass of
+L<Test2::Event::Ok>.
+
+=head1 ACCESSORS
+
+This class inherits from L<Test2::Event::Ok>.
+
+=over 4
+
+=item $arrayref = $e->subevents
+
+Returns the arrayref containing all the events from the subtest
+
+=item $bool = $e->buffered
+
+True if the subtest is buffered, that is all subevents render at once. If this
+is false it means all subevents render as they are produced.
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/Event/TAP/Version.pm

@@ -0,0 +1,101 @@
+package Test2::Event::TAP::Version;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+use Carp qw/croak/;
+
+BEGIN { require Test2::Event; our @ISA = qw(Test2::Event) }
+use Test2::Util::HashBase qw/version/;
+
+sub init {
+    my $self = shift;
+    defined $self->{+VERSION} or croak "'version' is a required attribute";
+}
+
+sub summary { 'TAP version ' . $_[0]->{+VERSION} }
+
+sub facet_data {
+    my $self = shift;
+
+    my $out = $self->common_facet_data;
+
+    $out->{about}->{details} = $self->summary;
+
+    push @{$out->{info}} => {
+        tag     => 'INFO',
+        debug   => 0,
+        details => $self->summary,
+    };
+
+    return $out;
+}
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::Event::TAP::Version - Event for TAP version.
+
+=head1 DESCRIPTION
+
+This event is used if a TAP formatter wishes to set a version.
+
+=head1 SYNOPSIS
+
+    use Test2::API qw/context/;
+    use Test2::Event::Encoding;
+
+    my $ctx = context();
+    my $event = $ctx->send_event('TAP::Version', version => 42);
+
+=head1 METHODS
+
+Inherits from L<Test2::Event>. Also defines:
+
+=over 4
+
+=item $version = $e->version
+
+The TAP version being parsed.
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/Event/V2.pm

@@ -0,0 +1,238 @@
+package Test2::Event::V2;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+use Scalar::Util qw/reftype/;
+use Carp qw/croak/;
+
+BEGIN { require Test2::Event; our @ISA = qw(Test2::Event) }
+
+use Test2::Util::Facets2Legacy qw{
+    causes_fail diagnostics global increments_count no_display sets_plan
+    subtest_id summary terminate
+};
+
+use Test2::Util::HashBase qw/-about/;
+
+sub non_facet_keys {
+    return (
+        +UUID,
+        Test2::Util::ExternalMeta::META_KEY(),
+    );
+}
+
+sub init {
+    my $self = shift;
+
+    my $uuid;
+    if ($uuid = $self->{+UUID}) {
+        croak "uuid '$uuid' passed to constructor, but uuid '$self->{+ABOUT}->{uuid}' is already set in the 'about' facet"
+            if $self->{+ABOUT}->{uuid} && $self->{+ABOUT}->{uuid} ne $uuid;
+
+        $self->{+ABOUT}->{uuid} = $uuid;
+    }
+    elsif ($uuid = $self->{+ABOUT}->{uuid}) {
+        $self->SUPER::set_uuid($uuid);
+    }
+
+    # Clone the trace, make sure it is blessed
+    if (my $trace = $self->{+TRACE}) {
+        $self->{+TRACE} = Test2::EventFacet::Trace->new(%$trace);
+    }
+}
+
+sub set_uuid {
+    my $self = shift;
+    my ($uuid) = @_;
+    $self->{+ABOUT}->{uuid} = $uuid;
+    $self->SUPER::set_uuid($uuid);
+}
+
+sub facet_data {
+    my $self = shift;
+    my $f = { %{$self} };
+
+    delete $f->{$_} for $self->non_facet_keys;
+
+    my %out;
+    for my $k (keys %$f) {
+        next if substr($k, 0, 1) eq '_';
+
+        my $data = $f->{$k} or next; # Key is there, but no facet
+        my $is_list = 'ARRAY' eq (reftype($data) || '');
+        $out{$k} = $is_list ? [ map { {%{$_}} } @$data ] : {%$data};
+    }
+
+    if (my $meta = $self->meta_facet_data) {
+        $out{meta} = {%$meta, %{$out{meta} || {}}};
+    }
+
+    return \%out;
+}
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::Event::V2 - Second generation event.
+
+=head1 DESCRIPTION
+
+This is the event type that should be used instead of L<Test2::Event> or its
+legacy subclasses.
+
+=head1 SYNOPSIS
+
+=head2 USING A CONTEXT
+
+    use Test2::API qw/context/;
+
+    sub my_tool {
+        my $ctx = context();
+
+        my $event = $ctx->send_ev2(info => [{tag => 'NOTE', details => "This is a note"}]);
+
+        $ctx->release;
+
+        return $event;
+    }
+
+=head2 USING THE CONSTRUCTOR
+
+    use Test2::Event::V2;
+
+    my $e = Test2::Event::V2->new(
+        trace => {frame => [$PKG, $FILE, $LINE, $SUBNAME]},
+        info  => [{tag => 'NOTE', details => "This is a note"}],
+    );
+
+=head1 METHODS
+
+This class inherits from L<Test2::Event>.
+
+=over 4
+
+=item $fd = $e->facet_data()
+
+This will return a hashref of facet data. Each facet hash will be a shallow
+copy of the original.
+
+=item $about = $e->about()
+
+This will return the 'about' facet hashref.
+
+B<NOTE:> This will return the internal hashref, not a copy.
+
+=item $trace = $e->trace()
+
+This will return the 'trace' facet, normally blessed (but this is not enforced
+when the trace is set using C<set_trace()>.
+
+B<NOTE:> This will return the internal trace, not a copy.
+
+=back
+
+=head2 MUTATION
+
+=over 4
+
+=item $e->add_amnesty({...})
+
+Inherited from L<Test2::Event>. This can be used to add 'amnesty' facets to an
+existing event. Each new item is added to the B<END> of the list.
+
+B<NOTE:> Items B<ARE> blessed when added.
+
+=item $e->add_hub({...})
+
+Inherited from L<Test2::Event>. This is used by hubs to stamp events as they
+pass through. New items are added to the B<START> of the list.
+
+B<NOTE:> Items B<ARE NOT> blessed when added.
+
+=item $e->set_uuid($UUID)
+
+Inherited from L<Test2::Event>, overridden to also vivify/mutate the 'about'
+facet.
+
+=item $e->set_trace($trace)
+
+Inherited from L<Test2::Event> which allows you to change the trace.
+
+B<Note:> This method does not bless/clone the trace for you. Many things will
+expect the trace to be blessed, so you should probably do that.
+
+=back
+
+=head2 LEGACY SUPPORT METHODS
+
+These are all imported from L<Test2::Util::Facets2Legacy>, see that module or
+L<Test2::Event> for documentation on what they do.
+
+=over 4
+
+=item causes_fail
+
+=item diagnostics
+
+=item global
+
+=item increments_count
+
+=item no_display
+
+=item sets_plan
+
+=item subtest_id
+
+=item summary
+
+=item terminate
+
+=back
+
+=head1 THIRD PARTY META-DATA
+
+This object consumes L<Test2::Util::ExternalMeta> which provides a consistent
+way for you to attach meta-data to instances of this class. This is useful for
+tools, plugins, and other extensions.
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/Event/Waiting.pm

@@ -0,0 +1,76 @@
+package Test2::Event::Waiting;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+
+BEGIN { require Test2::Event; our @ISA = qw(Test2::Event) }
+use Test2::Util::HashBase;
+
+sub global { 1 };
+
+sub summary { "IPC is waiting for children to finish..." }
+
+sub facet_data {
+    my $self = shift;
+
+    my $out = $self->common_facet_data;
+
+    push @{$out->{info}} => {
+        tag     => 'INFO',
+        debug   => 0,
+        details => $self->summary,
+    };
+
+    return $out;
+}
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::Event::Waiting - Tell all procs/threads it is time to be done
+
+=head1 DESCRIPTION
+
+This event has no data of its own. This event is sent out by the IPC system
+when the main process/thread is ready to end.
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/EventFacet.pm

@@ -0,0 +1,93 @@
+package Test2::EventFacet;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+use Test2::Util::HashBase qw/-details/;
+use Carp qw/croak/;
+
+my $SUBLEN = length(__PACKAGE__ . '::');
+sub facet_key {
+    my $key = ref($_[0]) || $_[0];
+    substr($key, 0, $SUBLEN, '');
+    return lc($key);
+}
+
+sub is_list { 0 }
+
+sub clone {
+    my $self = shift;
+    my $type = ref($self);
+    return bless {%$self, @_}, $type;
+}
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::EventFacet - Base class for all event facets.
+
+=head1 DESCRIPTION
+
+Base class for all event facets.
+
+=head1 METHODS
+
+=over 4
+
+=item $key = $facet_class->facet_key()
+
+This will return the key for the facet in the facet data hash.
+
+=item $bool = $facet_class->is_list()
+
+This will return true if the facet should be in a list instead of a single
+item.
+
+=item $clone = $facet->clone()
+
+=item $clone = $facet->clone(%replace)
+
+This will make a shallow clone of the facet. You may specify fields to override
+as arguments.
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/EventFacet/About.pm

@@ -0,0 +1,92 @@
+package Test2::EventFacet::About;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+BEGIN { require Test2::EventFacet; our @ISA = qw(Test2::EventFacet) }
+use Test2::Util::HashBase qw{ -package -no_display -uuid -eid };
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::EventFacet::About - Facet with event details.
+
+=head1 DESCRIPTION
+
+This facet has information about the event, such as event package.
+
+=head1 FIELDS
+
+=over 4
+
+=item $string = $about->{details}
+
+=item $string = $about->details()
+
+Summary about the event.
+
+=item $package = $about->{package}
+
+=item $package = $about->package()
+
+Event package name.
+
+=item $bool = $about->{no_display}
+
+=item $bool = $about->no_display()
+
+True if the event should be skipped by formatters.
+
+=item $uuid = $about->{uuid}
+
+=item $uuid = $about->uuid()
+
+Will be set to a uuid if uuid tagging was enabled.
+
+=item $uuid = $about->{eid}
+
+=item $uuid = $about->eid()
+
+A unique (for the test job) identifier for the event.
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/EventFacet/Amnesty.pm

@@ -0,0 +1,91 @@
+package Test2::EventFacet::Amnesty;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+sub is_list { 1 }
+
+BEGIN { require Test2::EventFacet; our @ISA = qw(Test2::EventFacet) }
+use Test2::Util::HashBase qw{ -tag -inherited };
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::EventFacet::Amnesty - Facet for assertion amnesty.
+
+=head1 DESCRIPTION
+
+This package represents what is expected in units of amnesty.
+
+=head1 NOTES
+
+This facet appears in a list instead of being a single item.
+
+=head1 FIELDS
+
+=over 4
+
+=item $string = $amnesty->{details}
+
+=item $string = $amnesty->details()
+
+Human readable explanation of why amnesty was granted.
+
+Example: I<Not implemented yet, will fix>
+
+=item $short_string = $amnesty->{tag}
+
+=item $short_string = $amnesty->tag()
+
+Short string (usually 10 characters or less, not enforced, but may be truncated
+by renderers) categorizing the amnesty.
+
+=item $bool = $amnesty->{inherited}
+
+=item $bool = $amnesty->inherited()
+
+This will be true if the amnesty was granted to a parent event and inherited by
+this event, which is a child, such as an assertion within a subtest that is
+marked todo.
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/EventFacet/Assert.pm

@@ -0,0 +1,93 @@
+package Test2::EventFacet::Assert;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+BEGIN { require Test2::EventFacet; our @ISA = qw(Test2::EventFacet) }
+use Test2::Util::HashBase qw{ -pass -no_debug -number };
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::EventFacet::Assert - Facet representing an assertion.
+
+=head1 DESCRIPTION
+
+The assertion facet is provided by any event representing an assertion that was
+made.
+
+=head1 FIELDS
+
+=over 4
+
+=item $string = $assert->{details}
+
+=item $string = $assert->details()
+
+Human readable description of the assertion.
+
+=item $bool = $assert->{pass}
+
+=item $bool = $assert->pass()
+
+True if the assertion passed.
+
+=item $bool = $assert->{no_debug}
+
+=item $bool = $assert->no_debug()
+
+Set this to true if you have provided custom diagnostics and do not want the
+defaults to be displayed.
+
+=item $int = $assert->{number}
+
+=item $int = $assert->number()
+
+(Optional) assertion number. This may be omitted or ignored. This is usually
+only useful when parsing/processing TAP.
+
+B<Note>: This is not set by the Test2 system, assertion number is not known
+until AFTER the assertion has been processed. This attribute is part of the
+spec only for harnesses.
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/EventFacet/Control.pm

@@ -0,0 +1,107 @@
+package Test2::EventFacet::Control;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+BEGIN { require Test2::EventFacet; our @ISA = qw(Test2::EventFacet) }
+use Test2::Util::HashBase qw{ -global -terminate -halt -has_callback -encoding -phase };
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::EventFacet::Control - Facet for hub actions and behaviors.
+
+=head1 DESCRIPTION
+
+This facet is used when the event needs to give instructions to the Test2
+internals.
+
+=head1 FIELDS
+
+=over 4
+
+=item $string = $control->{details}
+
+=item $string = $control->details()
+
+Human readable explanation for the special behavior.
+
+=item $bool = $control->{global}
+
+=item $bool = $control->global()
+
+True if the event is global in nature and should be seen by all hubs.
+
+=item $exit = $control->{terminate}
+
+=item $exit = $control->terminate()
+
+Defined if the test should immediately exit, the value is the exit code and may
+be C<0>.
+
+=item $bool = $control->{halt}
+
+=item $bool = $control->halt()
+
+True if all testing should be halted immediately.
+
+=item $bool = $control->{has_callback}
+
+=item $bool = $control->has_callback()
+
+True if the C<callback($hub)> method on the event should be called.
+
+=item $encoding = $control->{encoding}
+
+=item $encoding = $control->encoding()
+
+This can be used to change the encoding from this event onward.
+
+=item $phase = $control->{phase}
+
+=item $phase = $control->phase()
+
+Used to signal that a phase change has occurred. Currently only the perl END
+phase is signaled.
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/EventFacet/Error.pm

@@ -0,0 +1,93 @@
+package Test2::EventFacet::Error;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+sub facet_key { 'errors' }
+sub is_list { 1 }
+
+BEGIN { require Test2::EventFacet; our @ISA = qw(Test2::EventFacet) }
+use Test2::Util::HashBase qw{ -tag -fail };
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::EventFacet::Error - Facet for errors that need to be shown.
+
+=head1 DESCRIPTION
+
+This facet is used when an event needs to convey errors.
+
+=head1 NOTES
+
+This facet has the hash key C<'errors'>, and is a list of facets instead of a
+single item.
+
+=head1 FIELDS
+
+=over 4
+
+=item $string = $error->{details}
+
+=item $string = $error->details()
+
+Explanation of the error, or the error itself (such as an exception). In perl
+exceptions may be blessed objects, so this field may contain a blessed object.
+
+=item $short_string = $error->{tag}
+
+=item $short_string = $error->tag()
+
+Short tag to categorize the error. This is usually 10 characters or less,
+formatters may truncate longer tags.
+
+=item $bool = $error->{fail}
+
+=item $bool = $error->fail()
+
+Not all errors are fatal, some are displayed having already been handled. Set
+this to true if you want the error to cause the test to fail. Without this the
+error is simply a diagnostics message that has no effect on the overall
+pass/fail result.
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/EventFacet/Hub.pm

@@ -0,0 +1,109 @@
+package Test2::EventFacet::Hub;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+sub is_list { 1 }
+sub facet_key { 'hubs' }
+
+BEGIN { require Test2::EventFacet; our @ISA = qw(Test2::EventFacet) }
+use Test2::Util::HashBase qw{-pid -tid -hid -nested -buffered -uuid -ipc};
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::EventFacet::Hub - Facet for the hubs an event passes through.
+
+=head1 DESCRIPTION
+
+These are a record of the hubs an event passes through. Most recent hub is the
+first one in the list.
+
+=head1 FACET FIELDS
+
+=over 4
+
+=item $string = $trace->{details}
+
+=item $string = $trace->details()
+
+The hub class or subclass
+
+=item $int = $trace->{pid}
+
+=item $int = $trace->pid()
+
+PID of the hub this event was sent to.
+
+=item $int = $trace->{tid}
+
+=item $int = $trace->tid()
+
+The thread ID of the hub the event was sent to.
+
+=item $hid = $trace->{hid}
+
+=item $hid = $trace->hid()
+
+The ID of the hub that the event was send to.
+
+=item $huuid = $trace->{huuid}
+
+=item $huuid = $trace->huuid()
+
+The UUID of the hub that the event was sent to.
+
+=item $int = $trace->{nested}
+
+=item $int = $trace->nested()
+
+How deeply nested the hub was.
+
+=item $bool = $trace->{buffered}
+
+=item $bool = $trace->buffered()
+
+True if the event was buffered and not sent to the formatter independent of a
+parent (This should never be set when nested is C<0> or C<undef>).
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/EventFacet/Info.pm

@@ -0,0 +1,132 @@
+package Test2::EventFacet::Info;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+sub is_list { 1 }
+
+BEGIN { require Test2::EventFacet; our @ISA = qw(Test2::EventFacet) }
+use Test2::Util::HashBase qw{-tag -debug -important -table};
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::EventFacet::Info - Facet for information a developer might care about.
+
+=head1 DESCRIPTION
+
+This facet represents messages intended for humans that will help them either
+understand a result, or diagnose a failure.
+
+=head1 NOTES
+
+This facet appears in a list instead of being a single item.
+
+=head1 FIELDS
+
+=over 4
+
+=item $string_or_structure = $info->{details}
+
+=item $string_or_structure = $info->details()
+
+Human readable string or data structure, this is the information to display.
+Formatters are free to render the structures however they please. This may
+contain a blessed object.
+
+If the C<table> attribute (see below) is set then a renderer may choose to
+display the table instead of the details.
+
+=item $structure = $info->{table}
+
+=item $structure = $info->table()
+
+If the data the C<info> facet needs to convey can be represented as a table
+then the data may be placed in this attribute in a more raw form for better
+display. The data must also be represented in the C<details> attribute for
+renderers which do not support rendering tables directly.
+
+The table structure:
+
+    my %table = {
+        header => [ 'column 1 header', 'column 2 header', ... ], # Optional
+
+        rows => [
+            ['row 1 column 1', 'row 1, column 2', ... ],
+            ['row 2 column 1', 'row 2, column 2', ... ],
+            ...
+        ],
+
+        # Allow the renderer to hide empty columns when true, Optional
+        collapse => $BOOL,
+
+        # List by name or number columns that should never be collapsed
+        no_collapse => \@LIST,
+    }
+
+=item $short_string = $info->{tag}
+
+=item $short_string = $info->tag()
+
+Short tag to categorize the info. This is usually 10 characters or less,
+formatters may truncate longer tags.
+
+=item $bool = $info->{debug}
+
+=item $bool = $info->debug()
+
+Set this to true if the message is critical, or explains a failure. This is
+info that should be displayed by formatters even in less-verbose modes.
+
+When false the information is not considered critical and may not be rendered
+in less-verbose modes.
+
+=item $bool = $info->{important}
+
+=item $bool = $info->important
+
+This should be set for non debug messages that are still important enough to
+show when a formatter is in quiet mode. A formatter should send these to STDOUT
+not STDERR, but should show them even in non-verbose mode.
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/EventFacet/Info/Table.pm

@@ -0,0 +1,144 @@
+package Test2::EventFacet::Info::Table;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+use Carp qw/confess/;
+
+use Test2::Util::HashBase qw{-header -rows -collapse -no_collapse -as_string};
+
+sub init {
+    my $self = shift;
+
+    confess "Table may not be empty" unless ref($self->{+ROWS}) eq 'ARRAY' && @{$self->{+ROWS}};
+
+    $self->{+AS_STRING} ||= '<TABLE NOT DISPLAYED>';
+}
+
+sub as_hash { my $out = +{%{$_[0]}}; delete $out->{as_string}; $out }
+
+sub info_args {
+    my $self = shift;
+
+    my $hash = $self->as_hash;
+    my $desc = $self->as_string;
+
+    return (table => $hash, details => $desc);
+}
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::EventFacet::Info::Table - Intermediary representation of a table.
+
+=head1 DESCRIPTION
+
+Intermediary representation of a table for use in specialized
+L<Test::API::Context> methods which generate L<Test2::EventFacet::Info> facets.
+
+=head1 SYNOPSIS
+
+    use Test2::EventFacet::Info::Table;
+    use Test2::API qw/context/;
+
+    sub my_tool {
+        my $ctx = context();
+
+        ...
+
+        $ctx->fail(
+            $name,
+            "failure diag message",
+            Test2::EventFacet::Info::Table->new(
+                # Required
+                rows => [['a', 'b'], ['c', 'd'], ...],
+
+                # Strongly Recommended
+                as_string => "... string to print when table cannot be rendered ...",
+
+                # Optional
+                header => ['col1', 'col2'],
+                collapse => $bool,
+                no_collapse => ['col1', ...],
+            ),
+        );
+
+        ...
+
+        $ctx->release;
+    }
+
+    my_tool();
+
+=head1 ATTRIBUTES
+
+=over 4
+
+=item $header_aref = $t->header()
+
+=item $rows_aref = $t->rows()
+
+=item $bool = $t->collapse()
+
+=item $aref = $t->no_collapse()
+
+The above are all directly tied to the table hashref structure described in
+L<Test2::EventFacet::Info>.
+
+=item $str = $t->as_string()
+
+This returns the string form of the table if it was set, otherwise it returns
+the string C<< "<TABLE NOT DISPLAYED>" >>.
+
+=item $href = $t->as_hash()
+
+This returns the data structure used for tables by L<Test2::EventFacet::Info>.
+
+=item %args = $t->info_args()
+
+This returns the arguments that should be used to construct the proper
+L<Test2::EventFacet::Info> structure.
+
+    return (table => $t->as_hash(), details => $t->as_string());
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut

t/lib/Test2/EventFacet/Meta.pm

@@ -0,0 +1,104 @@
+package Test2::EventFacet::Meta;
+use strict;
+use warnings;
+
+our $VERSION = '1.302175';
+
+BEGIN { require Test2::EventFacet; our @ISA = qw(Test2::EventFacet) }
+use vars qw/$AUTOLOAD/;
+
+# replace set_details
+{
+    no warnings 'redefine';
+    sub set_details { $_[0]->{'set_details'} }
+}
+
+sub can {
+    my $self = shift;
+    my ($name) = @_;
+
+    my $existing = $self->SUPER::can($name);
+    return $existing if $existing;
+
+    # Only vivify when called on an instance, do not vivify for a class. There
+    # are a lot of magic class methods used in things like serialization (or
+    # the forks.pm module) which cause problems when vivified.
+    return undef unless ref($self);
+
+    my $sub = sub { $_[0]->{$name} };
+    {
+        no strict 'refs';
+        *$name = $sub;
+    }
+
+    return $sub;
+}
+
+sub AUTOLOAD {
+    my $name = $AUTOLOAD;
+    $name =~ s/^.*:://g;
+    my $sub = $_[0]->can($name);
+    goto &$sub;
+}
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::EventFacet::Meta - Facet for meta-data
+
+=head1 DESCRIPTION
+
+This facet can contain any random meta-data that has been attached to the
+event.
+
+=head1 METHODS AND FIELDS
+
+Any/all fields and accessors are autovivified into existence. There is no way
+to know what metadata may be added, so any is allowed.
+
+=over 4
+
+=item $anything = $meta->{anything}
+
+=item $anything = $meta->anything()
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2 can be found at
+F<http://github.com/Test-More/test-more/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut