@edifice.io/communities-tests 1.0.0-develop-pedago.20250725171105

package/it/scenarios/utils/_resource-tests.utils.ts

@@ -0,0 +1,396 @@
+import { check, group, fail } from "k6";
+
+import {
+  authenticateWeb,
+  logout,
+  UserInfo,
+} from "../../../node_modules/edifice-k6-commons/dist/index.js";
+
+import {
+  createResource,
+  listCommunityResources,
+  getResource,
+  updateResource,
+  deleteResource,
+  countResources,
+  ResourceType,
+  AppName,
+} from "./_resource-api.utils.ts";
+import { createRealEntResource } from "./_resource-ent.utils.ts";
+
+/**
+ * Configuration options for resource tests
+ */
+export interface ResourceTestConfig {
+  appName: AppName; // App name to test (EXTERNAL_LINK, WORKSPACE, etc.)
+  resourceType: ResourceType; // Resource type (ENT, IMAGE, VIDEO, etc.)
+  sampleResourceEntId?: string; // Sample resource ID (required for non-external-link resources)
+  sampleUrl?: string; // Sample URL (required for external links)
+  sampleTitle?: string; // Sample title
+  sampleUpdatedTitle?: string; // Sample updated title for testing updates
+  sampleUpdatedUrl?: string; // Sample updated URL for external links
+}
+
+/**
+ * Default configurations for different app types
+ */
+export const DEFAULT_TEST_CONFIGS: Record<AppName, ResourceTestConfig> = {
+  [AppName.EXTERNAL_LINK]: {
+    appName: AppName.EXTERNAL_LINK,
+    resourceType: ResourceType.EXTERNAL_LINK,
+    sampleUrl: "https://example.com/test",
+    sampleTitle: "Test External Link",
+    sampleUpdatedTitle: "Updated External Link",
+    sampleUpdatedUrl: "https://example.com/updated",
+  },
+  [AppName.WORKSPACE]: {
+    appName: AppName.WORKSPACE,
+    resourceType: ResourceType.ENT,
+    sampleResourceEntId: "workspace-document-123",
+    sampleTitle: "Test Workspace Document",
+    sampleUpdatedTitle: "Updated Workspace Document",
+  },
+  [AppName.BLOG]: {
+    appName: AppName.BLOG,
+    resourceType: ResourceType.ENT,
+    sampleResourceEntId: "blog-post-123",
+    sampleTitle: "Test Blog Post",
+    sampleUpdatedTitle: "Updated Blog Post",
+  },
+  [AppName.WIKI]: {
+    appName: AppName.WIKI,
+    resourceType: ResourceType.ENT,
+    sampleResourceEntId: "wiki-page-123",
+    sampleTitle: "Test Wiki Page",
+    sampleUpdatedTitle: "Updated Wiki Page",
+  },
+  [AppName.EXERCIZER]: {
+    appName: AppName.EXERCIZER,
+    resourceType: ResourceType.ENT,
+    sampleResourceEntId: "exercizer-123",
+    sampleTitle: "Test Exercizer",
+    sampleUpdatedTitle: "Updated Exercizer",
+  },
+  [AppName.SCRAPBOOK]: {
+    appName: AppName.SCRAPBOOK,
+    resourceType: ResourceType.ENT,
+    sampleResourceEntId: "scrapbook-123",
+    sampleTitle: "Test Scrapbook",
+    sampleUpdatedTitle: "Updated Scrapbook",
+  },
+  [AppName.MINDMAP]: {
+    appName: AppName.MINDMAP,
+    resourceType: ResourceType.ENT,
+    sampleResourceEntId: "mindmap-123",
+    sampleTitle: "Test Mindmap",
+    sampleUpdatedTitle: "Updated Mindmap",
+  },
+  [AppName.FORM]: {
+    appName: AppName.FORM,
+    resourceType: ResourceType.ENT,
+    sampleResourceEntId: "form-123",
+    sampleTitle: "Test Form",
+    sampleUpdatedTitle: "Updated Form",
+  },
+  [AppName.PAD]: {
+    appName: AppName.PAD,
+    resourceType: ResourceType.ENT,
+    sampleResourceEntId: "pad-123",
+    sampleTitle: "Test Pad",
+    sampleUpdatedTitle: "Updated Pad",
+  },
+  [AppName.COLLABORATIVEWALL]: {
+    appName: AppName.COLLABORATIVEWALL,
+    resourceType: ResourceType.ENT,
+    sampleResourceEntId: "wall-123",
+    sampleTitle: "Test Collaborative Wall",
+    sampleUpdatedTitle: "Updated Collaborative Wall",
+  },
+  [AppName.TIMELINEGENERATOR]: {
+    appName: AppName.TIMELINEGENERATOR,
+    resourceType: ResourceType.ENT,
+    sampleResourceEntId: "timeline-123",
+    sampleTitle: "Test Timeline",
+    sampleUpdatedTitle: "Updated Timeline",
+  },
+  [AppName.COLLABORATIVEDITOR]: {
+    appName: AppName.COLLABORATIVEDITOR,
+    resourceType: ResourceType.ENT,
+    sampleResourceEntId: "collaborative-editor-123",
+    sampleTitle: "Test Collaborative Editor",
+    sampleUpdatedTitle: "Updated Collaborative Editor",
+  },
+};
+
+/**
+ * Runs comprehensive tests for resource management with a specific app type
+ *
+ * @param communityId ID of the community to test in
+ * @param config Resource test configuration
+ * @param adminUser Admin user for testing admin operations
+ * @param memberUser Regular user for testing permission restrictions
+ * @returns Resource ID created during the test
+ */
+export function testResourceManagement(
+  communityId: number,
+  config: ResourceTestConfig,
+  adminUser: UserInfo,
+  memberUser: UserInfo,
+): number | null {
+  let resourceId: number | null = null;
+
+  // Prepare update data based on app type
+  const updateData: Record<string, any> = {
+    title: config.sampleUpdatedTitle,
+  };
+
+  if (config.appName === AppName.EXTERNAL_LINK && config.sampleUpdatedUrl) {
+    updateData.resourceUrl = config.sampleUpdatedUrl;
+    updateData.openInNewTab = false;
+  }
+
+  // Test as admin user
+  group(`Admin creates and manages ${config.appName} resources`, () => {
+    const adminAuthenticated = authenticateWeb(adminUser.login, "password");
+    if (!adminAuthenticated) {
+      fail("Admin authentication failed");
+    }
+    // Create a resource entity for ENT apps
+    const resourceEntId = createRealEntResource(config.appName, {
+      title: config.sampleTitle,
+    });
+    check(resourceEntId, {
+      [`[${config.appName}] resourceId created successfully`]: (id) =>
+        id !== null,
+    });
+    // Assign the resourceEntId to the config for later use
+    config.sampleResourceEntId = resourceEntId!;
+
+    // Prepare create data based on app type
+    const createData = {
+      type: config.resourceType,
+      appName: config.appName,
+      title: config.sampleTitle,
+    };
+
+    // Add specific required fields based on app type
+    if (config.appName === AppName.EXTERNAL_LINK) {
+      Object.assign(createData, {
+        resourceUrl: config.sampleUrl,
+        openInNewTab: true,
+      });
+    } else {
+      Object.assign(createData, {
+        resourceEntId: config.sampleResourceEntId,
+      });
+    }
+    // Create another resource for deletion
+    const deleteTestData = {
+      ...createData,
+      title: `${config.sampleTitle} to be deleted`,
+    };
+    // Test resource creation
+    group(`Create ${config.appName} resource`, () => {
+      const resource = createResource(communityId, createData);
+
+      check(resource, {
+        [`[${config.appName}] resource created successfully`]: (r) =>
+          r !== null,
+        [`[${config.appName}] resource has correct type`]: (r) =>
+          r !== null && r.type === config.resourceType,
+        [`[${config.appName}] resource has correct app name`]: (r) =>
+          r !== null && r.appName === config.appName,
+      });
+
+      // For External Links, check URL and openInNewTab
+      if (config.appName === AppName.EXTERNAL_LINK) {
+        check(resource, {
+          [`[${config.appName}] resource has correct URL`]: (r) =>
+            r !== null && r.url === config.sampleUrl,
+          [`[${config.appName}] resource has correct openInNewTab`]: (r) =>
+            r !== null && r.openInNewTab === true,
+        });
+      }
+
+      // Check title for all types
+      check(resource, {
+        [`[${config.appName}] resource has correct title`]: (r) =>
+          r !== null && r.title === config.sampleTitle,
+      });
+
+      if (resource) {
+        resourceId = resource.id;
+        console.log(
+          `Created ${config.appName} resource with ID: ${resourceId}`,
+        );
+      }
+    });
+
+    // Test resource listing
+    group(`List ${config.appName} resources in community`, () => {
+      const resources = listCommunityResources(communityId);
+
+      check(resources, {
+        [`[${config.appName}] listing resources successful`]: (r) => r !== null,
+        [`[${config.appName}] resource list contains items`]: (r) =>
+          r !== null && r.items && r.items.length > 0,
+        [`[${config.appName}] created resource is in the list`]: (r) => {
+          return r !== null && r.items.some((res) => res.id === resourceId);
+        },
+      });
+    });
+
+    // Test resource counting
+    group(`Count ${config.appName} resources in community`, () => {
+      const countResult = countResources(communityId);
+
+      check(countResult, {
+        [`[${config.appName}] count successful`]: (r) => r !== null,
+        [`[${config.appName}] count returns positive number`]: (r) =>
+          r !== null && r.count > 0,
+      });
+    });
+
+    // Test resource retrieval
+    group(`Get ${config.appName} resource by ID`, () => {
+      if (!resourceId) return;
+
+      const resource = getResource(communityId, resourceId);
+
+      check(resource, {
+        [`[${config.appName}] resource retrieval successful`]: (r) =>
+          r !== null,
+        [`[${config.appName}] retrieved resource has correct ID`]: (r) =>
+          r !== null && r.id === resourceId,
+        [`[${config.appName}] resource has correct title`]: (r) =>
+          r !== null && r.title === config.sampleTitle,
+      });
+
+      // Check URL for external links
+      if (config.appName === AppName.EXTERNAL_LINK) {
+        check(resource, {
+          [`[${config.appName}] resource has correct URL`]: (r) =>
+            r !== null && r.url === config.sampleUrl,
+        });
+      }
+    });
+
+    // Test resource update
+    group(`Update ${config.appName} resource`, () => {
+      if (!resourceId) return;
+
+      const updated = updateResource(communityId, resourceId, updateData);
+
+      check(updated, {
+        [`[${config.appName}] resource update successful`]: (r) => r !== null,
+        [`[${config.appName}] resource has updated title`]: (r) =>
+          r !== null && r.title === config.sampleUpdatedTitle,
+      });
+
+      // Check updated URL and openInNewTab for external links
+      if (config.appName === AppName.EXTERNAL_LINK && config.sampleUpdatedUrl) {
+        check(updated, {
+          [`[${config.appName}] resource has updated URL`]: (r) =>
+            r !== null && r.url === config.sampleUpdatedUrl,
+          [`[${config.appName}] resource has updated openInNewTab`]: (r) =>
+            r !== null && r.openInNewTab === false,
+        });
+      }
+
+      // Verify the update was persisted
+      const verified = getResource(communityId, resourceId);
+      check(verified, {
+        [`[${config.appName}] updated resource persisted correctly`]: (r) =>
+          r !== null && r.title === config.sampleUpdatedTitle,
+      });
+    });
+
+    // Test resource deletion
+    group(`Delete ${config.appName} resource`, () => {
+      const deleteTestResource = createResource(communityId, deleteTestData);
+
+      if (deleteTestResource) {
+        const deleteResult = deleteResource(communityId, deleteTestResource.id);
+
+        check(deleteResult, {
+          [`[${config.appName}] resource deletion successful`]: (r) =>
+            r === true,
+        });
+
+        // Verify the resource was deleted
+        const verifyDeleted = getResource(communityId, deleteTestResource.id);
+        check(verifyDeleted, {
+          [`[${config.appName}] deleted resource is no longer accessible`]: (
+            r,
+          ) => r === null,
+        });
+      }
+    });
+
+    logout();
+  });
+
+  // Test as regular member
+  group(`Member can view but not modify ${config.appName} resources`, () => {
+    if (!resourceId) return;
+
+    const memberAuthenticated = authenticateWeb(memberUser.login, "password");
+    if (!memberAuthenticated) {
+      fail("Member authentication failed");
+    }
+
+    // Test resource viewing as member
+    group(`Member can view ${config.appName} resources`, () => {
+      const resources = listCommunityResources(communityId);
+      check(resources, {
+        [`[${config.appName}] member can list resources`]: (r) => r !== null,
+      });
+
+      const resource = getResource(communityId, resourceId!);
+      check(resource, {
+        [`[${config.appName}] member can get individual resource`]: (r) =>
+          r !== null,
+      });
+    });
+
+    // Test that member cannot update resources
+    group(`Member cannot update ${config.appName} resources`, () => {
+      const updateResult = updateResource(communityId, resourceId!, {
+        title: "Member should not be able to update",
+      });
+
+      check(updateResult, {
+        [`[${config.appName}] member cannot update resources`]: (r) =>
+          r === null,
+      });
+    });
+
+    // Test that member cannot delete resources
+    group(`Member cannot delete ${config.appName} resources`, () => {
+      const deleteResult = deleteResource(communityId, resourceId!);
+
+      check(deleteResult, {
+        [`[${config.appName}] member cannot delete resources`]: (r) =>
+          r === false,
+      });
+    });
+
+    // Test that member cannot create resources
+    group(`Member cannot create ${config.appName} resources`, () => {
+      const createResult = createResource(communityId, {
+        type: config.resourceType,
+        appName: config.appName,
+        title: config.sampleTitle,
+      });
+
+      check(createResult, {
+        [`[${config.appName}] member cannot create resources`]: (r) =>
+          r === null,
+      });
+    });
+
+    logout();
+  });
+
+  return resourceId;
+}

