@fixedwidthtable/fixedwidthtable 0.0.1-security → 0.0.3

package/packages/internal-playwright-helpers/src/pages/cognito.ts

@@ -0,0 +1,48 @@
+//
+// Copyright Inrupt Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal in
+// the Software without restriction, including without limitation the rights to use,
+// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+// Software, and to permit persons to whom the Software is furnished to do so,
+// subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+//
+
+import type { Page } from "@playwright/test";
+
+/**
+ * Login page exposed by Cognito, the OIDC Provider used for PodSpaces and other
+ * ESS deployments.
+ */
+export class CognitoPage {
+  page: Page;
+
+  constructor(page: Page) {
+    this.page = page;
+  }
+
+  static isOnPage = (url: URL): boolean => url.hostname.includes("auth.");
+
+  async login(
+    username: string,
+    password: string,
+    options?: { timeout?: number },
+  ) {
+    await this.page
+      .getByRole("textbox", { name: "Username" })
+      .fill(username, options);
+    await this.page.getByRole("textbox", { name: "Password" }).fill(password);
+    return this.page.getByRole("button", { name: "submit" }).click();
+  }
+}

package/packages/internal-playwright-helpers/src/pages/open-id.ts

@@ -0,0 +1,56 @@
+//
+// Copyright Inrupt Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal in
+// the Software without restriction, including without limitation the rights to use,
+// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+// Software, and to permit persons to whom the Software is furnished to do so,
+// subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+//
+
+import { expect, type Page } from "@playwright/test";
+
+/**
+ * The Solid-OIDC Broker exposed by ESS wrapped around an underlying OpenID Provider
+ */
+export class OpenIdPage {
+  page: Page;
+
+  constructor(page: Page) {
+    this.page = page;
+  }
+
+  static isOnPage = (url: URL) => url.hostname.includes("inrupt.com");
+
+  async allow(options?: { timeout?: number }) {
+    // Class-based selector that will remain compatible with previous code
+    const classBasedSelector = this.page.locator(".allow-button");
+    // Testid-based selector that will be compatible with newer releases
+    const testidBasedSelector = this.page.getByTestId("prompt-continue");
+    // Once we no longer support ESS 2.1, we can remove the class-based selector and only use the testid-based one.
+    await expect(classBasedSelector.or(testidBasedSelector)).toBeVisible(
+      options,
+    );
+    // Fallback selector to support class attributes, until testid supports is fully deployed.
+    const correctSelector = (await testidBasedSelector.isVisible())
+      ? testidBasedSelector
+      : classBasedSelector;
+    return correctSelector.click();
+  }
+
+  // TODO: write the deny function
+  // async deny() {
+
+  // }
+}

package/packages/internal-playwright-helpers/src/pages/testPage.ts

@@ -0,0 +1,74 @@
+//
+// Copyright Inrupt Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal in
+// the Software without restriction, including without limitation the rights to use,
+// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+// Software, and to permit persons to whom the Software is furnished to do so,
+// subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+//
+
+import type { Page } from "@playwright/test";
+import { TESTID_SELECTORS } from "@inrupt/internal-playwright-testids";
+
+export class TestPage {
+  page: Page;
+
+  openidProvider: string;
+
+  constructor(page: Page, openidProvider: string) {
+    this.page = page;
+    this.openidProvider = openidProvider;
+  }
+
+  static isOnPage = (url: URL) => url.hostname === "localhost";
+
+  async start(options?: { timeout?: number }) {
+    await this.page.goto("/", options);
+  }
+
+  async startLogin(options?: { timeout?: number }) {
+    await this.page.fill(
+      TESTID_SELECTORS.OPENID_PROVIDER_INPUT,
+      this.openidProvider,
+      options,
+    );
+    return this.page.click(TESTID_SELECTORS.LOGIN_BUTTON, options);
+  }
+
+  async handleRedirect(options?: { timeout?: number }) {
+    // Wait for the backchannel exchange
+    await this.page.waitForRequest(
+      (request) =>
+        request.method() === "POST" && request.url().includes("/token"),
+      options,
+    );
+    await this.page.waitForResponse(
+      (response) => response.status() === 200,
+      options,
+    );
+  }
+
+  async getErrorStatus(options?: { timeout?: number }) {
+    return this.page
+      .locator(TESTID_SELECTORS.ERROR_MESSAGE)
+      .textContent(options);
+  }
+
+  async getSessionStatus(options?: { timeout?: number }) {
+    return this.page
+      .locator(TESTID_SELECTORS.SESSION_STATUS)
+      .textContent(options);
+  }
+}

