build: enforce golden files and lint entry-point configuration (#18092)

* build: enforce golden files for configured entry points

* build: add linting to ensure entry-points are configured

Author: devversion

.circleci/config.yml

@@ -285,6 +285,12 @@ jobs:
             bazel build //:rollup_globals
             yarn check-rollup-globals $(bazel info bazel-bin)/rollup_globals.json
 
+      - run:
+          name: Checking entry-points configuration
+          command: |
+            bazel build //:entry_points_manifest
+            yarn check-entry-point-setup $(bazel info bazel-bin)/entry_points_manifest.json
+
       - run: ./scripts/circleci/lint-bazel-files.sh
       - run: yarn ownerslint
       - run: yarn stylelint

BUILD.bazel

@@ -1,6 +1,10 @@
 package(default_visibility = ["//visibility:public"])
 
 load("//:rollup-globals.bzl", "ROLLUP_GLOBALS")
+load("//src/cdk:config.bzl", "CDK_ENTRYPOINTS")
+load("//src/cdk-experimental:config.bzl", "CDK_EXPERIMENTAL_ENTRYPOINTS")
+load("//src/material:config.bzl", "MATERIAL_ENTRYPOINTS", "MATERIAL_TESTING_ENTRYPOINTS")
+load("//src/material-experimental:config.bzl", "MATERIAL_EXPERIMENTAL_ENTRYPOINTS", "MATERIAL_EXPERIMENTAL_TESTING_ENTRYPOINTS")
 
 exports_files([
     "LICENSE",
@@ -12,3 +16,14 @@ genrule(
     outs = ["rollup_globals.json"],
     cmd = "echo '%s' > $@" % ROLLUP_GLOBALS,
 )
+
+entryPoints = ["cdk/%s" % e for e in CDK_ENTRYPOINTS] + \
+              ["cdk-experimental/%s" % e for e in CDK_EXPERIMENTAL_ENTRYPOINTS] + \
+              ["material/%s" % e for e in MATERIAL_ENTRYPOINTS + MATERIAL_TESTING_ENTRYPOINTS] + \
+              ["material-experimental/%s" % e for e in MATERIAL_EXPERIMENTAL_ENTRYPOINTS + MATERIAL_EXPERIMENTAL_TESTING_ENTRYPOINTS]
+
+genrule(
+    name = "entry_points_manifest",
+    outs = ["entry_points_manifest.json"],
+    cmd = "echo '%s' > $@" % entryPoints,
+)

package.json

@@ -28,14 +28,15 @@
     "gulp": "gulp",
     "stage-release": "ts-node --project tools/release/ tools/release/stage-release.ts",
     "publish-release": "ts-node --project tools/release/ tools/release/publish-release.ts",
+    "check-entry-point-setup": "node ./scripts/check-entry-point-setup.js",
     "check-release-output": "ts-node --project tools/release tools/release/check-release-output.ts",
+    "check-rollup-globals": "ts-node --project scripts/ scripts/check-rollup-globals.ts",
     "changelog": "ts-node --project tools/release tools/release/changelog.ts",
     "preinstall": "node ./tools/npm/check-npm.js",
     "format:ts": "git-clang-format HEAD $(git diff HEAD --name-only | grep -v \"\\.d\\.ts\")",
     "format:bazel": "yarn -s bazel:buildifier --lint=fix --mode=fix",
     "format": "yarn -s format:ts && yarn -s format:bazel",
     "cherry-pick-patch": "ts-node --project tools/cherry-pick-patch/ tools/cherry-pick-patch/cherry-pick-patch.ts",
-    "check-rollup-globals": "ts-node --project scripts/ scripts/check-rollup-globals.ts",
     "ownerslint": "ts-node --project scripts/ scripts/ownerslint.ts",
     "tslint": "tslint -c tslint.json --project ./tsconfig.json",
     "stylelint": "stylelint \"src/**/*.+(css|scss)\" --config .stylelintrc.json --syntax scss"

scripts/check-entry-point-setup.js

@@ -0,0 +1,50 @@
+#!/usr/bin/env node
+
+/**
+ * Script that detects and validates entry-points. The script walks through all
+ * source files in the code base and ensures that determined entry-points are
+ * configured. The list of configured entry-points in Starlark is passed to the
+ * script through a manifest file (generated by Bazel)
+ */
+
+const {join, dirname} = require('path');
+const {sync: globSync} = require('glob');
+const minimatch = require('minimatch');
+const fs = require('fs');
+const chalk = require('chalk');
+
+const [entryPointManifest] = process.argv.slice(2);
+const entryPoints = JSON.parse(fs.readFileSync(entryPointManifest, 'utf8'));
+const packagesDir = join(__dirname, '../src');
+
+/**
+ * Globs that matches directories which should never be considered
+ * as entry-points.
+ */
+const excludeGlobs = [
+  'cdk/testing/private',
+  '*/schematics/**',
+];
+
+/** List of detected entry-points which are not properly configured. */
+const nonConfigured = [];
+
+// We require a minimum depth of two. This ensures that we only check entry-points and
+// do not check package names (like "cdk"). There is no validation for package names yet.
+globSync('*/*/**/public-api.ts', {cwd: packagesDir}).forEach(filePath => {
+  const entryPointName = dirname(filePath);
+
+  if (!excludeGlobs.some(pattern => minimatch(entryPointName, pattern)) &&
+      !entryPoints.includes(entryPointName)) {
+    nonConfigured.push(entryPointName);
+  }
+});
+
+if (nonConfigured.length) {
+  console.error(chalk.red('Found entry-points which are not configured. Add the following ' +
+      'entry-points to the package-specific "config.bzl" file:\n'));
+  nonConfigured.forEach(e => console.warn(chalk.yellow(`  - ${e}`)));
+  process.exit(1);
+} else {
+  console.log(chalk.green('All detected entry-points are configured properly.'));
+}

src/material-experimental/config.bzl

@@ -12,14 +12,17 @@ entryPoints = [
     "mdc-menu",
     "mdc-menu/testing",
     "mdc-progress-bar",
+    "mdc-progress-bar/testing",
     "mdc-radio",
     "mdc-select",
     "mdc-sidenav",
     "mdc-slide-toggle",
     "mdc-slide-toggle/testing",
     "mdc-slider",
-    "mdc-tabs",
+    "mdc-slider/testing",
+    "mdc-snackbar",
     "mdc-table",
+    "mdc-tabs",
     "popover-edit",
 ]
 

src/material-experimental/mdc-snackbar/BUILD.bazel

@@ -1,7 +1,6 @@
 package(default_visibility = ["//visibility:public"])
 
-load("@io_bazel_rules_sass//:defs.bzl", "sass_binary", "sass_library")
-load("//tools:defaults.bzl", "ng_module")
+load("//tools:defaults.bzl", "ng_module", "sass_binary", "sass_library")
 
 ng_module(
     name = "mdc-snackbar",
@@ -20,7 +19,7 @@ ng_module(
 )
 
 sass_library(
-    name = "snackbar_scss_lib",
+    name = "mdc_snackbar_scss_lib",
     srcs = glob(["**/_*.scss"]),
     deps = [
         "//src/material-experimental/mdc-helpers:mdc_helpers_scss_lib",

src/material/config.bzl

@@ -24,6 +24,7 @@ entryPoints = [
     "expansion/testing",
     "form-field",
     "grid-list",
+    "grid-list/testing",
     "icon",
     "input",
     "list",

tools/public_api_guard/BUILD.bazel

@@ -1,6 +1,17 @@
 package(default_visibility = ["//visibility:public"])
 
+load("//src/cdk:config.bzl", "CDK_ENTRYPOINTS")
+load("//src/material:config.bzl", "MATERIAL_ENTRYPOINTS", "MATERIAL_TESTING_ENTRYPOINTS")
 load(":generate-guard-tests.bzl", "generate_test_targets")
 
+golden_files = ["cdk/%s.d.ts" % e for e in CDK_ENTRYPOINTS] + \
+               ["material/%s.d.ts" % e for e in MATERIAL_ENTRYPOINTS + MATERIAL_TESTING_ENTRYPOINTS] + [
+    # Primary entry-points.
+    "cdk/cdk.d.ts",
+    "material/material.d.ts",
+    "youtube-player/youtube-player.d.ts",
+    "google-maps/google-maps.d.ts",
+]
+
 # Generate the API guard test targets for each golden file in the current package.
-generate_test_targets(glob(["**/*.d.ts"]))
+generate_test_targets(golden_files)

tools/public_api_guard/material/bottom-sheet/testing.d.ts

@@ -0,0 +1,9 @@
+export interface BottomSheetHarnessFilters extends BaseHarnessFilters {
+}
+
+export declare class MatBottomSheetHarness extends ComponentHarness {
+    dismiss(): Promise<void>;
+    getAriaLabel(): Promise<string | null>;
+    static hostSelector: string;
+    static with(options?: BottomSheetHarnessFilters): HarnessPredicate<MatBottomSheetHarness>;
+}

tools/public_api_guard/material/form-field/testing/control.d.ts

@@ -0,0 +1,2 @@
+export declare abstract class MatFormFieldControlHarness extends ComponentHarness {
+}