[Edm] Experiments for reporting implementation and interop results

Tommy Pauly <tpauly@apple.com> Wed, 18 November 2020 05:40 UTC

Return-Path: <tpauly@apple.com>
X-Original-To: edm@ietfa.amsl.com
Delivered-To: edm@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 5D05A3A1463 for <edm@ietfa.amsl.com>; Tue, 17 Nov 2020 21:40:29 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.099
X-Spam-Level:
X-Spam-Status: No, score=-2.099 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, HTML_MESSAGE=0.001, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=apple.com
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id uhvw3kBrP1Zu for <edm@ietfa.amsl.com>; Tue, 17 Nov 2020 21:40:28 -0800 (PST)
Received: from ma1-aaemail-dr-lapp03.apple.com (ma1-aaemail-dr-lapp03.apple.com [17.171.2.72]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 007A73A145E for <edm@iab.org>; Tue, 17 Nov 2020 21:40:27 -0800 (PST)
Received: from pps.filterd (ma1-aaemail-dr-lapp03.apple.com [127.0.0.1]) by ma1-aaemail-dr-lapp03.apple.com (8.16.0.42/8.16.0.42) with SMTP id 0AI5dMxp035319 for <edm@iab.org>; Tue, 17 Nov 2020 21:40:26 -0800
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=apple.com; h=from : content-type : mime-version : subject : message-id : date : to; s=20180706; bh=G/VlY2oGjap47h3Bx2TT/MhUoQDuiUKJX3m/5CKVWVw=; b=oHacoQOUPnZbBcwbNCn72xPmJPpbWImHy2vzP6Lx+kaey3IwWA/z2XxcpiOWaPxLLSLZ HFzzZllhoDXeriIpBuWixIY68SLsPs71+e+Jd6mB69SxUrLmu9w+cz2GXBRk5fIAAoaa yrcIg+ilX8UBbykmOuRUWYjeegaHdZrdphJ0TpkxFUYpNN4U2YD5VhfDkeEzdFkcwAgH NfSZ1bnUo2QZb2Nsq17ovz1d7uDOwG7OnVuHemg8sPMdySwML/rlI0X+MRoo7pvxLwCi 0DUyMFJsJlm3Ban1E/TIwPlMaaxXsD3jLq8nR+z0qM5RVh+3xnRbX6UfFAPELrp5xxcl /Q==
Received: from rn-mailsvcp-mta-lapp01.rno.apple.com (rn-mailsvcp-mta-lapp01.rno.apple.com [10.225.203.149]) by ma1-aaemail-dr-lapp03.apple.com with ESMTP id 34tf413aft-14 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128 verify=NO) for <edm@iab.org>; Tue, 17 Nov 2020 21:40:26 -0800
Received: from rn-mailsvcp-mmp-lapp03.rno.apple.com (rn-mailsvcp-mmp-lapp03.rno.apple.com [17.179.253.16]) by rn-mailsvcp-mta-lapp01.rno.apple.com (Oracle Communications Messaging Server 8.1.0.6.20200729 64bit (built Jul 29 2020)) with ESMTPS id <0QJZ00BYV93EUOB0@rn-mailsvcp-mta-lapp01.rno.apple.com> for edm@iab.org; Tue, 17 Nov 2020 21:40:26 -0800 (PST)
Received: from process_milters-daemon.rn-mailsvcp-mmp-lapp03.rno.apple.com by rn-mailsvcp-mmp-lapp03.rno.apple.com (Oracle Communications Messaging Server 8.1.0.6.20200729 64bit (built Jul 29 2020)) id <0QJZ00Y007WVBZ00@rn-mailsvcp-mmp-lapp03.rno.apple.com> for edm@iab.org; Tue, 17 Nov 2020 21:40:26 -0800 (PST)
X-Va-A:
X-Va-T-CD: 1af8597529a643bc4f908cf463616f6c
X-Va-E-CD: 3fd80ed4547b2312c1e54a36e2b54126
X-Va-R-CD: b93bb405bb1f7f642c9807388b9dd4fa
X-Va-CD: 0
X-Va-ID: ea0c4cc3-c208-4a0c-9c93-71023c12e4c3
X-V-A:
X-V-T-CD: 1af8597529a643bc4f908cf463616f6c
X-V-E-CD: 3fd80ed4547b2312c1e54a36e2b54126
X-V-R-CD: b93bb405bb1f7f642c9807388b9dd4fa
X-V-CD: 0
X-V-ID: 4caf073b-3b4a-49b7-a705-c55eec37a589
X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.312, 18.0.737 definitions=2020-11-18_01:2020-11-17, 2020-11-18 signatures=0
Received: from localhost.localdomain (unknown [17.234.72.15]) by rn-mailsvcp-mmp-lapp03.rno.apple.com (Oracle Communications Messaging Server 8.1.0.6.20200729 64bit (built Jul 29 2020)) with ESMTPSA id <0QJZ00N05939TG00@rn-mailsvcp-mmp-lapp03.rno.apple.com> for edm@iab.org; Tue, 17 Nov 2020 21:40:24 -0800 (PST)
From: Tommy Pauly <tpauly@apple.com>
Content-type: multipart/alternative; boundary="Apple-Mail=_42743093-09CA-4B14-BFD2-87C2E845C997"
MIME-version: 1.0 (Mac OS X Mail 14.0 \(3654.0.3.2.26\))
Message-id: <A258610C-D63E-4867-BDB0-2111175E870D@apple.com>
Date: Tue, 17 Nov 2020 21:40:20 -0800
To: edm@iab.org
X-Mailer: Apple Mail (2.3654.0.3.2.26)
X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.312, 18.0.737 definitions=2020-11-18_01:2020-11-17, 2020-11-18 signatures=0
Archived-At: <https://mailarchive.ietf.org/arch/msg/edm/p-pQy9e1tWoKoxVhCeTyiM3bBmA>
Subject: [Edm] Experiments for reporting implementation and interop results
X-BeenThere: edm@iab.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "Evolvability, Deployability, & Maintainability \(Proposed\) Program" <edm.iab.org>
List-Unsubscribe: <https://www.iab.org/mailman/options/edm>, <mailto:edm-request@iab.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/edm/>
List-Post: <mailto:edm@iab.org>
List-Help: <mailto:edm-request@iab.org?subject=help>
List-Subscribe: <https://www.iab.org/mailman/listinfo/edm>, <mailto:edm-request@iab.org?subject=subscribe>
X-List-Received-Date: Wed, 18 Nov 2020 05:40:29 -0000

Hi EDM,

As I mentioned in the IABOPEN meeting, a few of us worked on some experiments during last week’s hackathon to report implementation and interop test results.

What we used was:
- A library for presenting a webpage of results that can show different requirements or tests per draft, and show results per implementation. This is based on Mark Nottingham’s HTTP cache tests site.
- Annotation for markdown (kramdown) drafts to add test requirements inline, with a script to generate a file that gets dropped into the webpage source

The goal is to make a generic template that can be added to draft repositories to easily generate and track tests for different versions of drafts, which will inform testing and WG evaluation.

Here’s an example of the library in a GitHub repo for a draft: https://github.com/tfpauly/quic-proxy/tree/main/interop <https://github.com/tfpauly/quic-proxy/tree/main/interop>
The results and tests folders are the parts that will change per document.

The drafts are currently annotated with tags like this:

	{::options req-id=“example-test-id" req-type="must" req=“Example description" /}

…where the types are “must”/“should”/“supported” (for indicating if a feature is supported), and the req-id is a tag for which each implementation reports a true/false result.

What do people think about this kind of approach? What would you like to see? How could such templates and tools help inform our protocol development?

Best,
Tommy