From commits-return-13230-apmail-beam-commits-archive=beam.apache.org@beam.incubator.apache.org Wed Nov 2 16:02:02 2016 Return-Path: X-Original-To: apmail-beam-commits-archive@minotaur.apache.org Delivered-To: apmail-beam-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 10D2619DF5 for ; Wed, 2 Nov 2016 16:02:02 +0000 (UTC) Received: (qmail 80219 invoked by uid 500); 2 Nov 2016 16:02:02 -0000 Delivered-To: apmail-beam-commits-archive@beam.apache.org Received: (qmail 80173 invoked by uid 500); 2 Nov 2016 16:02:02 -0000 Mailing-List: contact commits-help@beam.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@beam.incubator.apache.org Delivered-To: mailing list commits@beam.incubator.apache.org Received: (qmail 80163 invoked by uid 99); 2 Nov 2016 16:02:01 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd3-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 02 Nov 2016 16:02:01 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd3-us-west.apache.org (ASF Mail Server at spamd3-us-west.apache.org) with ESMTP id 91FA01804C7 for ; Wed, 2 Nov 2016 16:02:01 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd3-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -7.019 X-Spam-Level: X-Spam-Status: No, score=-7.019 tagged_above=-999 required=6.31 tests=[KAM_LAZY_DOMAIN_SECURITY=1, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, RP_MATCHES_RCVD=-2.999] autolearn=disabled Received: from mx1-lw-us.apache.org ([10.40.0.8]) by localhost (spamd3-us-west.apache.org [10.40.0.10]) (amavisd-new, port 10024) with ESMTP id 0EeSJA1nZG6I for ; Wed, 2 Nov 2016 16:02:00 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-lw-us.apache.org (ASF Mail Server at mx1-lw-us.apache.org) with SMTP id 761705FC41 for ; Wed, 2 Nov 2016 16:02:00 +0000 (UTC) Received: (qmail 78622 invoked by uid 99); 2 Nov 2016 16:02:00 -0000 Received: from arcas.apache.org (HELO arcas) (140.211.11.28) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 02 Nov 2016 16:02:00 +0000 Received: from arcas.apache.org (localhost [127.0.0.1]) by arcas (Postfix) with ESMTP id E00502C2AC0 for ; Wed, 2 Nov 2016 16:01:59 +0000 (UTC) Date: Wed, 2 Nov 2016 16:01:59 +0000 (UTC) From: "Kenneth Knowles (JIRA)" To: commits@beam.incubator.apache.org Message-ID: In-Reply-To: References: Subject: [jira] [Created] (BEAM-883) Make ApiSurfaceTest fail if something whitelisted is _not_ exposed MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 Kenneth Knowles created BEAM-883: ------------------------------------ Summary: Make ApiSurfaceTest fail if something whitelisted is _not_ exposed Key: BEAM-883 URL: https://issues.apache.org/jira/browse/BEAM-883 Project: Beam Issue Type: Improvement Components: testing Affects Versions: Not applicable Reporter: Kenneth Knowles Fix For: Not applicable {{ApiSurfaceTest}} in the {{sdks/java/core}} is the class responsible for protecting our public API surface. This test walks the public signatures of all modules and explicitly verifies that everything is on a whitelist. This is how we control what dependencies we expose to our users, so that Beam can keep a tight, stable API surface. We should improve this functionality to be reusable across modules. Some desiderata for reuse: * test automatically infers the module on which it should seed the API search. * only 2 things in the file -- a whitelist and a ~1-line test that passes the whitelist as a parameter to some helper. * test fails if there are things in the whitelist that are not exposed. Any other cool things that are similar to what Maven enforcer does? As an example of what you have to do without this functionality, see https://github.com/apache/incubator-beam/pull/1183 -- This message was sent by Atlassian JIRA (v6.3.4#6332)