Unicron v3 apis test coverage dev 5 by lukaszgryglicki · Pull Request #4851 · linuxfoundation/easycla

lukaszgryglicki · 2025-11-04T08:59:43Z

Continue work on V3 E2E test coverage + util scripts for V3/V4.

Note that this is WIP.

cc @mlehotskylf @ahmedomosanya @jarias-lfx

Signed-off-by: Lukasz Gryglicki lgryglicki@cncf.io

Assisted by OpenAI

Signed-off-by: Lukasz Gryglicki <lgryglicki@cncf.io> Assisted by [OpenAI](https://platform.openai.com/) Assisted by [GitHub Copilot](https://github.com/features/copilot)

coderabbitai · 2025-11-04T09:00:17Z

Important

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

74 files out of 281 files are above the max files limit of 200.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch unicron-v3-apis-test-coverage-dev-5

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Copilot

Pull Request Overview

This pull request adds comprehensive V4 API testing infrastructure and scripts for the EasyCLA project. It introduces validation tools, test suites, and utility scripts to ensure V4 API endpoints are properly tested and working.

Key changes:

Added validation script to test all V4 and V3 APIs and verify API coverage
Created test suite scripts for multiple V4 API categories (signatures, templates, sign, project, etc.)
Added individual API endpoint testing scripts across various V4 categories
Included Python script generator for automated creation of missing API scripts

Reviewed Changes

Copilot reviewed 281 out of 281 changed files in this pull request and generated 11 comments.

Show a summary per file

File	Description
utils/validate_all_apis.sh	Main validation script that tests V3/V4 API endpoints and reports coverage statistics
utils/v4/test_all_v4_scripts.sh	Tests syntax and execution of all V4 API scripts
utils/v4/test_all_v4_apis.sh	Comprehensive test suite runner for all V4 API categories
utils/v4/test_all_scripts.sh	Tests all V4 scripts can execute from project root
utils/v4/template/*.sh	Template API endpoint scripts (GET, POST, preview operations)
utils/v4/signatures/*.sh	Signature API endpoint scripts (download, update, whitelist operations)
utils/v4/sign/*.sh	Sign API endpoint scripts (corporate, individual, Gerrit, GitLab signing)
utils/v4/project/*.sh	Project API endpoint scripts (CRUD operations and queries)
utils/v4/gitlab-/.sh	GitLab integration scripts (organizations, repositories, activities, sign)
utils/v4/github-/.sh	GitHub integration scripts (organizations, repositories, activities)
utils/v4/gerrits/*.sh	Gerrit integration scripts
utils/v4/events/*.sh	Event API endpoint scripts
utils/v4/foundation/*.sh	Foundation mapping scripts
utils/v4/current-user/*.sh	Current user API scripts
utils/v4/company/*.sh	Company API endpoint scripts
utils/v4/shared/validate_params.sh	Shared parameter validation utilities
utils/v4/generate_missing_scripts.py	Python script to auto-generate missing API scripts from Swagger
utils/v4/final_coverage_report.sh	Final coverage report generator
utils/v4/simple_test.sh	Simple test script for key V4 endpoints
utils/v4/health/get_health_check.sh	Health check endpoint script
utils/v4/docs/*.sh	API documentation endpoint scripts

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-04T09:02:36Z

utils/v4/template/get_cla_template_preview.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+# GET /template/{claGroupID}/preview
+# Getclatemplatepreview (authenticated)


Missing space in description. Should be "Get cla template preview" instead of "Getclatemplatepreview".

Copilot · 2025-11-04T09:02:36Z

utils/v4/template/create_cla_group_template.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+# POST /clagroup/{claGroupID}/template
+# Createclagrouptemplate (authenticated)


Missing spaces in description. Should be "Create cla group template" instead of "Createclagrouptemplate".

Copilot · 2025-11-04T09:02:36Z

utils/v4/signatures/put_invalidate_icla.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+# PUT /cla-group/{claGroupID}/user/{userID}/icla
+# Invalidateicla (authenticated)


Missing space in description. Should be "Invalidate icla" instead of "Invalidateicla".

Copilot · 2025-11-04T09:02:37Z

utils/v4/signatures/put_ecla_auto_create.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+# PUT /signatures/company/{companyID}/clagroup/{claGroupID}/ecla-auto-create
+# Eclaautocreate (authenticated)


Missing spaces in description. Should be "Ecla auto create" instead of "Eclaautocreate".

Copilot · 2025-11-04T09:02:37Z

utils/v4/signatures/post_add_git_hub_org_allowlist.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+# POST /signatures/{signatureID}/gh-org-whitelist
+# Addgithuborgallowlist (authenticated)


Missing spaces in description. Should be "Add github org allowlist" instead of "Addgithuborgallowlist".

Copilot · 2025-11-04T09:02:37Z

utils/v4/signatures/list_cla_group_corporate_contributors.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+# GET /cla-group/{claGroupID}/corporate-contributors
+# Listclagroupcorporatecontributors (authenticated)


Missing spaces in description. Should be "List cla group corporate contributors" instead of "Listclagroupcorporatecontributors".

Copilot · 2025-11-04T09:02:38Z

tests/functional/cypress/e2e/v3/company.cy.ts

+import {
+  validate_200_Status,
+  validate_204_Status,
+  validate_401_Status,
+  validate_expected_status,
+  validateApiResponse,
+  getTokenKey,
+  getAPIBaseURL,
+  getXACLHeaders,
+} from '../../support/commands';


Unused imports validateApiResponse, validate_200_Status, validate_204_Status, validate_401_Status.

Copilot · 2025-11-04T09:02:38Z

tests/functional/cypress/e2e/v3/company.cy.ts

+  const claEndpoint = getAPIBaseURL('v3');
+  let allowFail: boolean = !(Cypress.env('ALLOW_FAIL') === 1);
+  const timeout = 180000;
+  const local = Cypress.env('LOCAL');


Unused variable local.

Suggested change

const local = Cypress.env('LOCAL');

Copilot · 2025-11-04T09:02:38Z

utils/v3/generate_missing_scripts.py

+import yaml
+import os
+import re
+import json


Import of 'json' is not used.

Copilot · 2025-11-04T09:02:39Z

utils/v4/generate_missing_scripts.py

+import yaml
+import os
+import re
+import json


Import of 'json' is not used.

Signed-off-by: Lukasz Gryglicki <lgryglicki@cncf.io> Assisted by [OpenAI](https://platform.openai.com/) Assisted by [GitHub Copilot](https://github.com/features/copilot)

lukaszgryglicki added 9 commits October 31, 2025 10:17

WIP 1

49b59c8

Signed-off-by: Lukasz Gryglicki <lgryglicki@cncf.io> Assisted by [OpenAI](https://platform.openai.com/) Assisted by [GitHub Copilot](https://github.com/features/copilot)

WIP

300ff0c

Signed-off-by: Lukasz Gryglicki <lgryglicki@cncf.io> Assisted by [OpenAI](https://platform.openai.com/) Assisted by [GitHub Copilot](https://github.com/features/copilot)

WIP 2

21b0b65

Signed-off-by: Lukasz Gryglicki <lgryglicki@cncf.io> Assisted by [OpenAI](https://platform.openai.com/) Assisted by [GitHub Copilot](https://github.com/features/copilot)

WIP 3

3977c8b

Signed-off-by: Lukasz Gryglicki <lgryglicki@cncf.io> Assisted by [OpenAI](https://platform.openai.com/) Assisted by [GitHub Copilot](https://github.com/features/copilot)

WIP 4

10d7d09

Signed-off-by: Lukasz Gryglicki <lgryglicki@cncf.io> Assisted by [OpenAI](https://platform.openai.com/) Assisted by [GitHub Copilot](https://github.com/features/copilot)

WIP 5

acf4372

Signed-off-by: Lukasz Gryglicki <lgryglicki@cncf.io> Assisted by [OpenAI](https://platform.openai.com/) Assisted by [GitHub Copilot](https://github.com/features/copilot)

WIP 10

1ec1854

Signed-off-by: Lukasz Gryglicki <lgryglicki@cncf.io> Assisted by [OpenAI](https://platform.openai.com/) Assisted by [GitHub Copilot](https://github.com/features/copilot)

Fix the failing test

f58146e

Signed-off-by: Lukasz Gryglicki <lgryglicki@cncf.io> Assisted by [OpenAI](https://platform.openai.com/) Assisted by [GitHub Copilot](https://github.com/features/copilot)

V3 Cypress E2E test coverage + V3/V4 shell util scripts

7b4e0c0

Signed-off-by: Lukasz Gryglicki <lgryglicki@cncf.io> Assisted by [OpenAI](https://platform.openai.com/) Assisted by [GitHub Copilot](https://github.com/features/copilot)

lukaszgryglicki requested review from ahmedomosanya, jarias-lfx and mlehotskylf November 4, 2025 08:59

lukaszgryglicki self-assigned this Nov 4, 2025

Copilot AI review requested due to automatic review settings November 4, 2025 08:59

lukaszgryglicki added the WIP label Nov 4, 2025

lukaszgryglicki had a problem deploying to dev November 4, 2025 08:59 — with GitHub Actions Failure

lukaszgryglicki temporarily deployed to dev November 4, 2025 08:59 — with GitHub Actions Inactive

Copilot AI reviewed Nov 4, 2025

View reviewed changes

Fix

1f656e3

Signed-off-by: Lukasz Gryglicki <lgryglicki@cncf.io> Assisted by [OpenAI](https://platform.openai.com/) Assisted by [GitHub Copilot](https://github.com/features/copilot)

lukaszgryglicki temporarily deployed to dev November 4, 2025 17:47 — with GitHub Actions Inactive

lukaszgryglicki had a problem deploying to dev November 4, 2025 17:47 — with GitHub Actions Failure

More tests updates

a41e445

Signed-off-by: Lukasz Gryglicki <lgryglicki@cncf.io> Assisted by [OpenAI](https://platform.openai.com/) Assisted by [GitHub Copilot](https://github.com/features/copilot)

lukaszgryglicki had a problem deploying to dev November 4, 2025 18:08 — with GitHub Actions Failure

lukaszgryglicki temporarily deployed to dev November 4, 2025 18:08 — with GitHub Actions Inactive

V3 company APIs tag finished

c5eadcf

Signed-off-by: Lukasz Gryglicki <lgryglicki@cncf.io> Assisted by [OpenAI](https://platform.openai.com/) Assisted by [GitHub Copilot](https://github.com/features/copilot)

lukaszgryglicki had a problem deploying to dev November 5, 2025 05:01 — with GitHub Actions Failure

lukaszgryglicki temporarily deployed to dev November 5, 2025 05:01 — with GitHub Actions Inactive

lukaszgryglicki removed the WIP label Nov 5, 2025

ahmedomosanya approved these changes Nov 5, 2025

View reviewed changes

lukaszgryglicki merged commit bb63d7d into dev Nov 5, 2025
3 of 6 checks passed

lukaszgryglicki deleted the unicron-v3-apis-test-coverage-dev-5 branch November 5, 2025 08:38

Conversation

lukaszgryglicki commented Nov 4, 2025

Uh oh!

coderabbitai bot commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Other AI code review bot(s) detected

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

coderabbitai bot commented Nov 4, 2025 •

edited

Loading