Add API Implementation #5

gmitch215 · 2024-07-31T21:48:17Z

Merges into #1.

Description

This PR does the following:

Implements CodeMC/API for the Bot
- Performs a RegEx grouping expression on the GitHub repository link, to be used to determine if a project is freestyle, and used as parameters for username and jobName
- Creates a Nexus Repository (/repository/username), Jenkins User (/job/username), and Jenkins Job (/job/username/job/jobName) automatically
- Generates an arbitrary Nexus Password that is 32 characters long (see generator.kt for more details)
- Performed Asynchronously with Kotlin Coroutines & Kotlin Serialization for better performance
Updates the requirements in config.json
- New jenkins, nexus and database sections are now required to be inputted. Similar to Add Jenkins Automation to Accept Command #4, specify the host URLs, with admin login details that the bot should use.
- A new role list called services is available. This includes direct interaction with the current services via API. The sample includes the Moderator and Administrator roles.
- See config.json.sample for more information.
Adds a codemc Slash Command
- This includes multiple user and administer functions related to the API. See the following linked issues for more information:
- remove Admin Command #7
- validate Admin Command #8
- User Remote Commands #9
- Change Password Command #10
Removes the project-url parameter in the Accept command, calculated according to the config.json instead
Updates Gradle to the latest version, which is 8.9.
Adds more missing directories to .gitignore.

API Implementation

The implementation details of the API are on the repository, which performs tests against Jenkins and Nexus containers with similar configuration, and collects code coverage. Thus, specific API changes must be made to the repository, which will then be updated here.

Andre601

A lot of things to discuss, with some changes I would apreciate to be made.

src/main/java/io/codemc/bot/CodeMCBot.java

src/main/java/io/codemc/bot/JavaContinuation.java

src/main/java/io/codemc/bot/commands/CmdApplication.java

src/main/java/io/codemc/bot/JavaContinuation.java

src/main/java/io/codemc/bot/commands/CmdApplication.java

src/main/java/io/codemc/bot/listeners/ModalListener.java

gmitch215 · 2024-08-05T19:06:17Z

Updates the implementation from CodeMC/API. Unit tests pass.

I will add CmdRemove into this PR as well.

I also added a dependabot.yml File for the dependencies in build.gradle.

- Create Remove Command Class - Add `service` section in `config.json` to interact directly with API Services - Set sample to include Moderator and Administrator

gmitch215 · 2024-08-05T20:04:32Z

GitHub is weird.

Andre601

A few things that should be changed.
Main concern is the reliance on the Discord user, with the jenkins username only being optional. Not every user matches their GitHub and Discord names, and using something like the user's nickname is not a good aproach here.

src/main/java/io/codemc/bot/commands/CmdRemove.java

src/main/resources/config.json

src/main/resources/config.json.sample

gmitch215 · 2024-08-24T14:05:54Z

Added a /codemc changepassword subcommand, along with /codemc unlink and a few other utilities.

src/main/java/io/codemc/bot/commands/CmdCodeMC.java

src/main/java/io/codemc/bot/utils/APIUtil.java

src/main/resources/config.json

src/main/resources/config.json.sample

Co-authored-by: Andre_601 <[email protected]>

src/main/java/io/codemc/bot/utils/APIUtil.java

gmitch215 · 2024-09-29T18:41:05Z

That should be all of them. I also upgraded Gradle to the most recent version.

build.gradle

src/main/java/io/codemc/bot/commands/CmdCodeMC.java

Co-authored-by: Andre_601 <[email protected]>

Removed `suspend` Modifiers from Kotlin API

- Remove Unused JavaContinutation - Fix Validation Command - Add Response Message for Change Password

Explicitly set Repository Link to Optional

- Add Logging for Connectivity - Fix Jenkins Authorization

- Fix Message Parsing for Success Message - Move API Methods before Message is Sent

- Add Reason for Deny Button - Fix `lacksRole` Method

gmitch215 · 2024-10-06T01:57:26Z

Tested everything on a Bot with a Docker Setup.

A few notes:

There were a few bugs in the API regarding bot-specific actions, like the validate command where it could create inconsistencies between Jenkins and Nexus passwords.
Added more logging for future debugging and just general information.
submit now denies users that apply with the same name.
- It also appears JDA makes fields required by default, meaning optionality must be explicit.
There were a few bugs regarding typos in configuration paths, along with a small bug for lacksRole in ButtonListener.
The Deny button has a literal "Reason not Provided" as a reason, since making it null replaces it with the Jenkins URL for success
The remove command uses the database to remove the author role from the discord user, removing it as a parameter.
I removed a lot of suspend modifiers in the API, which allows for better interoperability with Java. I also noticed a lack of faster runtime for having coroutines in the validate command where it validates all Jenkins users, so I also removed it there. This means that JavaContinuation no longer exists.
I fixed the dependencies issue by adding all of the necessary dependencies, along with the CodeMC API itself.

gmitch215 added 4 commits July 31, 2024 16:32

Upgrade to Gradle 8.9

c38f8e6

Add Missing Exclude Directories

82529e7

Add Nexus & Jenkins API Automation

89c5aad

Remove Unused freestyle Parameter

b35545f

Andre601 requested changes Jul 31, 2024

View reviewed changes

Add Requested Changes