package/packages/internal-playwright-helpers/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src"
+  },
+  "include": ["src/index.ts"],
+}

package/packages/internal-playwright-testids/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@inrupt/internal-playwright-testids",
+  "version": "2.4.0",
+  "description": "Shared identifiers between browser-based tests and test app.",
+  "main": "dist/index.js",
+  "module": "dist/index.es.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "rollup -c rollup.config.mjs",
+    "clean": "rimraf dist"
+  },
+  "author": "Inrupt <devtools-team@inrupt.com>",
+  "license": "MIT",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    }
+  }
+}

package/packages/internal-playwright-testids/rollup.config.mjs

@@ -0,0 +1,56 @@
+// The following is only possible from Node 18 onwards
+// import pkg from "./package.json" assert { type: "json" };
+
+// Until we only support Node 18+, this should be used instead
+// (see https://rollupjs.org/guide/en/#importing-packagejson)
+import { createRequire } from "node:module";
+const require = createRequire(import.meta.url);
+const pkg = require("./package.json");
+
+import typescript from "rollup-plugin-typescript2";
+
+const external = [
+  ...Object.keys(pkg.dependencies || {}),
+];
+
+const plugins = [
+  typescript({
+    // Use our own version of TypeScript, rather than the one bundled with the plugin:
+    typescript: require("typescript"),
+    tsconfigOverride: {
+      compilerOptions: {
+        module: "esnext",
+      },
+    },
+  }),
+];
+
+const rollupDefaultConfig = { external, plugins };
+
+export default [
+  {
+    ...rollupDefaultConfig,
+    input: "src/index.ts",
+    output: [
+      {
+        file: pkg.main,
+        format: "cjs",
+      },
+      {
+        file: pkg.module,
+        entryFileNames: "[name].es.js",
+        format: "esm",
+      },
+    ],
+  },
+  {
+    ...rollupDefaultConfig,
+    input: ["src/index.ts"],
+    output: {
+      dir: "dist",
+      entryFileNames: "[name].mjs",
+      format: "esm",
+      preserveModules: true,
+    },
+  },
+];

package/packages/internal-playwright-testids/src/index.ts

@@ -0,0 +1,35 @@
+//
+// Copyright Inrupt Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal in
+// the Software without restriction, including without limitation the rights to use,
+// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+// Software, and to permit persons to whom the Software is furnished to do so,
+// subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+//
+export const TESTID_OPENID_PROVIDER_INPUT = "identityProviderInput";
+export const TESTID_LOGIN_BUTTON = "loginButton";
+export const TESTID_LOGOUT_BUTTON = "logoutButton";
+export const TESTID_ERROR_MESSAGE = "errorMessage";
+export const TESTID_SESSION_STATUS = "loggedInMessage";
+
+const buildSelector = (testid: string) => `[data-testid=${testid}]`;
+
+export const TESTID_SELECTORS = {
+  OPENID_PROVIDER_INPUT: buildSelector(TESTID_OPENID_PROVIDER_INPUT),
+  LOGIN_BUTTON: buildSelector(TESTID_LOGIN_BUTTON),
+  LOGOUT_BUTTON: buildSelector(TESTID_LOGOUT_BUTTON),
+  ERROR_MESSAGE: buildSelector(TESTID_ERROR_MESSAGE),
+  SESSION_STATUS: buildSelector(TESTID_SESSION_STATUS),
+};