package/it/scenarios/utils/_role.utils.ts

@@ -0,0 +1,33 @@
+import http from "k6/http";
+import { getHeaders, getRoleByName, Role } from "../../../node_modules/edifice-k6-commons/dist/index.js";
+import { check } from "k6";
+
+const rootUrl = __ENV.ROOT_URL || "";
+//TODO move to k6-commons
+export function createAndSetAllRoles(): Role {
+  const roleName = `All - Stress Test`;
+  let role = getRoleByName(roleName);
+  if (role) {
+    console.log(`Role ${roleName} already existed`);
+  } else {
+    let res = http.get(
+      `${rootUrl}/appregistry/applications/actions?actionType=WORKFLOW`,
+      { headers: getHeaders() },
+    );
+    check(res, { "get workflow actions": (r) => r.status == 200 });
+    const applications = JSON.parse(<string>res.body) as Array<{actions: string[]}>;
+    const actions = applications.flatMap(application => application.actions.map((entries) => entries[0]));
+    const headers = getHeaders();
+    headers["content-type"] = "application/json";
+    const payload = {
+      role: roleName,
+      actions,
+    };
+    res = http.post(`${rootUrl}/appregistry/role`, JSON.stringify(payload), {
+      headers,
+    });
+    check(res, { "save role ok": (r) => r.status == 201 });
+    role = getRoleByName(roleName);
+  }
+  return role;
+}