b1dc277

gmitch215 requested a review from Andre601 August 1, 2024 00:04

Andre601 approved these changes Aug 1, 2024

View reviewed changes

gmitch215 mentioned this pull request Aug 1, 2024

Unit Testing #6

Open

gmitch215 self-assigned this Aug 4, 2024

gmitch215 mentioned this pull request Aug 4, 2024

Add config system and customize command handling #1

Open

gmitch215 added 3 commits August 5, 2024 15:01

Remove Duplicate Repository

3f6c274

Update API Implementation

454f2f9

Create dependabot.yml

f68a401

gmitch215 requested a review from sgdc3 August 5, 2024 19:06

Fix Null Safety

016b1ff

gmitch215 changed the title ~~Add Nexus & Jenkins Automation~~ Add API Implementation Aug 5, 2024

Create remove Command (Closes CodeMC#7)

c886cd6

- Create Remove Command Class - Add `service` section in `config.json` to interact directly with API Services - Set sample to include Moderator and Administrator

gmitch215 closed this Aug 5, 2024

gmitch215 deleted the feat/automation branch August 5, 2024 20:01

gmitch215 restored the feat/automation branch August 5, 2024 20:02

gmitch215 deleted the feat/automation branch August 5, 2024 20:03

gmitch215 restored the feat/automation branch August 5, 2024 20:04

gmitch215 reopened this Aug 5, 2024

This was linked to issues Aug 5, 2024

remove Admin Command #7

Open

CodeMC API v1 CodeMC/API#4

Open

gmitch215 requested a review from Andre601 August 6, 2024 12:58

Andre601 requested changes Aug 6, 2024

View reviewed changes

gmitch215 linked an issue Aug 13, 2024 that may be closed by this pull request

User Remote Commands #9

Open

gmitch215 added 3 commits August 12, 2024 23:54

Create ConfigHandler#getInt

4fcc2de

Add Database Configuration

4ba86ec

Add Database & Change Password Commands (Closes CodeMC#10)

cd02dc1

gmitch215 linked an issue Aug 24, 2024 that may be closed by this pull request

Change Password Command #10

Open

Andre601 requested changes Aug 24, 2024

View reviewed changes

Apply suggestions from Code Review

71c0b23

Co-authored-by: Andre_601 <[email protected]>

sgdc3 approved these changes Aug 24, 2024

View reviewed changes

Andre601 approved these changes Aug 25, 2024

View reviewed changes

Add Remaining Code Suggestions

c09473d

gmitch215 linked an issue Aug 27, 2024 that may be closed by this pull request

Change Password CodeMC/API#12

Open

Andre601 requested changes Sep 27, 2024

View reviewed changes

src/main/java/io/codemc/bot/utils/APIUtil.java Show resolved Hide resolved

gmitch215 added 2 commits September 29, 2024 11:35

Upgrade to Gradle 8.10.2

4f64d2e

Fix Broken Error Format

4eefdcc

gmitch215 requested a review from Andre601 September 29, 2024 18:41

Andre601 requested changes Oct 2, 2024

View reviewed changes

gmitch215 and others added 11 commits October 2, 2024 09:08

Apply suggestions from code review

d7ea200

Co-authored-by: Andre_601 <[email protected]>

Update .gitignore

5590258

Add API Dependencies

0fe5d97

Remove Unused JavaContinuation

7e4c312

Removed `suspend` Modifiers from Kotlin API

Update CmdCodeMC.java

998a3c2

- Remove Unused JavaContinutation - Fix Validation Command - Add Response Message for Change Password

Update CmdSubmit.java

42a6a87

Explicitly set Repository Link to Optional

Update CodeMCBot.java

edf042a

- Add Logging for Connectivity - Fix Jenkins Authorization

Update CmdApplication.java

9655bda

- Fix Message Parsing for Success Message - Move API Methods before Message is Sent

Use Database in remove Command

f2ad0f0

Update ButtonListener.java

2c088c2

- Add Reason for Deny Button - Fix `lacksRole` Method

Deny submit for User of Same Name

1bcfdec

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add API Implementation #5

Add API Implementation #5

gmitch215 commented Jul 31, 2024 •

edited

Loading

Andre601 left a comment

gmitch215 commented Aug 5, 2024 •

edited

Loading

gmitch215 commented Aug 5, 2024

Andre601 left a comment

gmitch215 commented Aug 24, 2024

gmitch215 commented Sep 29, 2024

gmitch215 commented Oct 6, 2024 •

edited

Loading

Add API Implementation #5

Are you sure you want to change the base?

Add API Implementation #5

Conversation

gmitch215 commented Jul 31, 2024 • edited Loading

Description

API Implementation

Andre601 left a comment

Choose a reason for hiding this comment

gmitch215 commented Aug 5, 2024 • edited Loading

gmitch215 commented Aug 5, 2024

Andre601 left a comment

Choose a reason for hiding this comment

gmitch215 commented Aug 24, 2024

gmitch215 commented Sep 29, 2024

gmitch215 commented Oct 6, 2024 • edited Loading

gmitch215 commented Jul 31, 2024 •

edited

Loading

gmitch215 commented Aug 5, 2024 •

edited

Loading

gmitch215 commented Oct 6, 2024 •

edited

Loading