package/packages/internal-playwright-testids/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src"
+  },
+  "include": ["src/index.ts"],
+}

package/packages/internal-test-env/README.md

@@ -0,0 +1,44 @@
+# @inrupt/internal-test-env
+
+This package contains utilities to help setup automated testing environments.
+
+## Installation
+
+1. `npm install --save-dev @inrupt/internal-test-env`
+
+## Usage:
+
+Add the function import as needed.
+
+```
+import "@inrupt/internal-test-env"
+```
+
+## Features
+
+This helper exposes the following:
+
+- `getNodeTestingEnvironment`
+- `getBrowserTestingEnvironment`
+
+These two functions will load from the environment variables as follows:
+
+- Some variables will always be loaded and validated if applicable
+  - `E2E_TEST_ENVIRONMENT`: name of the target environment, used for information purpose.
+    E.g., `ESS Dev-Next`
+  - `E2E_TEST_IDP`: IRI of the OpenID Provider where the test session will be retrieved.
+  - Any environment variable starting with the pattern `E2E_TEST_FEATURE_*` will be
+    made available in a feature flags dictionary keyed by `*`. E.g., `E2E_TEST_FEATURE_NOTIFICATIONS`
+    being defined will result in `features["NOTIFICATIONS"]` to capture the associated
+    value.
+- Some variables will only be loaded and validated if explicitly requested as part
+  of the `get*TestingEnvironment` call:
+  - `E2E_TEST_NOTIFICATION_GATEWAY`
+  - `E2E_TEST_NOTIFICATION_PROTOCOL`
+  - `E2E_TEST_VC_PROVIDER`
+  - `E2E_TEST_OWNER_CLIENT_ID`
+  - `E2E_TEST_OWNER_CLIENT_SECRET`
+  - `E2E_TEST_REQUESTOR_CLIENT_ID`
+  - `E2E_TEST_REQUESTOR_CLIENT_SECRET`
+  - `E2E_TEST_USER`
+  - `E2E_TEST_PASSWORD`

package/packages/internal-test-env/env/.env.example

@@ -0,0 +1,36 @@
+# Copy-paste this example file into a .env.test.local and fill in the missing values.
+# Note that you can have multiple local environments side by side, e.g. .env.dev.local
+# and .env.nss.local, and select which should be loaded by setting the `NODE_ENV`
+# environment variable. For instance, running `NODE_ENV=dev npm run test:e2e:node`
+# will load .env.dev.local.
+
+# See `availableEnvironment` in ../setup/getTestingEnvironment.ts for a list of
+# available environments
+E2E_TEST_ENVIRONMENT="ESS PodSpaces"
+E2E_TEST_IDP=https://login.inrupt.com/
+E2E_TEST_NOTIFICATION_GATEWAY=https://notification.inrupt.com
+E2E_TEST_NOTIFICATION_PROTOCOL=ESS Notifications Protocol
+
+# e.g. via https://login.inrupt.com/registration.html
+E2E_TEST_VC_PROVIDER=https://vc.inrupt.com
+
+# Obtain these credentials by registering an application with your identity
+# provider (E2E_TEST_IDP) 
+#
+# Client credentials for the access requestor 
+E2E_TEST_REQUESTOR_CLIENT_ID=
+E2E_TEST_REQUESTOR_CLIENT_SECRET=
+
+# Client credentials for the resource owner
+E2E_TEST_OWNER_CLIENT_ID=
+E2E_TEST_OWNER_CLIENT_SECRET=
+
+# Obtain user credentials by signing up for a Pod, e.g., via
+# https://start.inrupt.com/
+E2E_TEST_USER=<username>
+E2E_TEST_PASSWORD=<password>
+
+# Library specific feature flags
+E2E_TEST_FEATURE_FLAG_ACP="true"
+E2E_TEST_FEATURE_FLAG_WAC="true"
+E2E_TEST_FEATURE_FLAG_ACP_V3="true"