feat: WIP add crdhandler

[XDRAGON2002]

Type

Enhancement

---

Description

This PR introduces the crdhandler package with a focus on handling CustomResourceDefinitions (CRDs) related to Github repositories. The main changes include:

• The addition of the GithubRepositoryHandler struct in the crdhandler/github package. This struct and its methods handle the initialization of the Github repository, extraction of frameworks, controls, rules, exceptions, and control configurations from the repository, and cleaning the repository.
• The addition of the CrdHandler struct in the crdhandler package. This struct and its methods handle the creation of frameworks, controls, rules, exceptions, and control configurations in the Kubernetes API.
• The addition of various types and structs in the crdhandler/github package, such as GithubRelease, GithubCommit, FrameworkJson, ControlJson, RuleJson, Framework, Control, Rule, Exception, and ControlConfiguration.
• The addition of utility functions for unzipping files in the crdhandler/github package.
• The update of main.go to include the creation of a CrdHandler instance and the handling of CRDs.
• The addition of the CrdHandler struct and the repositoryHandler interface in the crdhandler package.
• The addition of CustomResourceDefinition (CRD) for rules in the Kubernetes API.

---

PR changes walkthrough

	Relevant files
Enhancement	6 files github.go                                                                                                      crdhandler/github/github.go This file introduces a new package crdhandler with a subpackage github. It contains the GithubRepositoryHandler struct and its associated methods. These methods are responsible for initializing the Github repository, extracting frameworks, controls, rules, exceptions, and control configurations from the repository, and cleaning the repository. +284/-0 crd.go                                                                                                            crdhandler/crd.go This file introduces the CrdHandler struct and its associated methods. These methods handle the creation of frameworks, controls, rules, exceptions, and control configurations in the Kubernetes API. +151/-0 types.go                                                                                                        crdhandler/github/types.go This file defines various types and structs used in the crdhandler package, such as GithubRelease, GithubCommit, FrameworkJson, ControlJson, RuleJson, Framework, Control, Rule, Exception, and ControlConfiguration. +162/-0 utils.go                                                                                                        crdhandler/github/utils.go This file provides utility functions for unzipping files, which is used in the crdhandler package. +73/-0 main.go                                                                                                          main.go This file has been updated to include the creation of a CrdHandler instance and the handling of CRDs. +5/-0 types.go                                                                                                        crdhandler/types.go This file defines the CrdHandler struct and the repositoryHandler interface used in the crdhandler package. +22/-0
Configuration changes	1 files rule.yaml                                                                                                      crds/rule.yaml This file defines the CustomResourceDefinition (CRD) for rules in the Kubernetes API. +25/-0

---

User description

Overview

This PR adds support for CRDs

Signed Commits

• Yes, I signed my commits.

How to Test

go run main.go
or
build the operator/deploy in cluster

[codiumai-pr-agent-free]

PR Description updated to latest commit (0284635)

[codiumai-pr-agent-free]

PR Analysis

• 🎯 Main theme: Adding a new feature for handling CustomResourceDefinitions (CRDs) related to Github repositories.
• 📝 PR summary: This PR introduces the crdhandler package which handles CustomResourceDefinitions (CRDs) related to Github repositories. It includes the addition of several structs and methods for initializing the Github repository, extracting various components from the repository, creating these components in the Kubernetes API, and cleaning the repository. The PR also includes the addition of utility functions for unzipping files.
• 📌 Type of PR: Enhancement
• 🧪 Relevant tests added: No
• ⏱️ Estimated effort to review [1-5]: 4, because the PR introduces a significant amount of new code across multiple files, including complex logic for handling Github repositories and Kubernetes CRDs. The code is well-structured and clear, but it requires a good understanding of Kubernetes and Github APIs to review effectively.
• 🔒 Security concerns: No

PR Feedback

• 💡 General suggestions: The PR is well-structured and the code is clear. However, it lacks tests to verify the functionality of the new code. It would be beneficial to add unit tests for the new methods and integration tests to ensure the correct interaction with the Github and Kubernetes APIs. Additionally, error handling could be improved in several places by not just logging the error but also returning it to the caller, allowing for more robust error handling.

• 🤖 Code feedback:

  ---

  relevant file	crdhandler/github/github.go
  suggestion	Consider returning errors from the InitRepository() method instead of just logging them. This would allow the caller to handle the error and decide whether it's fatal or not. [important]
  relevant line	func (grh *GithubRepositoryHandler) InitRepository() { // err ? have

  ---

  relevant file	crdhandler/github/github.go
  suggestion	Avoid ignoring errors when unmarshalling JSON. If the unmarshalling fails, the program might continue with invalid data. [important]
  relevant line	_ = json.Unmarshal([]byte(data), &frameworkJson)

  ---

  relevant file	crdhandler/github/github.go
  suggestion	Avoid ignoring errors when reading files. If the reading fails, the program might continue with invalid data. [important]
  relevant line	data, _ := os.ReadFile("artifacts/frameworks/" + file.Name())

  ---

  relevant file	crdhandler/github/github.go
  suggestion	Consider handling the error when creating a new file. If the file creation fails, the program might continue and cause a panic when trying to close the file. [important]
  relevant line	out, _ := os.Create(filename)

  ---

How to use

Instructions

To invoke the PR-Agent, add a comment using one of the following commands:
/review: Request a review of your Pull Request.
/describe: Update the PR title and description based on the contents of the PR.
/improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
/ask <QUESTION>: Ask a question about the PR.
/update_changelog: Update the changelog based on the PR's contents.
/add_docs: Generate docstring for new components introduced in the PR.
/generate_labels: Generate labels for the PR based on the PR's contents.
see the tools guide for more details.

To edit any configuration parameter from the configuration.toml, add --config_path=new_value.
For example: /review --pr_reviewer.extra_instructions="focus on the file: ..."
To list the possible configuration parameters, add a /config comment.