GitHub Livecheck Fails on iperf3-devel Subport

[aque (Allan Que)]

The ​iperf3-devel subport currently has livecheck disabled as a workaround. When enabled, I get the following error:

Line
1	DEBUG: Starting logging for iperf3-devel
2	DEBUG: macOS 10.13 (darwin/17.5.0) arch i386
3	DEBUG: MacPorts 2.5.0
4	DEBUG: Xcode 9.4
5	DEBUG: SDK 10.13
6	DEBUG: MACOSX_DEPLOYMENT_TARGET: 10.13
7	DEBUG: Executing org.macports.main (iperf3-devel)
8	DEBUG: livecheck phase started at Sat Jun  2 10:41:36 CDT 2018
9	DEBUG: Executing org.macports.livecheck (iperf3-devel)
10	DEBUG: Port (livecheck) version is 3e58489a5823126fd1d51fcfb74994f9e8fe4e86
11	DEBUG: Fetching https://github.com/esnet/iperf/tags
12	DEBUG: The regex is "<id>tag:github.com,2008:Grit::Commit/([0-9a-f]{40})[0-9a-f]*</id>"
13	Error: cannot check if iperf3-devel was updated (regex didn't match)

I suspect the livecheck.url in github-1.0.tcl was previously set by the main (iperf3) port and not updated. I made the following change to confirm:

_resources/port1.0/group/github-1.0.tcl

@@ -107 +107 @@
         [regexp "^\[0-9a-f\]{7,}\$" ${github.version}] && \
         ![regexp "^\[0-9\]{8}\$" ${github.version}]} {
         livecheck.type      regexm
-        default livecheck.url   {${github.homepage}/commits/${github.livecheck.branch}.atom}
+        livecheck.url       ${github.homepage}/commits/${github.livecheck.branch}.atom
         livecheck.regex     <id>tag:github.com,2008:Grit::Commit/(\[0-9a-f\]{[string length ${github.version}]})\[0-9a-f\]*</id>
     } else {
         livecheck.type      regex

This fixed the issue in this case. I did not test with other ports to see if this change breaks their livechecks.

Line
1	DEBUG: Starting logging for iperf3-devel
2	DEBUG: macOS 10.13 (darwin/17.5.0) arch i386
3	DEBUG: MacPorts 2.5.0
4	DEBUG: Xcode 9.4
5	DEBUG: SDK 10.13
6	DEBUG: MACOSX_DEPLOYMENT_TARGET: 10.13
7	DEBUG: Executing org.macports.main (iperf3-devel)
8	DEBUG: livecheck phase started at Sat Jun  2 10:53:55 CDT 2018
9	DEBUG: Executing org.macports.livecheck (iperf3-devel)
10	DEBUG: Port (livecheck) version is 3e58489a5823126fd1d51fcfb74994f9e8fe4e86
11	DEBUG: Fetching https://github.com/esnet/iperf/commits/master.atom
12	DEBUG: The regex is "<id>tag:github.com,2008:Grit::Commit/([0-9a-f]{40})[0-9a-f]*</id>"
13	DEBUG: The regex matched "<id>tag:github.com,2008:Grit::Commit/7f883016bb77a39f11f6c62094c990a1dfef986e</id>", extracted "7f883016bb77a39f11f6c62094c990a1dfef986e"
14	iperf3-devel seems to have been updated (port version: 3e58489a5823126fd1d51fcfb74994f9e8fe4e86, new version: 7f883016bb77a39f11f6c62094c990a1dfef986e)

[ryandesign (Ryan Carsten Schmidt)]

I was actually trying to move the github portgroup toward using default for all livecheck.* options, not away from it.

I'd prefer restructuring the iperf3 port to accommodate this, as in ​https://github.com/macports/macports-ports/pull/1935.

[ryandesign (Ryan Carsten Schmidt)]

Replying to aque:

_resources/port1.0/group/github-1.0.tcl

@@ -107 +107 @@
         [regexp "^\[0-9a-f\]{7,}\$" ${github.version}] && \
         ![regexp "^\[0-9\]{8}\$" ${github.version}]} {
         livecheck.type      regexm
-        default livecheck.url   {${github.homepage}/commits/${github.livecheck.branch}.atom}
+        livecheck.url       ${github.homepage}/commits/${github.livecheck.branch}.atom
         livecheck.regex     <id>tag:github.com,2008:Grit::Commit/(\[0-9a-f\]{[string length ${github.version}]})\[0-9a-f\]*</id>
     } else {
         livecheck.type      regex

Your proposed change would break the ability of a port to override github.livecheck.branch, a feature introduced in [8c8cfbced424311973717d48f0193ad4e53820a3/macports-ports].

[aque (Allan Que)]

Thanks Ryan. I didn't know that restructuring the port that way would fix it; it reads the same to me. Also, the change I made wasn't a proposal to modify github-1.0.tcl. I just wanted to show the steps I took to troubleshoot.

[ryandesign (Ryan Carsten Schmidt)]

In b6e0c922ce6bad93b3eef8e363c27f198896606d/macports-ports (master):

iperf3: Enable livecheck for iperf3-devel

Restructure the port so that directives that only apply to the main port
are enclosed in an "if {${subport} eq ${name}}" block.

Closes: #56581

[ryandesign (Ryan Carsten Schmidt)]

Replying to aque:

I didn't know that restructuring the port that way would fix it; it reads the same to me.

Before my change, github.setup was invoked once if the subport was iperf3, and twice if the subport was iperf3-devel (the first invocation set some livecheck parameters appropriately for the main port, and the second one overrode some but not all of them (not the ones specified with default) for the devel subport). Now, github.setup is invoked only once regardless of the subport, and so the livecheck parameters are set correctly.

When I designed the github portgroup I didn't envision the situation where a developer would want to invoke github.setup differently in different subports. Some day I will try to make a new github 2.0 portgroup that avoids this and other mistakes I made in github 1.0.