Implement GitHub Action to automate patches and documentation

[Pequod55]

Change Description:

This PR introduces a comprehensive automation system for managing Oracle software and patch definitions. It establishes a new workflow where developers can define new patches in a central YAML file, and a GitHub Action automatically updates the necessary configuration files and user documentation.

Solution Overview:

• New GitHub Action (.github/workflows/modify_patches.yml): Triggers on pull requests to master and on manual dispatch. It orchestrates the entire automation process.
• Central Input File (modify_patchlist.yml): A newly structured YAML file where users can add new software and patch definitions. The existing example entries have been commented out to serve as a template.
• Automation Scripts:
  • modify_patches.py: A new Python script that parses modify_patchlist.yml and inserts the new patch data into the primary Ansible configuration file (roles/common/defaults/main.yml).
  • modify_documentation.py: A new Python script that similarly parses the input YAML and automatically updates the software download tables in the user guide (docs/user-guide.md).
• Automated Commits: The workflow uses the stefanzweifel/git-auto-commit-action to commit the file changes generated by the scripts directly back to the pull request branch.
• Testing Framework:
  • Introduces pytest and pytest-mock for testing, with dependencies listed in the new requirements.txt.
  • Includes a new test file, modify_patchlist_test.py, with a comprehensive integration test for the modify_patches.py script.
  • (Note: The .pytest_cache directory has been included. It is recommended to add .pytest_cache/ to the project's .gitignore file.)
• New Documentation (modify_patchlist.md): A detailed user and technical guide has been added to explain the new automation workflow, file structure, and how to add new patches.

Test Commands:

Test Prep:

1. Ensure Python 3 is installed. Install dependencies:

pip install -r ./.github/workflows/requirements.txt

2. Create and check out a new branch from master.
3. In modify_patchlist.yml, uncomment an example entry or add a new one. For example, add a new RDBMS patch:

rdbms_patches:
  - { category: "RU", base: "21.3.0.0.0", release: "21.99.0.0.0", patchnum: "39999999", patchfile: "p39999999_210000_Linux-x86-64.zip", patch_subdir: "/", prereq_check: false, method: "opatch apply", ocm: false, upgrade: false, md5sum: "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4" }

4. (Optional) Add a corresponding entry in the documentation_overrides section to test custom documentation text:

documentation_overrides:
  rdbms_patches:
    category: "Test Patch - MOS"
    software_piece: "Database Release Update 21.99 (Test)"
    file_name: "p39999999_210000_Linux-x86-64.zip"

Test 1: Run unit tests

1. Execute the test suite to ensure the core logic is sound:

pytest

Test 2: Run the automation scripts locally

1. Simulate the GitHub Action by running the scripts in order:

python .github/workflows/modify_documentation.py
python .github/workflows/modify_patches.py

2. Inspect the modified files (roles/common/defaults/main.yml and docs/user-guide.md) to verify the changes.

Test 3: Run the full Git workflow (End-to-End Test)

1. After completing Test Prep, commit the changes to modify_patchlist.yml:

git add modify_patchlist.yml
git commit -m "feat: Add test RDBMS patch 21.99"

2. Push the branch and create a Pull Request to master to trigger the "Modify Patches" GitHub Action.

Expected Results:

For Test 1 (Unit Tests):

• The pytest command completes successfully, with all tests passing.

For Test 2 (Local Run):

• Both Python scripts execute without errors and print log messages about the updates they are performing.
• The file docs/user-guide.md is updated to include a new row for the test patch, using the custom text from the documentation_overrides if provided.
• The file roles/common/defaults/main.yml is updated with the new 21.99.0.0.0 patch entry under the rdbms_patches list.
• The input file modify_patchlist.yml remains unchanged.

For Test 3 (PR Workflow):

• The "Modify Patches" GitHub Action runs and completes successfully in the PR checks.
• A new commit authored by "GitHub Actions" with the message "automation: Update patch files" is pushed to the PR branch.
• This new commit contains the automated changes to roles/common/defaults/main.yml and docs/user-guide.md.
• The modify_patchlist.yml file is not changed by the automation commit.

[google-oss-prow]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Pequod55
Once this PR has been reviewed and has the lgtm label, please assign alexbasinov for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[google-oss-prow]

Hi @Pequod55. Thanks for your PR.

I'm waiting for a google member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.