package/loadtest/index.ts

@@ -0,0 +1,6 @@
+import { UserSetupData } from "../node_modules/edifice-k6-commons/dist/index.js";
+import { group } from "k6";
+
+export function community(_: UserSetupData) {
+  group("[community]", () => {});
+}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@edifice.io/communities-tests",
+  "version": "1.0.0-develop-pedago.20250725171105",
+  "description": "Common functions for testing module community with K6.",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/edificeio/communities"
+  },
+  "author": "Edifice",
+  "license": "AGPL-3.0",
+  "bugs": {
+    "url": "https://github.com/edificeio/communities/issues"
+  },
+  "homepage": "https://github.com/edificeio/communities#readme",
+  "engines": {
+    "node": ">=22"
+  },
+  "engineStrict": true,
+  "type": "module",
+  "files": [
+    "**/*.ts"
+  ],
+  "devDependencies": {
+    "@types/k6": "^0.49.3",
+    "@types/node": "^20.11.21",
+    "edifice-k6-commons": "2.0.1-develop",
+    "husky": "^9.0.11",
+    "prettier": "^3.2.5",
+    "semantic-release": "^23.0.2",
+    "typescript": "^5.2.2",
+    "vite": "^5.1.4",
+    "vite-plugin-dts": "^4.3.0"
+  },
+  "lint-staged": {
+    "*.{js,ts,jsx,tsx,json,css,md}": "pnpm format"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "build:types": "tsc --build",
+    "preview": "vite preview",
+    "clean": "rm -Rf dist",
+    "format": "pnpm run format:write && pnpm run format:check",
+    "format:check": "npx prettier --check \"src/**/*.ts\"",
+    "format:write": "npx prettier --write \"src/**/*.ts\"",
+    "pre-commit": "pnpm run format"
+  }
+}

package/vite.config.ts

@@ -0,0 +1,23 @@
+// vite.config.ts
+import { resolve } from "path";
+import { defineConfig } from "vite";
+import dts from "vite-plugin-dts";
+
+export default defineConfig({
+  build: {
+    lib: {
+      entry: resolve(__dirname, "loadtest/index.ts"),
+      name: "community-k6-tests",
+      fileName: "index",
+    },
+    rollupOptions: {
+      external: ["k6", "k6/http"],
+    },
+  },
+  plugins: [
+    dts({
+      insertTypesEntry: true, // Ensures a types entry is added to package.json
+      outDir: "dist", // Directory for type definitions
+    }),
+  ],
+});