Compare commits

...

42 commits

Author SHA1 Message Date
301c56912d Update git documentation
All checks were successful
Test / build (push) Successful in 13s
2025-01-21 20:51:39 +00:00
b275f60f94 Merge branch 'main' into develop
All checks were successful
Deploy To Stage / build (push) Successful in 21s
Deploy To Stage / deploy (push) Successful in 15s
2024-12-10 10:37:04 +00:00
5f49117196 Upgrade to node v20
All checks were successful
Deploy To Stage / build (push) Successful in 7s
Deploy To Stage / deploy (push) Successful in 14s
2024-10-28 11:39:14 +00:00
5beebba29a Upgrade packages
Some checks failed
Deploy To Stage / build (push) Failing after 2s
Deploy To Stage / deploy (push) Has been skipped
2024-10-28 11:37:44 +00:00
fdf52c2285 Remove unused resolved packages 2024-10-28 11:34:45 +00:00
e3a583aa99 Upgrade packages 2024-10-28 11:34:11 +00:00
3a4665f907 Update dependency @types/jest to v29.5.14 (#488)
All checks were successful
Deploy To Stage / build (push) Successful in 6s
Deploy To Stage / deploy (push) Successful in 17s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@types/jest](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jest) ([source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/jest)) | devDependencies | patch | [`29.5.13` -> `29.5.14`](https://renovatebot.com/diffs/npm/@types%2fjest/29.5.13/29.5.14) |

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC44MC4wIiwidXBkYXRlZEluVmVyIjoiMzguODAuMCIsInRhcmdldEJyYW5jaCI6ImRldmVsb3AiLCJsYWJlbHMiOltdfQ==-->

Reviewed-on: #488
Reviewed-by: Vylpes <ethan@vylpes.com>
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-10-28 11:28:46 +00:00
60e736774d Update appleboy/ssh-action action to v1.1.0 (#482)
All checks were successful
Deploy To Stage / build (push) Successful in 8s
Deploy To Stage / deploy (push) Successful in 17s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [appleboy/ssh-action](https://github.com/appleboy/ssh-action) | action | minor | `v1.0.3` -> `v1.1.0` |

---

### Release Notes

<details>
<summary>appleboy/ssh-action (appleboy/ssh-action)</summary>

### [`v1.1.0`](https://github.com/appleboy/ssh-action/releases/tag/v1.1.0)

[Compare Source](https://github.com/appleboy/ssh-action/compare/v1.0.3...v1.1.0)

##### Changelog

##### Bug fixes

-   [`0c7561b`](0c7561b1a3): fix: switch to SSH key authentication for security ([@&#8203;appleboy](https://github.com/appleboy))

##### Enhancements

-   [`9b978f0`](9b978f09f2): chore: update SSH action version in README files ([@&#8203;appleboy](https://github.com/appleboy))
-   [`1991c55`](1991c553ec): chore(file): update target file ([@&#8203;appleboy](https://github.com/appleboy))
-   [`aa293c2`](aa293c24bb): chore: optimize system configuration and API integration ([@&#8203;appleboy](https://github.com/appleboy))
-   [`036cad7`](036cad7df7): chore: update drone-ssh to version 1.7.7 ([@&#8203;appleboy](https://github.com/appleboy))
-   [`8b60782`](8b6078208d): chore(cli): enhance version handling and testing mechanisms ([@&#8203;appleboy](https://github.com/appleboy))
-   [`5ade826`](5ade826485): chore: improve CLI reliability and version visibility ([@&#8203;appleboy](https://github.com/appleboy))
-   [`eaeb069`](eaeb06998d): chore(cli): enhance curl command with silent mode and redirects ([@&#8203;appleboy](https://github.com/appleboy))
-   [`58164d0`](58164d0dc2): chore: remove Dockerfile and related configurations ([@&#8203;appleboy](https://github.com/appleboy))

##### Refactor

-   [`da612c8`](da612c8015): refactor: optimize CI pipeline for faster execution ([@&#8203;appleboy](https://github.com/appleboy))

##### Build process updates

-   [`c781418`](c78141851a): ci: enhance GitHub Actions for IPv6 and flexibility ([#&#8203;303](https://github.com/appleboy/ssh-action/issues/303)) ([@&#8203;appleboy](https://github.com/appleboy))
-   [`d2d6858`](d2d6858859): ci: enhance GitHub workflow for SSH actions and deployments ([@&#8203;appleboy](https://github.com/appleboy))
-   [`551964e`](551964ebda): ci: optimize GitHub Actions workflow configuration ([@&#8203;appleboy](https://github.com/appleboy))
-   [`f916346`](f916346256): ci: refactor CI workflow and improve robustness ([#&#8203;320](https://github.com/appleboy/ssh-action/issues/320)) ([@&#8203;appleboy](https://github.com/appleboy))
-   [`aabaf12`](aabaf1254d): ci: add bug report template ([@&#8203;appleboy](https://github.com/appleboy))
-   [`c8594ae`](c8594ae37d): ci: implement GitHub Actions for remote SSH execution ([@&#8203;appleboy](https://github.com/appleboy))
-   [`40aad53`](40aad53c5a): ci: add SSH authentication setup for GitHub Actions ([@&#8203;appleboy](https://github.com/appleboy))
-   [`0b0e770`](0b0e77098a): ci: optimize and enhance SSH server workflow ([@&#8203;appleboy](https://github.com/appleboy))
-   [`977b74a`](977b74a12d): ci: enhance CI workflow with SSH job and optimizations ([@&#8203;appleboy](https://github.com/appleboy))
-   [`2eeab5b`](2eeab5bdba): ci: refactor GitHub Actions key management ([@&#8203;appleboy](https://github.com/appleboy))
-   [`acd41e5`](acd41e5091): ci: enhance SSH job testing with varied key/password scenarios ([@&#8203;appleboy](https://github.com/appleboy))
-   [`f05aefe`](f05aefe351): ci: enhance SSH action configuration and error handling ([@&#8203;appleboy](https://github.com/appleboy))
-   [`e40b597`](e40b597081): ci: add GitHub Actions job for SSH key passphrase support ([@&#8203;appleboy](https://github.com/appleboy))
-   [`15b64dc`](15b64dc891): ci: enhance CI pipeline with SSH key handling improvements ([@&#8203;appleboy](https://github.com/appleboy))
-   [`a39b3cc`](a39b3cce7d): ci: enhance CI/CD pipeline with SSH command execution ([@&#8203;appleboy](https://github.com/appleboy))
-   [`815c574`](815c5743ac): ci: enhance deployment with multi-host SSH action ([@&#8203;appleboy](https://github.com/appleboy))
-   [`378323e`](378323e4c8): ci: add multi-server support to CI workflow ([@&#8203;appleboy](https://github.com/appleboy))
-   [`fc1c1fc`](fc1c1fce51): ci: add GitHub Actions job for [`ed25519`](https://github.com/appleboy/ssh-action/commit/ed25519) key support ([@&#8203;appleboy](https://github.com/appleboy))
-   [`f0e5a23`](f0e5a23d53): ci: add environment variable handling in GitHub Actions ([@&#8203;appleboy](https://github.com/appleboy))
-   [`9c32aa6`](9c32aa61f8): ci: refactor workflows and API integrations ([@&#8203;appleboy](https://github.com/appleboy))
-   [`97f8d75`](97f8d752b5): ci: enable root access in CI pipeline ([@&#8203;appleboy](https://github.com/appleboy))
-   [`5a8776f`](5a8776fd15): ci: switch to password authentication in GitHub workflow ([@&#8203;appleboy](https://github.com/appleboy))
-   [`b6941ae`](b6941ae5d5): ci: refactor codebase and optimize performance ([@&#8203;appleboy](https://github.com/appleboy))
-   [`43895f2`](43895f2cd5): ci: refactor SSH testing workflows and job configurations ([@&#8203;appleboy](https://github.com/appleboy))
-   [`06fa62e`](06fa62e61c): ci: rename the workflow files. ([@&#8203;appleboy](https://github.com/appleboy))
-   [`b4a07ca`](b4a07ca594): ci: enhance GitHub Actions with secret variable support ([#&#8203;330](https://github.com/appleboy/ssh-action/issues/330)) ([@&#8203;appleboy](https://github.com/appleboy))
-   [`25ce8cb`](25ce8cbbcb): ci: implement automated release workflow with GoReleaser ([@&#8203;appleboy](https://github.com/appleboy))

##### Documentation updates

-   [`8a779a5`](8a779a5b1a): docs: describe true usage of allenvs parameter ([#&#8203;301](https://github.com/appleboy/ssh-action/issues/301)) ([@&#8203;hussu010](https://github.com/hussu010))
-   [`fe44be0`](fe44be0b96): docs: improve documentation and CI robustness ([@&#8203;appleboy](https://github.com/appleboy))
-   [`dd0f09c`](dd0f09ca07): docs: improve README clarity and completeness ([@&#8203;appleboy](https://github.com/appleboy))
-   [`71d43ea`](71d43ea0f7): docs: improve documentation and testing configurations ([@&#8203;appleboy](https://github.com/appleboy))
-   [`28428a1`](28428a13f5): docs: improve cross-platform clipboard support for key copying ([@&#8203;appleboy](https://github.com/appleboy))
-   [`d732991`](d732991ab0): docs(lang): README.zh-cn Document ([#&#8203;332](https://github.com/appleboy/ssh-action/issues/332)) ([@&#8203;astralwaveio](https://github.com/astralwaveio))

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC44MC4wIiwidXBkYXRlZEluVmVyIjoiMzguODAuMCIsInRhcmdldEJyYW5jaCI6ImRldmVsb3AiLCJsYWJlbHMiOltdfQ==-->

Reviewed-on: #482
Reviewed-by: Vylpes <ethan@vylpes.com>
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-10-28 11:27:39 +00:00
1aca8c7b60 Update dependency @types/node to v22.8.1 (#480)
All checks were successful
Deploy To Stage / build (push) Successful in 8s
Deploy To Stage / deploy (push) Successful in 15s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node) ([source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node)) | devDependencies | minor | [`22.5.5` -> `22.8.1`](https://renovatebot.com/diffs/npm/@types%2fnode/22.5.5/22.8.1) |

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC44MC4wIiwidXBkYXRlZEluVmVyIjoiMzguODAuMCIsInRhcmdldEJyYW5jaCI6ImRldmVsb3AiLCJsYWJlbHMiOltdfQ==-->

Reviewed-on: #480
Reviewed-by: Vylpes <ethan@vylpes.com>
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-10-28 11:26:25 +00:00
b81f607702 Merge branch 'main' into develop
All checks were successful
Deploy To Stage / build (push) Successful in 10s
Deploy To Stage / deploy (push) Successful in 15s
2024-10-18 18:12:07 +01:00
06eb7dbbb1 Update dependency typescript to v5.6.2 (#476)
All checks were successful
Deploy To Stage / build (push) Successful in 6s
Deploy To Stage / deploy (push) Successful in 17s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [typescript](https://www.typescriptlang.org/) ([source](https://github.com/microsoft/TypeScript)) | devDependencies | minor | [`5.5.4` -> `5.6.2`](https://renovatebot.com/diffs/npm/typescript/5.5.4/5.6.2) |

---

### Release Notes

<details>
<summary>microsoft/TypeScript (typescript)</summary>

### [`v5.6.2`](https://github.com/microsoft/TypeScript/releases/tag/v5.6.2): TypeScript 5.6

[Compare Source](https://github.com/microsoft/TypeScript/compare/v5.5.4...v5.6.2)

For release notes, check out the [release announcement](https://devblogs.microsoft.com/typescript/announcing-typescript-5-6/).

For the complete list of fixed issues, check out the

-   [fixed issues query for Typescript 5.6.0 (Beta)](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93\&q=milestone%3A%22TypeScript+5.6.0%22+is%3Aclosed+).
-   [fixed issues query for Typescript 5.6.1 (RC)](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93\&q=milestone%3A%22TypeScript+5.6.1%22+is%3Aclosed+).
-   [fixed issues query for Typescript 5.6.2 (Stable)](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93\&q=milestone%3A%22TypeScript+5.6.2%22+is%3Aclosed+).

Downloads are available on:

-   [npm](https://www.npmjs.com/package/typescript)
-   [NuGet package](https://www.nuget.org/packages/Microsoft.TypeScript.MSBuild)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC44MC4wIiwidXBkYXRlZEluVmVyIjoiMzguODAuMCIsInRhcmdldEJyYW5jaCI6ImRldmVsb3AiLCJsYWJlbHMiOltdfQ==-->

Reviewed-on: #476
Reviewed-by: Vylpes <ethan@vylpes.com>
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-09-23 18:01:46 +01:00
3f04286eac Update dependency @types/jest to v29.5.13 (#475)
All checks were successful
Deploy To Stage / build (push) Successful in 6s
Deploy To Stage / deploy (push) Successful in 17s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@types/jest](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jest) ([source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/jest)) | devDependencies | patch | [`29.5.12` -> `29.5.13`](https://renovatebot.com/diffs/npm/@types%2fjest/29.5.12/29.5.13) |

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC44MC4wIiwidXBkYXRlZEluVmVyIjoiMzguODAuMCIsInRhcmdldEJyYW5jaCI6ImRldmVsb3AiLCJsYWJlbHMiOltdfQ==-->

Reviewed-on: #475
Reviewed-by: Vylpes <ethan@vylpes.com>
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-09-23 18:00:40 +01:00
bc349c838a Update dependency @discordjs/rest to v2.4.0 (#473)
All checks were successful
Deploy To Stage / build (push) Successful in 6s
Deploy To Stage / deploy (push) Successful in 16s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@discordjs/rest](https://discord.js.org) ([source](https://github.com/discordjs/discord.js/tree/HEAD/packages/rest)) | dependencies | minor | [`2.3.0` -> `2.4.0`](https://renovatebot.com/diffs/npm/@discordjs%2frest/2.3.0/2.4.0) |

---

### Release Notes

<details>
<summary>discordjs/discord.js (@&#8203;discordjs/rest)</summary>

### [`v2.4.0`](https://github.com/discordjs/discord.js/blob/HEAD/packages/rest/CHANGELOG.md#discordjsrest240---2024-09-01)

[Compare Source](https://github.com/discordjs/discord.js/compare/@discordjs/rest@2.3.0...@discordjs/rest@2.4.0)

#### Bug Fixes

-   Correct base path for GIF stickers ([#&#8203;10330](https://github.com/discordjs/discord.js/issues/10330)) ([599ad3e](599ad3eab5))

#### Features

-   **User:** Add `avatarDecorationData` ([#&#8203;9888](https://github.com/discordjs/discord.js/issues/9888)) ([3b5c600](3b5c600b9e))

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MzEuNCIsInVwZGF0ZWRJblZlciI6IjM4LjgwLjAiLCJ0YXJnZXRCcmFuY2giOiJkZXZlbG9wIiwibGFiZWxzIjpbXX0=-->

Reviewed-on: #473
Reviewed-by: Vylpes <ethan@vylpes.com>
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-09-23 17:59:25 +01:00
bf50aa6ed9 Update dependency emoji-regex to v10.4.0 (#472)
All checks were successful
Deploy To Stage / build (push) Successful in 6s
Deploy To Stage / deploy (push) Successful in 19s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [emoji-regex](https://mths.be/emoji-regex) ([source](https://github.com/mathiasbynens/emoji-regex)) | dependencies | minor | [`10.3.0` -> `10.4.0`](https://renovatebot.com/diffs/npm/emoji-regex/10.3.0/10.4.0) |

---

### Release Notes

<details>
<summary>mathiasbynens/emoji-regex (emoji-regex)</summary>

### [`v10.4.0`](https://github.com/mathiasbynens/emoji-regex/compare/v10.3.0...v10.4.0)

[Compare Source](https://github.com/mathiasbynens/emoji-regex/compare/v10.3.0...v10.4.0)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MzEuNCIsInVwZGF0ZWRJblZlciI6IjM4LjgwLjAiLCJ0YXJnZXRCcmFuY2giOiJkZXZlbG9wIiwibGFiZWxzIjpbXX0=-->

Reviewed-on: #472
Reviewed-by: Vylpes <ethan@vylpes.com>
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-09-23 17:58:25 +01:00
36d6cf91cf Add ability to add a moon to your count (#477)
All checks were successful
Deploy To Stage / build (push) Successful in 8s
Deploy To Stage / deploy (push) Successful in 17s
- Add the ability to add moons to your count
- Moved the moon entity to its server id folder to be more consistent

#196

Reviewed-on: #477
Reviewed-by: VylpesTester <tester@vylpes.com>
Co-authored-by: Ethan Lane <ethan@vylpes.com>
Co-committed-by: Ethan Lane <ethan@vylpes.com>
2024-09-21 16:12:19 +01:00
612ac0e012 Update dependency ts-jest to v29.2.5 (#471)
All checks were successful
Deploy To Stage / build (push) Successful in 6s
Deploy To Stage / deploy (push) Successful in 17s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [ts-jest](https://kulshekhar.github.io/ts-jest) ([source](https://github.com/kulshekhar/ts-jest)) | devDependencies | patch | [`29.2.4` -> `29.2.5`](https://renovatebot.com/diffs/npm/ts-jest/29.2.4/29.2.5) |

---

### Release Notes

<details>
<summary>kulshekhar/ts-jest (ts-jest)</summary>

### [`v29.2.5`](https://github.com/kulshekhar/ts-jest/blob/HEAD/CHANGELOG.md#2925-2024-08-23)

[Compare Source](https://github.com/kulshekhar/ts-jest/compare/v29.2.4...v29.2.5)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MzEuNCIsInVwZGF0ZWRJblZlciI6IjM3LjQzMS40IiwidGFyZ2V0QnJhbmNoIjoiZGV2ZWxvcCIsImxhYmVscyI6W119-->

Reviewed-on: #471
Reviewed-by: Vylpes <ethan@vylpes.com>
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-09-16 18:11:37 +01:00
dc90a7b4be Update dependency @types/node to v22.5.5 (#470)
All checks were successful
Deploy To Stage / build (push) Successful in 7s
Deploy To Stage / deploy (push) Successful in 14s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node) ([source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node)) | devDependencies | minor | [`22.2.0` -> `22.5.5`](https://renovatebot.com/diffs/npm/@types%2fnode/22.2.0/22.5.5) |

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MzEuNCIsInVwZGF0ZWRJblZlciI6IjM4LjgwLjAiLCJ0YXJnZXRCcmFuY2giOiJkZXZlbG9wIiwibGFiZWxzIjpbXX0=-->

Reviewed-on: #470
Reviewed-by: Vylpes <ethan@vylpes.com>
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-09-16 18:09:25 +01:00
400a3bb5a2 Attempt to create dms to the user a moderation action was taken on (#469)
All checks were successful
Deploy To Stage / build (push) Successful in 6s
Deploy To Stage / deploy (push) Successful in 14s
- Attempt to create a dm to the user a moderation action was taken on
- If unable to dm, put a message onto the reply text to say the bot couldn't

#255

Reviewed-on: #469
Reviewed-by: VylpesTester <tester@vylpes.com>
Co-authored-by: Ethan Lane <ethan@vylpes.com>
Co-committed-by: Ethan Lane <ethan@vylpes.com>
2024-08-17 16:56:32 +01:00
674a4ac614 Fix typo in moon sql script
All checks were successful
Deploy To Stage / build (push) Successful in 6s
Deploy To Stage / deploy (push) Successful in 15s
2024-08-17 16:54:11 +01:00
e2ec042fcd Add list moons command (#449)
Some checks failed
Deploy To Stage / build (push) Successful in 6s
Deploy To Stage / deploy (push) Failing after 16s
- Add concept of moons to the database
- Add the list moons command to view a user's moons
- This command is paginated using buttons

#195

Reviewed-on: #449
Reviewed-by: VylpesTester <tester@vylpes.com>
Co-authored-by: Ethan Lane <ethan@vylpes.com>
Co-committed-by: Ethan Lane <ethan@vylpes.com>
2024-08-17 16:47:14 +01:00
8e87fd6618 Update dependency random-bunny to v2.3.0 (#466)
All checks were successful
Deploy To Stage / build (push) Successful in 5s
Deploy To Stage / deploy (push) Successful in 17s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [random-bunny](https://gitea.vylpes.xyz/RabbitLabs/random-bunny) | dependencies | minor | [`2.2.0` -> `2.3.0`](https://renovatebot.com/diffs/npm/random-bunny/2.2.0/2.3.0) |

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MzEuNCIsInVwZGF0ZWRJblZlciI6IjM3LjQzMS40IiwidGFyZ2V0QnJhbmNoIjoiZGV2ZWxvcCIsImxhYmVscyI6W119-->

Reviewed-on: #466
Reviewed-by: Vylpes <ethan@vylpes.com>
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-08-12 16:09:38 +01:00
d64f42ba3e Update dependency @types/node to v22 (#460)
All checks were successful
Deploy To Stage / build (push) Successful in 6s
Deploy To Stage / deploy (push) Successful in 16s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node) ([source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node)) | devDependencies | major | [`^20.0.0` -> `^22.0.0`](https://renovatebot.com/diffs/npm/@types%2fnode/20.14.14/22.2.0) |

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MzEuNCIsInVwZGF0ZWRJblZlciI6IjM3LjQzMS40IiwidGFyZ2V0QnJhbmNoIjoiZGV2ZWxvcCIsImxhYmVscyI6W119-->

Reviewed-on: #460
Reviewed-by: Vylpes <ethan@vylpes.com>
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-08-12 16:08:25 +01:00
da7e94c199 Move jest dependencies to be a dev dependency (#464)
All checks were successful
Deploy To Stage / build (push) Successful in 6s
Deploy To Stage / deploy (push) Successful in 17s
- Remove jest packages from being a main dependency and made them a dev dependency

#281

Reviewed-on: #464
Reviewed-by: VylpesTester <tester@vylpes.com>
Co-authored-by: Ethan Lane <ethan@vylpes.com>
Co-committed-by: Ethan Lane <ethan@vylpes.com>
2024-08-10 15:16:58 +01:00
6fa462608e Remove the mute and unmute commands (#462)
All checks were successful
Deploy To Stage / build (push) Successful in 7s
Deploy To Stage / deploy (push) Successful in 18s
- Remove the mute and unmute commands
- Remove the mention of the mute role in the config help

#254

Reviewed-on: #462
Reviewed-by: VylpesTester <tester@vylpes.com>
Co-authored-by: Ethan Lane <ethan@vylpes.com>
Co-committed-by: Ethan Lane <ethan@vylpes.com>
2024-08-10 15:15:19 +01:00
0505c8a77c Update dependency np to v10.0.7 (#456)
All checks were successful
Deploy To Stage / build (push) Successful in 6s
Deploy To Stage / deploy (push) Successful in 17s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [np](https://github.com/sindresorhus/np) | devDependencies | patch | [`10.0.6` -> `10.0.7`](https://renovatebot.com/diffs/npm/np/10.0.6/10.0.7) |

---

### Release Notes

<details>
<summary>sindresorhus/np (np)</summary>

### [`v10.0.7`](https://github.com/sindresorhus/np/releases/tag/v10.0.7)

[Compare Source](https://github.com/sindresorhus/np/compare/v10.0.6...v10.0.7)

-   Allow `publishConfig.registry` to be npm default registry when using Yarn berry ([#&#8203;750](https://github.com/sindresorhus/np/issues/750))  [`6c5eee3`](https://github.com/sindresorhus/np/commit/6c5eee3)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MzEuNCIsInVwZGF0ZWRJblZlciI6IjM3LjQzMS40IiwidGFyZ2V0QnJhbmNoIjoiZGV2ZWxvcCIsImxhYmVscyI6W119-->

Reviewed-on: #456
Reviewed-by: Vylpes <ethan@vylpes.com>
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-08-05 18:27:54 +01:00
a09e734eea Update appleboy/ssh-action action to v1.0.3 (#454)
All checks were successful
Deploy To Stage / build (push) Successful in 6s
Deploy To Stage / deploy (push) Successful in 17s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [appleboy/ssh-action](https://github.com/appleboy/ssh-action) | action | patch | `v1.0.0` -> `v1.0.3` |

---

### Release Notes

<details>
<summary>appleboy/ssh-action (appleboy/ssh-action)</summary>

### [`v1.0.3`](https://github.com/appleboy/ssh-action/releases/tag/v1.0.3)

[Compare Source](https://github.com/appleboy/ssh-action/compare/v1.0.2...v1.0.3)

-   Support the new parameter `request_pty` to request a pseudo-terminal from the server, addressing the sudo command issue. https://github.com/appleboy/ssh-action/pull/288

### [`v1.0.2`](https://github.com/appleboy/ssh-action/releases/tag/v1.0.2)

[Compare Source](https://github.com/appleboy/ssh-action/compare/v1.0.1...v1.0.2)

upgrade ssh-proxy for security patch

### [`v1.0.1`](https://github.com/appleboy/ssh-action/releases/tag/v1.0.1): for security patch

[Compare Source](https://github.com/appleboy/ssh-action/compare/v1.0.0...v1.0.1)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MzEuNCIsInVwZGF0ZWRJblZlciI6IjM3LjQzMS40IiwidGFyZ2V0QnJhbmNoIjoiZGV2ZWxvcCIsImxhYmVscyI6W119-->

Reviewed-on: #454
Reviewed-by: Vylpes <ethan@vylpes.com>
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-08-05 18:25:25 +01:00
8fd4ef4cc6 Update dependency typescript to v5.5.4 (#453)
All checks were successful
Deploy To Stage / build (push) Successful in 6s
Deploy To Stage / deploy (push) Successful in 17s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [typescript](https://www.typescriptlang.org/) ([source](https://github.com/Microsoft/TypeScript)) | devDependencies | patch | [`5.5.2` -> `5.5.4`](https://renovatebot.com/diffs/npm/typescript/5.5.2/5.5.4) |

---

### Release Notes

<details>
<summary>Microsoft/TypeScript (typescript)</summary>

### [`v5.5.4`](https://github.com/microsoft/TypeScript/releases/tag/v5.5.4): TypeScript 5.5.4

[Compare Source](https://github.com/Microsoft/TypeScript/compare/v5.5.3...v5.5.4)

For release notes, check out the [release announcement](https://devblogs.microsoft.com/typescript/announcing-typescript-5-5/).

For the complete list of fixed issues, check out the

-   [fixed issues query for TypeScript v5.5.4 (Stable)](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93\&q=is%3Aissue+milestone%3A%22TypeScript+5.5.4%22+is%3Aclosed+).
-   [fixed issues query for TypeScript v5.5.3 (Stable)](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93\&q=is%3Aissue+milestone%3A%22TypeScript+5.5.3%22+is%3Aclosed+).
-   [fixed issues query for TypeScript v5.5.2 (Stable)](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93\&q=is%3Aissue+milestone%3A%22TypeScript+5.5.2%22+is%3Aclosed+).
-   [fixed issues query for TypeScript v5.5.1 (RC)](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93\&q=is%3Aissue+milestone%3A%22TypeScript+5.5.1%22+is%3Aclosed+).
-   [fixed issues query for TypeScript v5.5.0 (Beta)](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93\&q=is%3Aissue+milestone%3A%22TypeScript+5.5.0%22+is%3Aclosed+).

Downloads are available on:

-   [npm](https://www.npmjs.com/package/typescript)
-   [NuGet package](https://www.nuget.org/packages/Microsoft.TypeScript.MSBuild) (soon!)

### [`v5.5.3`](https://github.com/microsoft/TypeScript/releases/tag/v5.5.3): TypeScript 5.5.3

[Compare Source](https://github.com/Microsoft/TypeScript/compare/v5.5.2...v5.5.3)

For release notes, check out the [release announcement](https://devblogs.microsoft.com/typescript/announcing-typescript-5-5/).

For the complete list of fixed issues, check out the

-   [fixed issues query for TypeScript v5.5.3 (Stable)](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93\&q=is%3Aissue+milestone%3A%22TypeScript+5.5.3%22+is%3Aclosed+).
-   [fixed issues query for TypeScript v5.5.2 (Stable)](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93\&q=is%3Aissue+milestone%3A%22TypeScript+5.5.2%22+is%3Aclosed+).
-   [fixed issues query for TypeScript v5.5.1 (RC)](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93\&q=is%3Aissue+milestone%3A%22TypeScript+5.5.1%22+is%3Aclosed+).
-   [fixed issues query for TypeScript v5.5.0 (Beta)](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93\&q=is%3Aissue+milestone%3A%22TypeScript+5.5.0%22+is%3Aclosed+).

Downloads are available on:

-   [npm](https://www.npmjs.com/package/typescript)
-   [NuGet package](https://www.nuget.org/packages/Microsoft.TypeScript.MSBuild)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjAiLCJ1cGRhdGVkSW5WZXIiOiIzNy40MzEuNCIsInRhcmdldEJyYW5jaCI6ImRldmVsb3AifQ==-->

Reviewed-on: #453
Reviewed-by: Vylpes <ethan@vylpes.com>
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-08-05 18:23:20 +01:00
cadf47b1e9 Update dependency @types/node to v20.14.14 (#452)
All checks were successful
Deploy To Stage / build (push) Successful in 7s
Deploy To Stage / deploy (push) Successful in 15s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node) ([source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node)) | devDependencies | patch | [`20.14.9` -> `20.14.14`](https://renovatebot.com/diffs/npm/@types%2fnode/20.14.9/20.14.14) |

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjAiLCJ1cGRhdGVkSW5WZXIiOiIzNy40MzEuNCIsInRhcmdldEJyYW5jaCI6ImRldmVsb3AifQ==-->

Reviewed-on: #452
Reviewed-by: Vylpes <ethan@vylpes.com>
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-08-05 18:21:37 +01:00
76c2461efd Remove existing tests (#451)
All checks were successful
Deploy To Stage / build (push) Successful in 6s
Deploy To Stage / deploy (push) Successful in 15s
- Remove existing tests
- Want to start fresh as these are failed and quite frankly too in-depth to be maintainable

#450

Reviewed-on: #451
Reviewed-by: VylpesTester <tester@vylpes.com>
Co-authored-by: Ethan Lane <ethan@vylpes.com>
Co-committed-by: Ethan Lane <ethan@vylpes.com>
2024-07-06 19:09:41 +01:00
2b35629506 Update dependency @types/uuid to v10 (#448)
All checks were successful
Deploy To Stage / build (push) Successful in 5s
Deploy To Stage / deploy (push) Successful in 17s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@types/uuid](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/uuid) ([source](https://github.com/DefinitelyTyped/DefinitelyTyped)) | dependencies | major | [`^9.0.0` -> `^10.0.0`](https://renovatebot.com/diffs/npm/@types%2fuuid/9.0.8/10.0.0) |

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjAiLCJ1cGRhdGVkSW5WZXIiOiIzNy4wLjAiLCJ0YXJnZXRCcmFuY2giOiJkZXZlbG9wIn0=-->

Reviewed-on: #448
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-07-01 15:07:06 +01:00
0ce9ff5453 Update dependency minimatch to v9.0.5 (#447)
All checks were successful
Deploy To Stage / build (push) Successful in 6s
Deploy To Stage / deploy (push) Successful in 14s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [minimatch](https://github.com/isaacs/minimatch) | dependencies | patch | [`9.0.4` -> `9.0.5`](https://renovatebot.com/diffs/npm/minimatch/9.0.4/9.0.5) |

---

### Release Notes

<details>
<summary>isaacs/minimatch (minimatch)</summary>

### [`v9.0.5`](https://github.com/isaacs/minimatch/compare/v9.0.4...v9.0.5)

[Compare Source](https://github.com/isaacs/minimatch/compare/v9.0.4...v9.0.5)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjAiLCJ1cGRhdGVkSW5WZXIiOiIzNy4wLjAiLCJ0YXJnZXRCcmFuY2giOiJkZXZlbG9wIn0=-->

Reviewed-on: #447
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-07-01 15:06:34 +01:00
b1afc79dda Add say command (#446)
All checks were successful
Deploy To Stage / build (push) Successful in 5s
Deploy To Stage / deploy (push) Successful in 15s
- Add `/say` command to let the bot reply with a message
- Migrate to yarn

#19

Reviewed-on: #446
Reviewed-by: VylpesTester <tester@vylpes.com>
Co-authored-by: Ethan Lane <ethan@vylpes.com>
Co-committed-by: Ethan Lane <ethan@vylpes.com>
2024-06-29 18:26:25 +01:00
7ccfa34562 Update dependency typescript to v5.5.2 (#440)
All checks were successful
Deploy To Stage / build (push) Successful in 7s
Deploy To Stage / deploy (push) Successful in 17s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [typescript](https://www.typescriptlang.org/) ([source](https://github.com/Microsoft/TypeScript)) | devDependencies | minor | [`5.4.5` -> `5.5.2`](https://renovatebot.com/diffs/npm/typescript/5.4.5/5.5.2) |

---

### Release Notes

<details>
<summary>Microsoft/TypeScript (typescript)</summary>

### [`v5.5.2`](https://github.com/microsoft/TypeScript/releases/tag/v5.5.2): TypeScript 5.5

[Compare Source](https://github.com/Microsoft/TypeScript/compare/v5.4.5...v5.5.2)

For release notes, check out the [release announcement](https://devblogs.microsoft.com/typescript/announcing-typescript-5-5/).

For the complete list of fixed issues, check out the

-   [fixed issues query for TypeScript v5.5.2 (Stable)](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93\&q=is%3Aissue+milestone%3A%22TypeScript+5.5.2%22+is%3Aclosed+).
-   [fixed issues query for TypeScript v5.5.1 (RC)](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93\&q=is%3Aissue+milestone%3A%22TypeScript+5.5.1%22+is%3Aclosed+).
-   [fixed issues query for TypeScript v5.5.0 (Beta)](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93\&q=is%3Aissue+milestone%3A%22TypeScript+5.5.0%22+is%3Aclosed+).

Downloads are available on:

-   [npm](https://www.npmjs.com/package/typescript)
-   [NuGet package](https://www.nuget.org/packages/Microsoft.TypeScript.MSBuild)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjAiLCJ1cGRhdGVkSW5WZXIiOiIzNy4wLjAiLCJ0YXJnZXRCcmFuY2giOiJkZXZlbG9wIn0=-->

Reviewed-on: #440
Reviewed-by: Vylpes <ethan@vylpes.com>
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-06-24 18:54:35 +01:00
f1c7cdc6d6 Update dependency np to v10.0.6 (#439)
All checks were successful
Deploy To Stage / build (push) Successful in 7s
Deploy To Stage / deploy (push) Successful in 17s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [np](https://github.com/sindresorhus/np) | devDependencies | patch | [`10.0.5` -> `10.0.6`](https://renovatebot.com/diffs/npm/np/10.0.5/10.0.6) |

---

### Release Notes

<details>
<summary>sindresorhus/np (np)</summary>

### [`v10.0.6`](https://github.com/sindresorhus/np/releases/tag/v10.0.6)

[Compare Source](https://github.com/sindresorhus/np/compare/v10.0.5...v10.0.6)

-   Fix usage with `pnpm` and `--any-branch` or `--branch` ([#&#8203;745](https://github.com/sindresorhus/np/issues/745))  [`d0c1493`](https://github.com/sindresorhus/np/commit/d0c1493)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjAiLCJ1cGRhdGVkSW5WZXIiOiIzNy4wLjAiLCJ0YXJnZXRCcmFuY2giOiJkZXZlbG9wIn0=-->

Reviewed-on: #439
Reviewed-by: Vylpes <ethan@vylpes.com>
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-06-24 18:53:52 +01:00
1371a30eee Update dependency ts-jest to v29.1.5 (#438)
All checks were successful
Deploy To Stage / build (push) Successful in 7s
Deploy To Stage / deploy (push) Successful in 16s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [ts-jest](https://kulshekhar.github.io/ts-jest) ([source](https://github.com/kulshekhar/ts-jest)) | dependencies | patch | [`29.1.2` -> `29.1.5`](https://renovatebot.com/diffs/npm/ts-jest/29.1.2/29.1.5) |

---

### Release Notes

<details>
<summary>kulshekhar/ts-jest (ts-jest)</summary>

### [`v29.1.5`](https://github.com/kulshekhar/ts-jest/blob/HEAD/CHANGELOG.md#2915-2024-06-16)

[Compare Source](https://github.com/kulshekhar/ts-jest/compare/v29.1.4...v29.1.5)

##### Bug Fixes

-   build(deps-dev): bump braces ([5560334](https://github.com/kulshekhar/ts-jest/commit/5560334)), ([59026b4](https://github.com/kulshekhar/ts-jest/commit/59026b4)), ([0d9e359](https://github.com/kulshekhar/ts-jest/commit/0d9e359))

### [`v29.1.4`](https://github.com/kulshekhar/ts-jest/blob/HEAD/CHANGELOG.md#2914-2024-05-28)

[Compare Source](https://github.com/kulshekhar/ts-jest/compare/v29.1.3...v29.1.4)

##### Bug Fixes

-   fix(transformer): allow transforming of .cts/.mts extensions. ([b8f6eaa](https://github.com/kulshekhar/ts-jest/commit/b8f6eaa)), closes [#&#8203;3996](https://github.com/kulshekhar/ts-jest/issues/3996)

##### Features

-   feat: make cli generate esm config based on `type: "module"` ([81a5f64](https://github.com/kulshekhar/ts-jest/commit/81a5f64)), closes [#&#8203;4210](https://github.com/kulshekhar/ts-jest/issues/4210) [#&#8203;4012](https://github.com/kulshekhar/ts-jest/issues/4012)

### [`v29.1.3`](https://github.com/kulshekhar/ts-jest/blob/HEAD/CHANGELOG.md#2913-2024-05-21)

[Compare Source](https://github.com/kulshekhar/ts-jest/compare/v29.1.2...v29.1.3)

##### Bug Fixes

-   add `@jest/transform` as an optional peer dependency ([0ba7f86](0ba7f861c3))
-   bring back Node 14 support ([eda56a7](eda56a7797))

##### Performance Improvements

-   remove ts resolved module cache file ([4c88da5](4c88da5899))

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjAiLCJ1cGRhdGVkSW5WZXIiOiIzNy4wLjAiLCJ0YXJnZXRCcmFuY2giOiJkZXZlbG9wIn0=-->

Reviewed-on: #438
Reviewed-by: Vylpes <ethan@vylpes.com>
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-06-24 18:53:05 +01:00
34398e5657 Update actions/setup-node action to v4 (#437)
All checks were successful
Deploy To Stage / build (push) Successful in 7s
Deploy To Stage / deploy (push) Successful in 16s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [actions/setup-node](https://github.com/actions/setup-node) | action | major | `v1` -> `v4` |

---

### Release Notes

<details>
<summary>actions/setup-node (actions/setup-node)</summary>

### [`v4`](https://github.com/actions/setup-node/compare/v3...v4)

[Compare Source](https://github.com/actions/setup-node/compare/v3...v4)

### [`v3`](https://github.com/actions/setup-node/compare/v2...v3)

[Compare Source](https://github.com/actions/setup-node/compare/v2...v3)

### [`v2`](https://github.com/actions/setup-node/compare/v1...v2)

[Compare Source](https://github.com/actions/setup-node/compare/v1...v2)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjAiLCJ1cGRhdGVkSW5WZXIiOiIzNy4wLjAiLCJ0YXJnZXRCcmFuY2giOiJkZXZlbG9wIn0=-->

Reviewed-on: #437
Reviewed-by: Vylpes <ethan@vylpes.com>
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-06-24 18:52:23 +01:00
cd0737cf3b Update dependency @discordjs/rest to v2.3.0 (#435)
All checks were successful
Deploy To Stage / build (push) Successful in 7s
Deploy To Stage / deploy (push) Successful in 15s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@discordjs/rest](https://discord.js.org) ([source](https://github.com/discordjs/discord.js)) | dependencies | minor | [`2.2.0` -> `2.3.0`](https://renovatebot.com/diffs/npm/@discordjs%2frest/2.2.0/2.3.0) |

---

### Release Notes

<details>
<summary>discordjs/discord.js (@&#8203;discordjs/rest)</summary>

### [`v2.3.0`](https://github.com/discordjs/discord.js/blob/HEAD/packages/rest/CHANGELOG.md#discordjsrest230---2024-05-04)

[Compare Source](https://github.com/discordjs/discord.js/compare/@discordjs/rest@2.2.0...@discordjs/rest@2.3.0)

#### Bug Fixes

-   Anchor link for events ([0efd1be](0efd1bea46))

#### Documentation

-   Split docs.api.json into multiple json files ([597340f](597340f288))
-   Remove hyphen after `@returns` ([#&#8203;9989](https://github.com/discordjs/discord.js/issues/9989)) ([e9ff991](e9ff99101b))

#### Features

-   Local and preview detection ([79fbda3](79fbda3aac))
-   **REST:** Dynamic rate limit offsets ([#&#8203;10099](https://github.com/discordjs/discord.js/issues/10099)) ([278396e](278396e815))

#### Refactor

-   Docs ([#&#8203;10126](https://github.com/discordjs/discord.js/issues/10126)) ([18cce83](18cce83d80))
-   Use interfaces for AsyncEventEmitter event maps ([#&#8203;10044](https://github.com/discordjs/discord.js/issues/10044)) ([adfd9cd](adfd9cd3b3))

#### Styling

-   Fix up lint ([d869d9b](d869d9b3fe))

#### Testing

-   Skip flaky rest test ([#&#8203;10234](https://github.com/discordjs/discord.js/issues/10234)) ([dc8f149](dc8f14967c))

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjAiLCJ1cGRhdGVkSW5WZXIiOiIzNy4wLjAiLCJ0YXJnZXRCcmFuY2giOiJkZXZlbG9wIn0=-->

Reviewed-on: #435
Reviewed-by: Vylpes <ethan@vylpes.com>
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-06-24 18:51:01 +01:00
5f22a31398 Update dependency @types/node to v20.14.8 (#434)
All checks were successful
Deploy To Stage / build (push) Successful in 8s
Deploy To Stage / deploy (push) Successful in 15s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node) ([source](https://github.com/DefinitelyTyped/DefinitelyTyped)) | devDependencies | minor | [`20.12.8` -> `20.14.8`](https://renovatebot.com/diffs/npm/@types%2fnode/20.12.8/20.14.8) |

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjAiLCJ1cGRhdGVkSW5WZXIiOiIzNy4wLjAiLCJ0YXJnZXRCcmFuY2giOiJkZXZlbG9wIn0=-->

Reviewed-on: #434
Reviewed-by: Vylpes <ethan@vylpes.com>
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-06-24 18:50:03 +01:00
932d3ac3d5 Update dependency jest-mock-extended to v3.0.7 (#432)
All checks were successful
Deploy To Stage / build (push) Successful in 7s
Deploy To Stage / deploy (push) Successful in 14s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [jest-mock-extended](https://github.com/marchaos/jest-mock-extended) | dependencies | patch | [`3.0.6` -> `3.0.7`](https://renovatebot.com/diffs/npm/jest-mock-extended/3.0.6/3.0.7) |

---

### Release Notes

<details>
<summary>marchaos/jest-mock-extended (jest-mock-extended)</summary>

### [`v3.0.7`](https://github.com/marchaos/jest-mock-extended/releases/tag/3.0.7)

[Compare Source](77a64ae832...3.0.7)

Bumped ts-essentials

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjAiLCJ1cGRhdGVkSW5WZXIiOiIzNy4wLjAiLCJ0YXJnZXRCcmFuY2giOiJkZXZlbG9wIn0=-->

Reviewed-on: #432
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-05-06 16:11:58 +01:00
6412ad0ad4 Update dependency @types/node to v20.12.8 (#431)
All checks were successful
Deploy To Stage / build (push) Successful in 10s
Deploy To Stage / deploy (push) Successful in 15s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node) ([source](https://github.com/DefinitelyTyped/DefinitelyTyped)) | devDependencies | patch | [`20.12.7` -> `20.12.8`](https://renovatebot.com/diffs/npm/@types%2fnode/20.12.7/20.12.8) |

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjAiLCJ1cGRhdGVkSW5WZXIiOiIzNy4wLjAiLCJ0YXJnZXRCcmFuY2giOiJkZXZlbG9wIn0=-->

Reviewed-on: #431
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-05-06 16:11:17 +01:00
f1c513bd16 Update actions/checkout action to v4 (#430)
All checks were successful
Deploy To Stage / build (push) Successful in 7s
Deploy To Stage / deploy (push) Successful in 16s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [actions/checkout](https://github.com/actions/checkout) | action | major | `v2` -> `v4` |

---

### Release Notes

<details>
<summary>actions/checkout (actions/checkout)</summary>

### [`v4`](https://github.com/actions/checkout/blob/HEAD/CHANGELOG.md#v414)

[Compare Source](https://github.com/actions/checkout/compare/v3...v4)

-   Disable `extensions.worktreeConfig` when disabling `sparse-checkout` by [@&#8203;jww3](https://github.com/jww3) in https://github.com/actions/checkout/pull/1692
-   Add dependabot config by [@&#8203;cory-miller](https://github.com/cory-miller) in https://github.com/actions/checkout/pull/1688
-   Bump the minor-actions-dependencies group with 2 updates by [@&#8203;dependabot](https://github.com/dependabot) in https://github.com/actions/checkout/pull/1693
-   Bump word-wrap from 1.2.3 to 1.2.5 by [@&#8203;dependabot](https://github.com/dependabot) in https://github.com/actions/checkout/pull/1643

### [`v3`](https://github.com/actions/checkout/blob/HEAD/CHANGELOG.md#v360)

[Compare Source](https://github.com/actions/checkout/compare/v2...v3)

-   [Fix: Mark test scripts with Bash'isms to be run via Bash](https://github.com/actions/checkout/pull/1377)
-   [Add option to fetch tags even if fetch-depth > 0](https://github.com/actions/checkout/pull/579)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjAiLCJ1cGRhdGVkSW5WZXIiOiIzNy4wLjAiLCJ0YXJnZXRCcmFuY2giOiJkZXZlbG9wIn0=-->

Reviewed-on: #430
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-04-29 17:51:22 +01:00
942fea12bf Update dependency minimatch to v9.0.4 (#422)
All checks were successful
Deploy To Stage / build (push) Successful in 7s
Deploy To Stage / deploy (push) Successful in 15s
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [minimatch](https://github.com/isaacs/minimatch) | dependencies | patch | [`9.0.3` -> `9.0.4`](https://renovatebot.com/diffs/npm/minimatch/9.0.3/9.0.4) |

---

### Release Notes

<details>
<summary>isaacs/minimatch (minimatch)</summary>

### [`v9.0.4`](https://github.com/isaacs/minimatch/compare/v9.0.3...v9.0.4)

[Compare Source](https://github.com/isaacs/minimatch/compare/v9.0.3...v9.0.4)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjAiLCJ1cGRhdGVkSW5WZXIiOiIzNy4wLjAiLCJ0YXJnZXRCcmFuY2giOiJkZXZlbG9wIn0=-->

Reviewed-on: #422
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-04-29 17:50:11 +01:00
56 changed files with 1516 additions and 9400 deletions

View file

@ -7,7 +7,7 @@
# any secret values.
BOT_TOKEN=
BOT_VER=3.2.3
BOT_VER=3.3.0
BOT_AUTHOR=Vylpes
BOT_OWNERID=147392775707426816
BOT_CLIENTID=682942374040961060
@ -24,3 +24,5 @@ DB_AUTH_USER=dev
DB_AUTH_PASS=dev
DB_SYNC=true
DB_LOGGING=true
DB_ROOT_HOST=0.0.0.0
DB_DATA_LOCATION=./.temp/database

View file

@ -12,11 +12,11 @@ jobs:
runs-on: node
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: Use Node.js
uses: actions/setup-node@v1
uses: actions/setup-node@v4
with:
node-version: 18.x
node-version: 20.x
- run: yarn install --frozen-lockfile
- run: yarn build
- run: yarn test
@ -29,7 +29,7 @@ jobs:
needs: build
runs-on: node
steps:
- uses: https://github.com/appleboy/ssh-action@v1.0.0
- uses: https://github.com/appleboy/ssh-action@v1.1.0
env:
DB_NAME: ${{ secrets.PROD_DB_NAME }}
DB_AUTH_USER: ${{ secrets.PROD_DB_AUTH_USER }}

View file

@ -12,11 +12,11 @@ jobs:
runs-on: node
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: Use Node.js
uses: actions/setup-node@v1
uses: actions/setup-node@v4
with:
node-version: 18.x
node-version: 20.x
- run: yarn install --frozen-lockfile
- run: yarn build
- run: yarn test
@ -29,7 +29,7 @@ jobs:
needs: build
runs-on: node
steps:
- uses: https://github.com/appleboy/ssh-action@v1.0.0
- uses: https://github.com/appleboy/ssh-action@v1.1.0
env:
DB_NAME: ${{ secrets.STAGE_DB_NAME }}
DB_AUTH_USER: ${{ secrets.STAGE_DB_AUTH_USER }}

View file

@ -14,11 +14,11 @@ jobs:
runs-on: node
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: Use Node.js
uses: actions/setup-node@v1
uses: actions/setup-node@v4
with:
node-version: 18.x
node-version: 20.x
- run: yarn install --frozen-lockfile
- run: yarn build
- run: yarn test

128
CODE_OF_CONDUCT.md Normal file
View file

@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[helpdesk@vylpes.com](mailto:helpdesk@vylpes.com).
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series
of actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within
the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.

200
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,200 @@
# Contributing to VylBot
First off, thanks for taking the time to contribute!
The following is a set of guidelines for contributing to VylBot. These are mostly guidelines, not rules. Use your best judgement, and feel free to propose changes to this document in a pull request.
## Code of Conduct
This project and everyone participating in it is governed by the VylBot Code of Conduct. By participating, you are expected to uphold this code.
## Questions about VylBot
> **Note:** Please don't file an issue to ask a question. You'll get faster results by using the resources below.
You can ask a question about the project in the `#development` channel in the [Discord Server](https://go.vylpes.xyz/A6HcA).
You can also email with queries and support if you'd prefer at [helpdesk@vylpes.com](mailto:helpdesk@vylpes.com).
## What you should know
### Javascript and Node
VylBot uses [NodeJS](https://nodejs.org/), and therefore Javascript, as its runtime. You should know how to use this.
## Conventions
There are a few conventions that have developed over time for this project. When you create a pull request a check will be ran making sure that your code follows these conventions.
We won't accept pull requests unless these checks pass. If yours fail, simply fix what the bot says until it passes and then get a repo member to review your code.
* Variable names should use **Camel Case**
* Functions should put **braces on the same line**
* **No comma dangle**, i.e. having a commma after the last item in an object
* **Arrow body style** should have braces around the body only when needed
* **Arrow parameters** should have brackets around them only when needed
* **Arrow spacing** should have a space around the arrow (' => ')
* **No var** should be used, instead use either let or const when appropriate
## How You Can Contribute
### Reporting Bugs
This section guides you through submitting a bug report for VylBot. Following these guidelines helps maintainers and the community understand your report. reproduce the behaviour, and find related reports.
When you are creating a bug report, please include as many details as possible.
> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
#### Before Submitting A Bug Report
* **Perform a search** to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one.
#### How You Can Submit A (Good) Bug Report
Bugs are tracked as GitHub issues. After you've determined the bug you're reporting hasn't got a pre-existing **open** issue already, create an issue and provide information from below.
* **Use a clear and descriptive title** for the issue to indentify the problem.
* **Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining how you started VylBot (if you're using your own instance), which command exactly you used, and the output which the bot replied with. If its your own instance, provide information on what the terminal output said, if any.
* **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pastable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
* **Describe the behaviour you observed after following the steps** and point out what exactly is the problem with that behaviour.
* **Explain which behaviour you expected to see instead and why.**
* **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem.
* **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.
Provide more context by answering these questions:
* **Did the problem start happening recently** (e.g. after updating to a new version of VylBot) or was this always a problem?
* If the problem started happening recently, **can you reproduce the problem in an older version of VylBot?** What's the most recently version in which the problem doesn't happen? You can download older versions of VylBot from the releases page.
* **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
Include details about your configuration and environment:
* **Which version of VylBot are you using?** You can get the exact version by running the `about` command.
* **What's the name and version of the OS you're using?**
* **Are you running VylBot in a virtual machine?** If so, which VM software are you using and which operating systems and versions are used for the host and the guest?
* **What version of node do you have installed?** You can get this version by running the `node -v` command in your terminal.
### Suggesting Enhancements
This section guides you through submitting an enhancement suggestion for VylBot, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.
When you are creating an enhancement suggestion, please include as many details as possible. Fill out the suggestion with the steps that you imagine you would take if the feature you're requesting existed.
#### Before Submitting an Enhancement Suggestion
* **Check if the feature already exists.** Make sure to check on the latest version
* **Perform a search** to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
#### How Do I Submit A (Good) Enhancement Suggestion?
Enhancement suggestions are tracked as GitHub issues. After you've determined the feature doesn't already exist or been suggested before, create an issue on that repository and provide the following information:
* **Use a clear and descriptive title** for the issue to identify the suggestion.
* **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
* **Provide specific examples to demonstrate the steps.** Include copy/pastable snippets which you use in those examples, as Markdown code blocks.
* **Describe the current behaviour** and **explain which behaviour you expected to see instead** and why.
* **Include screnshots and animated GIFs** which help you demonstrate the steps or point out the part of VylBot which the suggestion is related to.
* **Explain why this enhancement would be useful** to most VylBot users and isn't something that can or should be implemented as a custom command.
* **List some other bots where this enhancement exists.**
* **Specify which version of VylBot you're using.** You can get the exact version by running the `about` command.
* **Specify the name and version of the OS you're using.**
#### Prerequisites
In order to download necessary tools, clone the repository, and install dependencies via `yarn` you need network access.
You'll need the following tools:
* Git
* NodeJS
* Yarn
Install and build all of the dependencies using `yarn`
```bash
cd vylbot-app
yarn install
```
#### Build and Run
If you want to understand how VylBot works or want to debug an issue, you'll want to get the source, build it, and run the tool locally.
First, fork the VylBot repository so that you can make a pull request. Then, clone your fork locally:
```bash
git clone https://git.vylpes.xyz/<your-gitea-account>/vylbot-app.git
# OR
git clone https://github.com/vylpes/vylbot-app.git
```
Occasionally, you will want to merge changes in the upstream repository (the official code repo) with your fork.
```bash
cd vylbot-app
git checkout master
git pull https://git.vylpes.xyz/rabbitlabs/vylbot-app.git master
```
Manage any merge conflicts, commit them, and then push them to your fork.
Go into `vylbot-app` and build the package using `yarn build`.
#### Pull Requests
The process described here has several goals:
* Maintain VylBot's quality
* Fix problems that are important to users
* Engage the community in working toward the best possible VylBot
* Enable a sustainable system for VylBot's maintainers to review contributions
Please follow these steps to have your contribution considered by maintainers:
* You mention the issue id which this pull request aims to fix
* After you submit your pull request, verify that all status checks are passing.
> **Note**: If a check fails the pull request it is important that you go and fix these issues, or let us know that you no longer want to work on this issue by commenting on the pull request. Doing this will give you a better chance of having your pull request merged.
* When the checks have passed a maintainer will review your code and ask for any improvements or questions, and will merge it if they are satisifed.
While the prerequesites above must be satisifed prior to having your pull reuqest accepted, the reviewer(s) may ask you to complete additional design ork, tests, or other changes before your pull request can be ultimately accepted.
#### Submitting Changes via Email
If you're not within our forgejo instance and still like to contribute, you can send us your contributions to [git@vylpes.com](mailto:git@vylpes.com).
For more information on how to do this, see the [git documentation](https://git-scm.com/docs/git-send-email).
#### Submitting Changes via GitHub
This code is mirrored on GitHub, although main development is done on my self-hosted Forgejo instance, feel free to clone and create pull requests on there. I will merge it back into Forgejo once accepted.
#### JavaScript Styleguide
All JavaScript code is linted with `eslint`.
* Prefer camelcase for variable names
* Prefer braces `{` to be on the same line
* Prefer no comma `,` dangle
* Prefer arrow function bodies to have brances `{}` only when needed
* Prefer arrow function parameters to have brackets `()` only when needed
* Prefer arrow function arrows `=>` to have a space before and after it
* Prefer `let` and `const` over `var`
As well as eslint's recommended defaults.
Example
```js
function ban (member) {
let reason = "Example reason";
member.ban(reason).then(() => {
// handle then here
}).catch(err => {
// handle error here
});
}
```

View file

@ -1,6 +1,6 @@
MIT License
Copyright (c) 2023 Vylpes
Copyright (c) 2025 Vylpes
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

View file

@ -4,13 +4,13 @@ Discord bot for Vylpes' Den Discord Server.
## Installation
Download the latest version from the [releases page](https://github.com/Vylpes/vylbot-app/releases).
Download the latest version from the [releases page](https://git.vylpes.xyz/rabbitlabs/vylbot-app/releases).
Copy the config template file and fill in the strings.
## Requirements
- NodeJS v16
- NodeJS v20
- Yarn
## Usage
@ -22,10 +22,10 @@ yarn install
yarn build
```
Setup the database (Recommended to use the docker-compose file)
Setup the database (Recommended to use the docker compose file)
```bash
docker-compose up -d
docker compose up -d
```
Copy and edit the settings files
@ -33,9 +33,6 @@ Copy and edit the settings files
```bash
cp .env.template .env
# Edit the .env file
cp ormconfig.json.template ormconfig.json
# Edit the ormconfig.json file
```
> **NOTE:** Make sure you do *not* check in these files! These contain sensitive information and should be treated as private.
@ -45,11 +42,3 @@ Start the bot
```bash
yarn start
```
Alternatively, you can start the bot in development mode using:
```bash
yarn start --dev
```
> Dev mode ensures that the default prefix is different to the production mode, in case you have both running in the same server.

View file

@ -7,7 +7,6 @@ commands.disabled: Disabled commands, separated by commas (Default: "")
role.moderator: The moderator role name (Default: "Moderator")
role.administrator: The administrator role name (Default: "Administrator")
role.muted: The muted role name (Default: "Muted")
rules.file: The location of the rules file (Default: "data/rules/rules")

View file

@ -0,0 +1,10 @@
CREATE TABLE `moon` (
`Id` varchar(255) NOT NULL,
`WhenCreated` datetime NOT NULL,
`WhenUpdated` datetime NOT NULL,
`MoonNumber` int NOT NULL,
`UserId` varchar(255) NOT NULL,
`Description` varchar(255) NOT NULL,
`WhenArchived` datetime NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;

View file

@ -8,7 +8,7 @@
"clean": "rm -rf node_modules/ dist/",
"build": "tsc",
"start": "node ./dist/vylbot",
"test": "echo true",
"test": "jest . --passWithNoTests",
"db:up": "typeorm migration:run -d dist/database/dataSources/appDataSource.js",
"db:down": "typeorm migration:revert -d dist/database/dataSources/appDataSource.js",
"db:create": "typeorm migration:create ./src/database/migrations",
@ -28,26 +28,24 @@
"funding": "https://ko-fi.com/vylpes",
"dependencies": {
"@discordjs/rest": "^2.0.0",
"@types/jest": "^29.0.0",
"@types/uuid": "^9.0.0",
"@types/uuid": "^10.0.0",
"discord.js": "^14.3.0",
"dotenv": "^16.0.0",
"emoji-regex": "^10.0.0",
"jest": "^29.0.0",
"jest-mock-extended": "^3.0.0",
"minimatch": "9.0.3",
"minimatch": "10.0.1",
"mysql": "^2.18.1",
"random-bunny": "^2.1.6",
"ts-jest": "^29.0.0",
"typeorm": "0.3.20"
"typeorm": "^0.3.20"
},
"resolutions": {
"**/semver": "^7.5.2",
"**/undici": "^6.0.0"
},
"devDependencies": {
"@types/node": "^20.0.0",
"@types/jest": "^29.5.12",
"@types/node": "^22.0.0",
"jest": "^29.7.0",
"jest-mock-extended": "^3.0.7",
"np": "^10.0.0",
"ts-jest": "^29.2.4",
"typescript": "^5.0.0"
}
}

14
src/buttonEvents/moons.ts Normal file
View file

@ -0,0 +1,14 @@
import {ButtonInteraction} from "discord.js";
import {ButtonEvent} from "../type/buttonEvent";
import List from "./moons/list";
export default class Moons extends ButtonEvent {
public override async execute(interaction: ButtonInteraction): Promise<void> {
const action = interaction.customId.split(" ")[1];
switch (action) {
case "list":
await List(interaction);
}
}
}

View file

@ -0,0 +1,53 @@
import {ActionRowBuilder, ButtonBuilder, ButtonInteraction, ButtonStyle, EmbedBuilder} from "discord.js";
import Moon from "../../database/entities/304276391837302787/Moon";
import EmbedColours from "../../constants/EmbedColours";
export default async function List(interaction: ButtonInteraction) {
if (!interaction.guild) return;
const userId = interaction.customId.split(" ")[2];
const page = interaction.customId.split(" ")[3];
if (!userId || !page) return;
const pageNumber = Number(page);
const member = interaction.guild.members.cache.find(x => x.user.id == userId);
const pageLength = 10;
const moons = await Moon.FetchPaginatedMoonsByUserId(userId, pageLength, pageNumber);
if (!moons || moons[0].length == 0) {
await interaction.reply(`${member?.user.username ?? "This user"} does not have any moons or page is invalid.`);
return;
}
const totalPages = Math.ceil(moons[1] / pageLength);
const description = moons[0].flatMap(x => `**${x.MoonNumber} -** ${x.Description.slice(0, 15)}`);
const embed = new EmbedBuilder()
.setTitle(`${member?.user.username}'s Moons`)
.setColor(EmbedColours.Ok)
.setDescription(description.join("\n"))
.setFooter({ text: `Page ${page + 1} of ${totalPages} · ${moons[1]} moons` });
const row = new ActionRowBuilder<ButtonBuilder>()
.addComponents(
new ButtonBuilder()
.setCustomId(`moons list ${userId} ${pageNumber - 1}`)
.setLabel("Previous")
.setStyle(ButtonStyle.Primary)
.setDisabled(pageNumber == 0),
new ButtonBuilder()
.setCustomId(`moons list ${userId} ${pageNumber + 1}`)
.setLabel("Next")
.setStyle(ButtonStyle.Primary)
.setDisabled(pageNumber + 1 == totalPages));
await interaction.update({
embeds: [ embed ],
components: [ row ],
});
}

View file

@ -0,0 +1,48 @@
import { Command } from "../../type/command";
import { CommandInteraction, SlashCommandBuilder } from "discord.js";
import ListMoons from "./moons/list";
import AddMoon from "./moons/add";
export default class Moons extends Command {
constructor() {
super();
this.CommandBuilder = new SlashCommandBuilder()
.setName("moons")
.setDescription("View and create moons")
.addSubcommand(subcommand =>
subcommand
.setName('list')
.setDescription('List moons you have obtained')
.addUserOption(option =>
option
.setName("user")
.setDescription("The user to view (Defaults to yourself)"))
.addNumberOption(option =>
option
.setName("page")
.setDescription("The page to start with")))
.addSubcommand(subcommand =>
subcommand
.setName('add')
.setDescription('Add a moon to your count!')
.addStringOption(option =>
option
.setName("description")
.setDescription("What deserved a moon?")
.setRequired(true)));
}
public override async execute(interaction: CommandInteraction) {
if (!interaction.isChatInputCommand()) return;
switch (interaction.options.getSubcommand()) {
case "list":
await ListMoons(interaction);
break;
case "add":
await AddMoon(interaction);
break;
}
}
}

View file

@ -0,0 +1,26 @@
import {CommandInteraction, EmbedBuilder} from "discord.js";
import Moon from "../../../database/entities/304276391837302787/Moon";
import EmbedColours from "../../../constants/EmbedColours";
export default async function AddMoon(interaction: CommandInteraction) {
const description = interaction.options.get("description", true).value?.toString();
if (!description || description.length > 255) {
await interaction.reply("Name must be less than 255 characters!");
return;
}
const moonCount = await Moon.FetchMoonCountByUserId(interaction.user.id);
const moon = new Moon(moonCount + 1, description, interaction.user.id);
await moon.Save(Moon, moon);
const embed = new EmbedBuilder()
.setTitle(`${interaction.user.globalName} Got A Moon!`)
.setColor(EmbedColours.Moon)
.setDescription(`**${moon.MoonNumber} -** ${moon.Description}`)
.setThumbnail("https://cdn.discordapp.com/emojis/374131312182689793.webp?size=96&quality=lossless");
await interaction.reply({ embeds: [ embed ] });
}

View file

@ -0,0 +1,45 @@
import {ActionRowBuilder, ButtonBuilder, ButtonStyle, CommandInteraction, EmbedBuilder} from "discord.js";
import Moon from "../../../database/entities/304276391837302787/Moon";
import EmbedColours from "../../../constants/EmbedColours";
export default async function ListMoons(interaction: CommandInteraction) {
const user = interaction.options.get("user")?.user ?? interaction.user;
const page = interaction.options.get("page")?.value as number ?? 0;
const pageLength = 10;
const moons = await Moon.FetchPaginatedMoonsByUserId(user.id, pageLength, page);
if (!moons || moons[0].length == 0) {
await interaction.reply(`${user.username} does not have any moons or page is invalid.`);
return;
}
const totalPages = Math.ceil(moons[1] / pageLength);
const description = moons[0].flatMap(x => `**${x.MoonNumber} -** ${x.Description.slice(0, 15)}`);
const embed = new EmbedBuilder()
.setTitle(`${user.username}'s Moons`)
.setColor(EmbedColours.Ok)
.setDescription(description.join("\n"))
.setFooter({ text: `Page ${page + 1} of ${totalPages} · ${moons[1]} moons` });
const row = new ActionRowBuilder<ButtonBuilder>()
.addComponents(
new ButtonBuilder()
.setCustomId(`moons list ${user.id} ${page - 1}`)
.setLabel("Previous")
.setStyle(ButtonStyle.Primary)
.setDisabled(page == 0),
new ButtonBuilder()
.setCustomId(`moons list ${user.id} ${page + 1}`)
.setLabel("Next")
.setStyle(ButtonStyle.Primary)
.setDisabled(page + 1 == totalPages));
await interaction.reply({
embeds: [ embed ],
components: [ row ],
});
}

View file

@ -93,7 +93,7 @@ export default class Audits extends Command {
private async SendAuditForUser(interaction: CommandInteraction) {
if (!interaction.guildId) return;
const user = interaction.options.get('target')?.user;
const user = interaction.options.get('target', true).user!;
if (!user) {
await interaction.reply("User not found.");
@ -191,7 +191,7 @@ export default class Audits extends Command {
private async AddAudit(interaction: CommandInteraction) {
if (!interaction.guildId) return;
const user = interaction.options.get('target')?.user;
const user = interaction.options.get('target', true).user!;
const auditType = interaction.options.get('type');
const reasonInput = interaction.options.get('reason');

View file

@ -62,7 +62,6 @@ export default class Ban extends Command {
}
await member.ban();
await interaction.reply(`\`${targetUser.user.tag}\` has been banned.`);
const channelName = await SettingsHelper.GetSetting('channels.logs.mod', interaction.guildId);
@ -74,7 +73,29 @@ export default class Ban extends Command {
await channel.send({ embeds: [ logEmbed ]});
}
const dmEmbed = new EmbedBuilder()
.setColor(EmbedColours.Ok)
.setTitle(interaction.guild.name)
.setDescription("You have been banned by a moderator.")
.addFields([
{
name: "Reason",
value: reason,
},
]);
let replyText = "Successfully banned user.";
try {
const dmChannel = await targetUser.user!.createDM();
await dmChannel.send({ embeds: [ dmEmbed ] });
} catch {
replyText += " *Note: I was unable to DM the user the reason.*";
}
const audit = new Audit(targetUser.user.id, AuditType.Ban, reason, interaction.user.id, interaction.guildId);
await audit.Save(Audit, audit);
await interaction.reply(replyText);
}
}

View file

@ -62,7 +62,6 @@ export default class Kick extends Command {
}
await member.kick();
await interaction.reply(`\`${targetUser.user.tag}\` has been kicked.`);
const channelName = await SettingsHelper.GetSetting('channels.logs.mod', interaction.guildId);
@ -74,7 +73,29 @@ export default class Kick extends Command {
await channel.send({ embeds: [ logEmbed ]});
}
const dmEmbed = new EmbedBuilder()
.setColor(EmbedColours.Ok)
.setTitle(interaction.guild.name)
.setDescription("You have been kicked from the server.")
.addFields([
{
name: "Reason",
value: reason,
},
]);
let replyText = "Successfully kicked user.";
try {
const dmChannel = await targetUser.user!.createDM();
await dmChannel.send({ embeds: [ dmEmbed ] });
} catch {
replyText += " *Note: I was unable to DM the user the reason.*";
}
const audit = new Audit(targetUser.user.id, AuditType.Kick, reason, interaction.user.id, interaction.guildId);
await audit.Save(Audit, audit);
await interaction.reply(replyText);
}
}

View file

@ -1,93 +0,0 @@
import { CommandInteraction, EmbedBuilder, GuildMember, PermissionsBitField, SlashCommandBuilder, TextChannel } from "discord.js";
import { AuditType } from "../constants/AuditType";
import EmbedColours from "../constants/EmbedColours";
import Audit from "../database/entities/Audit";
import SettingsHelper from "../helpers/SettingsHelper";
import { Command } from "../type/command";
export default class Mute extends Command {
constructor() {
super();
this.CommandBuilder = new SlashCommandBuilder()
.setName("mute")
.setDescription("(DEPRECATED) Mute a member in the server with an optional reason")
.setDefaultMemberPermissions(PermissionsBitField.Flags.ModerateMembers)
.addUserOption(option =>
option
.setName('target')
.setDescription('The user')
.setRequired(true))
.addStringOption(option =>
option
.setName('reason')
.setDescription('The reason'));
}
public override async execute(interaction: CommandInteraction) {
if (!interaction.guild || !interaction.guildId) return;
const targetUser = interaction.options.get('target');
const reasonInput = interaction.options.get('reason');
if (!targetUser || !targetUser.user || !targetUser.member) {
await interaction.reply('Fields are required.');
return;
}
const targetMember = targetUser.member as GuildMember;
const reason = reasonInput && reasonInput.value ? reasonInput.value.toString() : "*none*";
const logEmbed = new EmbedBuilder()
.setColor(EmbedColours.Ok)
.setTitle("Member Muted")
.setDescription(`<@${targetUser.user.id}> \`${targetUser.user.tag}\``)
.setThumbnail(targetUser.user.avatarURL())
.addFields([
{
name: "Moderator",
value: `<@${interaction.user.id}>`,
},
{
name: "Reason",
value: reason,
},
]);
const mutedRoleName = await SettingsHelper.GetSetting('role.muted', interaction.guildId);
if (!mutedRoleName) {
await interaction.reply('Unable to find configuration. Please contact the bot author.');
return;
}
const mutedRole = interaction.guild.roles.cache.find(role => role.name == mutedRoleName);
if (!mutedRole) {
await interaction.reply('Muted role not found.');
return;
}
if (!targetMember.manageable) {
await interaction.reply('Insufficient permissions. Please contact a moderator.');
return;
}
await targetMember.roles.add(mutedRole);
const channelName = await SettingsHelper.GetSetting('channels.logs.mod', interaction.guildId);
if (!channelName) return;
const channel = interaction.guild.channels.cache.find(x => x.name == channelName) as TextChannel;
if (channel) {
await channel.send({ embeds: [ logEmbed ]});
}
const audit = new Audit(targetUser.user.id, AuditType.Mute, reason, interaction.user.id, interaction.guildId);
await audit.Save(Audit, audit);
await interaction.reply("Please note the mute and unmute commands have been deprecated and will be removed in a future update. Please use timeout instead");
}
}

24
src/commands/say.ts Normal file
View file

@ -0,0 +1,24 @@
import { ActionRowBuilder, ButtonBuilder, ButtonStyle, CommandInteraction, EmbedBuilder, SlashCommandBuilder } from "discord.js";
import EmbedColours from "../constants/EmbedColours";
import { Command } from "../type/command";
export default class Say extends Command {
constructor() {
super();
this.CommandBuilder = new SlashCommandBuilder()
.setName('say')
.setDescription('Have the bot reply with your message')
.addStringOption(x =>
x
.setName("message")
.setDescription("The message to repeat")
.setRequired(true));
}
public override async execute(interaction: CommandInteraction) {
const message = interaction.options.get("message", true);
await interaction.reply(message.value as string);
}
}

View file

@ -104,54 +104,30 @@ export default class Timeout extends Command {
await channel.send({ embeds: [ logEmbed ]});
}
const dmEmbed = new EmbedBuilder()
.setColor(EmbedColours.Ok)
.setTitle(interaction.guild.name)
.setDescription("You have been given a warning by a moderator.")
.addFields([
{
name: "Reason",
value: reason || "*none*",
},
]);
let replyText = "Successfully warned user.";
try {
const dmChannel = await targetUser.user!.createDM();
await dmChannel.send({ embeds: [ dmEmbed ] });
} catch {
replyText += " *Note: I was unable to DM the user the reason.*";
}
// Create Audit
const audit = new Audit(targetUser.user.id, AuditType.Timeout, reason || "*none*", interaction.user.id, interaction.guildId);
await audit.Save(Audit, audit);
// DM User, if possible
const resultEmbed = new EmbedBuilder()
.setColor(EmbedColours.Ok)
.setDescription(`<@${targetUser.user.id}> has been timed out`);
const dmEmbed = new EmbedBuilder()
.setColor(EmbedColours.Ok)
.setDescription(`You have been timed out in ${interaction.guild.name}`)
.addFields([
{
name: "Reason",
value: reason || "*none*"
},
{
name: "Length",
value: timeLength.GetLengthShort(),
},
{
name: "Until",
value: timeLength.GetDateFromNow().toString(),
},
]);
try {
const dmChannel = await targetUser.user.createDM();
await dmChannel.send({ embeds: [ dmEmbed ]});
resultEmbed.addFields([
{
name: "DM Sent",
value: "true",
},
]);
} catch {
resultEmbed.addFields([
{
name: "DM Sent",
value: "false",
},
]);
}
// Success Reply
await interaction.reply({ embeds: [ resultEmbed ]});
await interaction.reply(replyText);
}
}

View file

@ -1,88 +0,0 @@
import { CommandInteraction, EmbedBuilder, GuildMember, PermissionsBitField, SlashCommandBuilder, TextChannel } from "discord.js";
import EmbedColours from "../constants/EmbedColours";
import SettingsHelper from "../helpers/SettingsHelper";
import { Command } from "../type/command";
export default class Unmute extends Command {
constructor() {
super();
this.CommandBuilder = new SlashCommandBuilder()
.setName("unmute")
.setDescription("(DEPRECATED) Unmute a member in the server with an optional reason")
.setDefaultMemberPermissions(PermissionsBitField.Flags.ModerateMembers)
.addUserOption(option =>
option
.setName('target')
.setDescription('The user')
.setRequired(true))
.addStringOption(option =>
option
.setName('reason')
.setDescription('The reason'));
}
public override async execute(interaction: CommandInteraction) {
if (!interaction.guild || !interaction.guildId) return;
const targetUser = interaction.options.get('target');
const reasonInput = interaction.options.get('reason');
if (!targetUser || !targetUser.user || !targetUser.member) {
await interaction.reply('Fields are required.');
return;
}
const targetMember = targetUser.member as GuildMember;
const reason = reasonInput && reasonInput.value ? reasonInput.value.toString() : "*none*";
const logEmbed = new EmbedBuilder()
.setColor(EmbedColours.Ok)
.setTitle("Member Unmuted")
.setDescription(`<@${targetUser.user.id}> \`${targetUser.user.tag}\``)
.setThumbnail(targetUser.user.avatarURL())
.addFields([
{
name: "Moderator",
value: `<@${interaction.user.id}>`,
},
{
name: "Reason",
value: reason,
},
]);
const mutedRoleName = await SettingsHelper.GetSetting('role.muted', interaction.guildId);
if (!mutedRoleName) {
await interaction.reply('Unable to find configuration. Please contact the bot author.');
return;
}
const mutedRole = interaction.guild.roles.cache.find(role => role.name == mutedRoleName);
if (!mutedRole) {
await interaction.reply('Muted role not found.');
return;
}
if (!targetMember.manageable) {
await interaction.reply('Insufficient permissions. Please contact a moderator.');
return;
}
await targetMember.roles.remove(mutedRole);
const channelName = await SettingsHelper.GetSetting('channels.logs.mod', interaction.guildId);
if (!channelName) return;
const channel = interaction.guild.channels.cache.find(x => x.name == channelName) as TextChannel;
if (channel) {
await channel.send({ embeds: [ logEmbed ]});
}
await interaction.reply("Please note the mute and unmute commands have been deprecated and will be removed in a future update. Please use timeout instead");
}
}

View file

@ -63,9 +63,29 @@ export default class Warn extends Command {
await channel.send({ embeds: [ logEmbed ]});
}
const dmEmbed = new EmbedBuilder()
.setColor(EmbedColours.Ok)
.setTitle(interaction.guild.name)
.setDescription("You have been given a warning by a moderator.")
.addFields([
{
name: "Reason",
value: reason,
},
]);
let replyText = "Successfully warned user.";
try {
const dmChannel = await targetUser.user!.createDM();
await dmChannel.send({ embeds: [ dmEmbed ] });
} catch {
replyText += " *Note: I was unable to DM the user the reason.*";
}
const audit = new Audit(targetUser.user.id, AuditType.Warn, reason, interaction.user.id, interaction.guildId);
await audit.Save(Audit, audit);
await interaction.reply('Successfully warned user.');
await interaction.reply(replyText);
}
}

View file

@ -1,3 +1,4 @@
export default class EmbedColours {
public static readonly Ok = 0x3050ba;
public static readonly Moon = 0x50C878;
}

View file

@ -0,0 +1,57 @@
import { Column, Entity, IsNull } from "typeorm";
import BaseEntity from "../../../contracts/BaseEntity";
import AppDataSource from "../../dataSources/appDataSource";
@Entity()
export default class Moon extends BaseEntity {
constructor(moonNumber: number, description: string, userId: string) {
super();
this.MoonNumber = moonNumber;
this.Description = description;
this.UserId = userId;
}
@Column()
MoonNumber: number;
@Column()
Description: string;
@Column({ nullable: true })
WhenArchived?: Date;
@Column()
UserId: string;
public static async FetchMoonsByUserId(userId: string): Promise<Moon[] | null> {
const repository = AppDataSource.getRepository(Moon);
const all = await repository.find({ where: { UserId: userId } });
return all;
}
public static async FetchPaginatedMoonsByUserId(userId: string, pageLength: number, page: number): Promise<[ Moon[], number ]> {
const rangeStart = page * pageLength;
const repository = AppDataSource.getRepository(Moon);
const moons = await repository.findAndCount({
where: { UserId: userId, WhenArchived: IsNull() },
order: { MoonNumber: "ASC" },
skip: rangeStart,
take: pageLength,
});
return moons;
}
public static async FetchMoonCountByUserId(userId: string): Promise<number> {
const repository = AppDataSource.getRepository(Moon);
const count = await repository.count({ where: { UserId: userId } });
return count;
}
}

View file

@ -0,0 +1,15 @@
import { MigrationInterface, QueryRunner } from "typeorm"
import MigrationHelper from "../../../helpers/MigrationHelper"
export class CreateMoon1719856023429 implements MigrationInterface {
public async up(queryRunner: QueryRunner): Promise<void> {
MigrationHelper.Up('1719856023429-CreateMoon', '3.3.0', [
"01-Moon",
], queryRunner);
}
public async down(queryRunner: QueryRunner): Promise<void> {
}
}

View file

@ -13,14 +13,13 @@ import Disable from "./commands/disable";
import Ignore from "./commands/ignore";
import Kick from "./commands/kick";
import Linkonly from "./commands/linkonly";
import Mute from "./commands/mute";
import Poll from "./commands/poll";
import Role from "./commands/Role/role";
import ConfigRole from "./commands/Role/config";
import Rules from "./commands/rules";
import Say from "./commands/say";
import Setup from "./commands/setup";
import Timeout from "./commands/timeout";
import Unmute from "./commands/unmute";
import Warn from "./commands/warn";
// Command Imports: MankBot
@ -30,6 +29,9 @@ import AddLobby from "./commands/501231711271780357/Lobby/add";
import RemoveLobby from "./commands/501231711271780357/Lobby/remove";
import ListLobby from "./commands/501231711271780357/Lobby/list";
// Command Imports: Potato Talk
import Moons from "./commands/304276391837302787/moons";
// Event Imports
import GuildMemberAdd from "./events/MemberEvents/GuildMemberAdd";
import GuildMemberRemove from "./events/MemberEvents/GuildMemberRemove";
@ -40,6 +42,7 @@ import MessageCreate from "./events/MessageEvents/MessageCreate";
// Button Event Imports
import Verify from "./buttonEvents/verify";
import MoonsButtonEvent from "./buttonEvents/moons";
export default class Registry {
public static RegisterCommands() {
@ -54,12 +57,11 @@ export default class Registry {
CoreClient.RegisterCommand("ignore", new Ignore());
CoreClient.RegisterCommand("kick", new Kick());
CoreClient.RegisterCommand("linkonly", new Linkonly());
CoreClient.RegisterCommand("mute", new Mute());
CoreClient.RegisterCommand("poll", new Poll());
CoreClient.RegisterCommand("rules", new Rules());
CoreClient.RegisterCommand("say", new Say());
CoreClient.RegisterCommand("setup", new Setup());
CoreClient.RegisterCommand("timeout", new Timeout());
CoreClient.RegisterCommand("unmute", new Unmute());
CoreClient.RegisterCommand("warn", new Warn());
CoreClient.RegisterCommand("role", new Role());
@ -72,12 +74,16 @@ export default class Registry {
CoreClient.RegisterCommand("listlobby", new ListLobby(), "501231711271780357");
CoreClient.RegisterCommand("entry", new Entry(), "501231711271780357");
// Exclusive Commands: Potato Talk
CoreClient.RegisterCommand("moons", new Moons(), "304276391837302787");
// Add Exclusive Commands to Test Server
CoreClient.RegisterCommand("lobby", new Lobby(), "442730357897429002");
CoreClient.RegisterCommand("addlobby", new AddLobby(), "442730357897429002");
CoreClient.RegisterCommand("removelobby", new RemoveLobby(), "442730357897429002");
CoreClient.RegisterCommand("listlobby", new ListLobby(), "442730357897429002");
CoreClient.RegisterCommand("entry", new Entry(), "442730357897429002");
CoreClient.RegisterCommand("moons", new Moons(), "442730357897429002");
}
public static RegisterEvents() {
@ -92,5 +98,6 @@ export default class Registry {
public static RegisterButtonEvents() {
CoreClient.RegisterButtonEvent("verify", new Verify());
CoreClient.RegisterButtonEvent("moons", new MoonsButtonEvent());
}
}

View file

@ -1,10 +0,0 @@
import { Command } from "../../../src/type/command";
export default class MockCmd extends Command {
constructor() {
super();
super._category = "General";
super._roles = ["Moderator"];
}
}

View file

@ -1,13 +0,0 @@
[
{
"image": "IMAGEURL"
},
{
"title": "TITLE 1",
"description": [
"DESCRIPTION 1A",
"DESCRIPTION 1B"
],
"footer": "FOOTER 1"
}
]

View file

@ -1,153 +0,0 @@
import { mock } from "jest-mock-extended";
const connectionMock = mock<Connection>();
const qbuilderMock = mock<SelectQueryBuilder<any>>();
let repositoryMock = mock<Repository<any>>();
let settingMock = mock<Setting>();
jest.mock('typeorm', () => {
qbuilderMock.where.mockReturnThis();
qbuilderMock.select.mockReturnThis();
repositoryMock.createQueryBuilder.mockReturnValue(qbuilderMock);
repositoryMock.findOne.mockImplementation(async () => {
return settingMock;
});
connectionMock.getRepository.mockReturnValue(repositoryMock);
return {
getConnection: () => connectionMock,
createConnection: () => connectionMock,
BaseEntity: class Mock {},
ObjectType: () => {},
Entity: () => {},
InputType: () => {},
Index: () => {},
PrimaryColumn: () => {},
Column: () => {},
CreateDateColumn: () => {},
UpdateDateColumn: () => {},
OneToMany: () => {},
ManyToOne: () => {},
}
});
jest.mock("discord.js");
jest.mock("dotenv");
jest.mock("../../src/client/events");
jest.mock("../../src/client/util");
jest.mock("../../src/constants/DefaultValues");
import { CoreClient } from "../../src/client/client";
import { Client } from "discord.js";
import * as dotenv from "dotenv";
import { Events } from "../../src/client/events";
import { Util } from "../../src/client/util";
import { Command } from "../../src/type/command";
import { Event } from "../../src/type/event";
import DefaultValues from "../../src/constants/DefaultValues";
import { Connection, Repository, SelectQueryBuilder } from "typeorm";
import Setting from "../../src/entity/Setting";
beforeEach(() => {
jest.resetAllMocks();
jest.resetModules();
})
describe('Constructor', () => {
test('Expect Successful Initialisation', () => {
const coreClient = new CoreClient();
expect(coreClient).toBeInstanceOf(Client);
expect(dotenv.config).toBeCalledTimes(1);
expect(Events).toBeCalledTimes(1);
expect(Util).toBeCalledTimes(1);
expect(DefaultValues.useDevPrefix).toBe(false);
});
test('Given devmode parameter is true, Expect devmode prefix to be true', () => {
const coreClient = new CoreClient(true);
expect(coreClient).toBeInstanceOf(Client);
expect(dotenv.config).toBeCalledTimes(1);
expect(Events).toBeCalledTimes(1);
expect(Util).toBeCalledTimes(1);
expect(DefaultValues.useDevPrefix).toBe(true);
});
});
describe('Start', () => {
test('Given Env Is Valid, Expect Successful Start', async () => {
process.env = {
BOT_TOKEN: "TOKEN",
};
const coreClient = new CoreClient();
await coreClient.start();
expect(coreClient.on).toBeCalledWith("message", expect.any(Function));
expect(coreClient.on).toBeCalledWith("ready", expect.any(Function));
});
test('Given BOT_TOKEN Is Null, Expect Failure', async () => {
process.env = {};
const consoleError = jest.fn();
console.error = consoleError;
const coreClient = new CoreClient();
await coreClient.start();
expect(consoleError).toBeCalledWith("BOT_TOKEN is not defined in .env");
expect(coreClient.on).not.toBeCalled();
expect(coreClient.login).not.toBeCalled();
});
test('Given BOT_TOKEN Is Empty, Expect Failure', async () => {
process.env = {
BOT_TOKEN: '',
}
const consoleError = jest.fn();
console.error = consoleError;
const coreClient = new CoreClient();
await coreClient.start();
expect(consoleError).toBeCalledWith("BOT_TOKEN is not defined in .env");
expect(coreClient.on).not.toBeCalled();
expect(coreClient.login).not.toBeCalled();
});
});
describe('RegisterCommand', () => {
test('Expect command added to register', () => {
const cmd = mock<Command>();
const client = new CoreClient();
client.RegisterCommand("test", cmd);
expect(client.commandItems.length).toBe(1);
expect(client.commandItems[0].Name).toBe("test");
expect(client.commandItems[0].Command).toBe(cmd);
});
});
describe('RegisterEvent', () => {
test('Expect event added to register', () => {
const evt = mock<Event>();
const client = new CoreClient();
client.RegisterEvent(evt);
expect(client.eventItems.length).toBe(1);
expect(client.eventItems[0].Event).toBe(evt);
});
});

View file

@ -1,241 +0,0 @@
import { Events } from "../../src/client/events";
import { Message } from "discord.js";
import { Util } from "../../src/client/util";
import ICommandItem from "../../src/contracts/ICommandItem";
import { Command } from "../../src/type/command";
import { mock } from "jest-mock-extended";
jest.mock("../../src/client/util");
beforeEach(() => {
Util.prototype.loadCommand = jest.fn();
});
describe('OnMessage', () => {
test('Given Message Is Valid Expect Message Sent', async () => {
process.env = {
BOT_TOKEN: 'TOKEN',
BOT_PREFIX: '!',
FOLDERS_COMMANDS: 'commands',
FOLDERS_EVENTS: 'events',
};
Util.prototype.loadCommand = jest.fn().mockReturnValue({ valid: true });
const message = {
guild: {},
author: {
bot: false,
},
content: "!test first",
} as unknown as Message;
const cmd = mock<Command>();
const commandItem: ICommandItem = {
Name: "test",
Command: cmd
};
const commands: ICommandItem[] = [ commandItem ];
const events = new Events();
const result = await events.onMessage(message, commands);
expect(result.valid).toBeTruthy();
expect(result.context?.prefix).toBe('!');
expect(result.context?.name).toBe('test');
expect(result.context?.args.length).toBe(1);
expect(result.context?.args[0]).toBe('first');
expect(result.context?.message).toBe(message);
});
test('Given Guild Is Null, Expect Failed Result', async () => {
process.env = {
BOT_TOKEN: 'TOKEN',
BOT_PREFIX: '!',
FOLDERS_COMMANDS: 'commands',
FOLDERS_EVENTS: 'events',
}
Util.prototype.loadCommand = jest.fn().mockReturnValue({ valid: true });
const message = {
guild: null,
author: {
bot: false,
},
content: "!test first",
} as unknown as Message;
const cmd = mock<Command>();
const commandItem: ICommandItem = {
Name: "test",
Command: cmd
};
const commands: ICommandItem[] = [ commandItem ];
const events = new Events();
const result = await events.onMessage(message, commands);
expect(result.valid).toBeFalsy();
expect(result.message).toBe("Message was not sent in a guild, ignoring.");
});
test('Given Author Is A Bot, Expect Failed Result', async () => {
process.env = {
BOT_TOKEN: 'TOKEN',
BOT_PREFIX: '!',
FOLDERS_COMMANDS: 'commands',
FOLDERS_EVENTS: 'events',
}
Util.prototype.loadCommand = jest.fn().mockReturnValue({ valid: true });
const message = {
guild: {},
author: {
bot: true,
},
content: "!test first",
} as unknown as Message;
const cmd = mock<Command>();
const commandItem: ICommandItem = {
Name: "test",
Command: cmd
};
const commands: ICommandItem[] = [ commandItem ];
const events = new Events();
const result = await events.onMessage(message, commands);
expect(result.valid).toBeFalsy();
expect(result.message).toBe("Message was sent by a bot, ignoring.");
});
test('Given Message Content Was Not A Command, Expect Failed Result', async () => {
process.env = {
BOT_TOKEN: 'TOKEN',
BOT_PREFIX: '!',
FOLDERS_COMMANDS: 'commands',
FOLDERS_EVENTS: 'events',
}
Util.prototype.loadCommand = jest.fn().mockReturnValue({ valid: true });
const message = {
guild: {},
author: {
bot: false,
},
content: "This is a standard message",
} as unknown as Message;
const cmd = mock<Command>();
const commandItem: ICommandItem = {
Name: "test",
Command: cmd
};
const commands: ICommandItem[] = [ commandItem ];
const events = new Events();
const result = await events.onMessage(message, commands);
expect(result.valid).toBeFalsy();
expect(result.message).toBe("Message was not a command, ignoring.");
});
test('Given Message Had No Command Name, Expect Failed Result', async () => {
process.env = {
BOT_TOKEN: 'TOKEN',
BOT_PREFIX: '!',
FOLDERS_COMMANDS: 'commands',
FOLDERS_EVENTS: 'events',
}
Util.prototype.loadCommand = jest.fn().mockReturnValue({ valid: true });
const message = {
guild: {},
author: {
bot: false,
},
content: "!",
} as unknown as Message;
const cmd = mock<Command>();
const commandItem: ICommandItem = {
Name: "test",
Command: cmd
};
const commands: ICommandItem[] = [ commandItem ];
const events = new Events();
const result = await events.onMessage(message, commands);
expect(result.valid).toBeFalsy();
expect(result.message).toBe("Command name was not found");
});
test('Given Command Failed To Execute, Expect Failed Result', async () => {
process.env = {
BOT_TOKEN: 'TOKEN',
BOT_PREFIX: '!',
FOLDERS_COMMANDS: 'commands',
FOLDERS_EVENTS: 'events',
}
Util.prototype.loadCommand = jest.fn().mockReturnValue({ valid: false, message: "Command failed" });
const message = {
guild: {},
author: {
bot: false,
},
content: "!test first",
} as unknown as Message;
const cmd = mock<Command>();
const commandItem: ICommandItem = {
Name: "test",
Command: cmd
};
const commands: ICommandItem[] = [ commandItem ];
const events = new Events();
const result = await events.onMessage(message, commands);
expect(result.valid).toBeFalsy();
expect(result.message).toBe("Command failed");
});
});
describe('OnReady', () => {
test('Expect Console Log', () => {
console.log = jest.fn();
const events = new Events();
events.onReady();
expect(console.log).toBeCalledWith("Ready");
});
});

View file

@ -1,370 +0,0 @@
import { Util } from "../../src/client/util";
import { Client, Message } from "discord.js";
import fs from "fs";
import { mock } from "jest-mock-extended";
import { Command } from "../../src/type/command";
import ICommandItem from "../../src/contracts/ICommandItem";
import IEventItem from "../../src/contracts/IEventItem";
import { Event } from "../../src/type/event";
jest.mock("fs");
beforeEach(() => {
fs.existsSync = jest.fn();
});
describe('LoadCommand', () => {
test('Given Successful Exection, Expect Successful Result', async () => {
process.env = {
BOT_TOKEN: 'TOKEN',
BOT_PREFIX: '!',
FOLDERS_COMMANDS: 'commands',
FOLDERS_EVENTS: 'events',
}
const message = {
member: {
roles: {
cache: {
find: jest.fn().mockReturnValue(true),
}
},
},
reply: jest.fn(),
} as unknown as Message;
const cmd = mock<Command>();
const commandItem: ICommandItem = {
Name: "test",
Command: cmd
};
const commands: ICommandItem[] = [ commandItem ];
const util = new Util();
const result = await util.loadCommand("test", [ "first" ], message, commands);
expect(result.valid).toBeTruthy();
expect(cmd.execute).toBeCalled();
});
test('Given Member Is Null, Expect Failed Result', async () => {
process.env = {
BOT_TOKEN: 'TOKEN',
BOT_PREFIX: '!',
FOLDERS_COMMANDS: 'commands',
FOLDERS_EVENTS: 'events',
}
const message = {
member: null
} as unknown as Message;
const cmd = mock<Command>();
const commandItem: ICommandItem = {
Name: "test",
Command: cmd
};
const commands: ICommandItem[] = [ commandItem ];
const util = new Util();
const result = await util.loadCommand("test", [ "first" ], message, commands);
expect(result.valid).toBeFalsy();
expect(result.message).toBe("Member is not part of message");
expect(cmd.execute).not.toBeCalled();
});
test('Given User Does Have Role, Expect Successful Result', async () => {
process.env = {
BOT_TOKEN: 'TOKEN',
BOT_PREFIX: '!',
FOLDERS_COMMANDS: 'commands',
FOLDERS_EVENTS: 'events',
}
const message = {
member: {
roles: {
cache: {
find: jest.fn().mockReturnValue(true),
}
},
},
reply: jest.fn(),
} as unknown as Message;
const cmd = mock<Command>();
const commandItem: ICommandItem = {
Name: "test",
Command: cmd
};
const commands: ICommandItem[] = [ commandItem ];
const util = new Util();
const result = await util.loadCommand("test", [ "first" ], message, commands);
expect(result.valid).toBeTruthy();
expect(cmd.execute).toBeCalled();
});
test('Given User Does Not Have Role, Expect Failed Result', async () => {
process.env = {
BOT_TOKEN: 'TOKEN',
BOT_PREFIX: '!',
FOLDERS_COMMANDS: 'commands',
FOLDERS_EVENTS: 'events',
}
const message = {
member: {
roles: {
cache: {
find: jest.fn().mockReturnValue(false),
}
},
},
reply: jest.fn(),
} as unknown as Message;
const cmd = mock<Command>();
cmd._roles = [ "Moderator" ];
const commandItem: ICommandItem = {
Name: "test",
Command: cmd
};
const commands: ICommandItem[] = [ commandItem ];
const util = new Util();
const result = await util.loadCommand("test", [ "first" ], message, commands);
expect(result.valid).toBeFalsy();
expect(result.message).toBe("You require the `Moderator` role to run this command");
expect(cmd.execute).not.toBeCalled();
});
test('Given command is set to disabled, Expect command to not fire', async () => {
process.env = {
BOT_TOKEN: 'TOKEN',
BOT_PREFIX: '!',
FOLDERS_COMMANDS: 'commands',
FOLDERS_EVENTS: 'events',
COMMANDS_DISABLED: 'test',
COMMANDS_DISABLED_MESSAGE: 'disabled',
}
const message = {
member: {
roles: {
cache: {
find: jest.fn().mockReturnValue(true),
}
},
},
reply: jest.fn(),
} as unknown as Message;
const messageReply = jest.spyOn(message, 'reply');
const cmd = mock<Command>();
const commandItem: ICommandItem = {
Name: "test",
Command: cmd
};
const commands: ICommandItem[] = [ commandItem ];
const util = new Util();
const result = await util.loadCommand("test", [ "first" ], message, commands);
expect(result.valid).toBeFalsy();
expect(result.message).toBe("Command is disabled");
expect(messageReply).toBeCalledWith("disabled");
expect(cmd.execute).not.toBeCalled();
});
test('Given command COMMANDS_DISABLED_MESSAGE is empty, Expect default message sent', async () => {
process.env = {
BOT_TOKEN: 'TOKEN',
BOT_PREFIX: '!',
FOLDERS_COMMANDS: 'commands',
FOLDERS_EVENTS: 'events',
COMMANDS_DISABLED: 'test',
}
const message = {
member: {
roles: {
cache: {
find: jest.fn().mockReturnValue(true),
}
},
},
reply: jest.fn(),
} as unknown as Message;
const messageReply = jest.spyOn(message, 'reply');
const cmd = mock<Command>();
const commandItem: ICommandItem = {
Name: "test",
Command: cmd
};
const commands: ICommandItem[] = [ commandItem ];
const util = new Util();
const result = await util.loadCommand("test", [ "first" ], message, commands);
expect(result.valid).toBeFalsy();
expect(result.message).toBe("Command is disabled");
expect(messageReply).toBeCalledWith("This command is disabled.");
expect(cmd.execute).not.toBeCalled();
});
test('Given a different command is disabled, Expect command to still fire', async () => {
process.env = {
BOT_TOKEN: 'TOKEN',
BOT_PREFIX: '!',
FOLDERS_COMMANDS: 'commands',
FOLDERS_EVENTS: 'events',
COMMANDS_DISABLED: 'other',
}
const message = {
member: {
roles: {
cache: {
find: jest.fn().mockReturnValue(true),
}
},
},
reply: jest.fn(),
} as unknown as Message;
const cmd = mock<Command>();
const otherCmd = mock<Command>();
const commandItem: ICommandItem = {
Name: "test",
Command: cmd
};
const otherCommandItem: ICommandItem = {
Name: "other",
Command: otherCmd,
}
const commands: ICommandItem[] = [ commandItem, otherCommandItem ];
const util = new Util();
const result = await util.loadCommand("test", [ "first" ], message, commands);
expect(result.valid).toBeTruthy();
expect(cmd.execute).toBeCalled();
expect(otherCmd.execute).not.toBeCalled();
});
test('Given command is not found in register, expect command not found error', async () => {
process.env = {
BOT_TOKEN: 'TOKEN',
BOT_PREFIX: '!',
FOLDERS_COMMANDS: 'commands',
FOLDERS_EVENTS: 'events',
}
const message = {
member: {
roles: {
cache: {
find: jest.fn().mockReturnValue(true),
}
},
},
reply: jest.fn(),
} as unknown as Message;
const commands: ICommandItem[] = [];
const util = new Util();
const result = await util.loadCommand("test", [ "first" ], message, commands);
expect(result.valid).toBeFalsy();
expect(result.message).toBe('Command not found');
expect(message.reply).toBeCalledWith('Command not found');
});
});
describe('LoadEvents', () => {
test('Given Events Are Loaded, Expect Successful Result', () => {
process.env = {
BOT_TOKEN: 'TOKEN',
BOT_PREFIX: '!',
FOLDERS_COMMANDS: 'commands',
FOLDERS_EVENTS: 'events',
}
const client = {
on: jest.fn(),
} as unknown as Client;
const evt = mock<Event>();
const eventItem: IEventItem = {
Event: evt
};
const eventItems: IEventItem[] = [ eventItem ];
const util = new Util();
const result = util.loadEvents(client, eventItems);
const clientOn = jest.spyOn(client, 'on');
expect(result.valid).toBeTruthy();
expect(clientOn).toBeCalledTimes(13);
});
test('Given No Events Found, Expect Successful Result', () => {
process.env = {
BOT_TOKEN: 'TOKEN',
BOT_PREFIX: '!',
FOLDERS_COMMANDS: 'commands',
FOLDERS_EVENTS: 'events',
}
const client = {
on: jest.fn(),
} as unknown as Client;
const eventItems: IEventItem[] = [];
const util = new Util();
const result = util.loadEvents(client, eventItems);
const clientOn = jest.spyOn(client, 'on');
expect(result.valid).toBeTruthy();
expect(clientOn).toBeCalledTimes(0);
});
});

View file

@ -1,152 +0,0 @@
import { Message } from "discord.js";
import { mock } from "jest-mock-extended";
import About from "../../src/commands/about";
import { ICommandContext } from "../../src/contracts/ICommandContext";
import PublicEmbed from "../../src/helpers/embeds/PublicEmbed";
beforeEach(() => {
process.env = {};
});
describe('Constructor', () => {
test('Expect values set', () => {
const about = new About();
expect(about._category).toBe("General");
});
});
describe('Execute', () => {
test('Expect embed to be made and sent to the current channel', async () => {
process.env = {
BOT_VER: "BOT_VER",
BOT_AUTHOR: "BOT_AUTHOR",
BOT_DATE: "BOT_DATE"
};
const message = mock<Message>();
message.channel.send = jest.fn();
const context: ICommandContext = {
name: "about",
args: [],
message: message
};
const about = new About();
const result = await about.execute(context);
expect(message.channel.send).toBeCalledTimes(1);
});
test('Expect embed send to have values', async () => {
process.env = {
BOT_VER: "BOT_VER",
BOT_AUTHOR: "BOT_AUTHOR",
BOT_DATE: "BOT_DATE"
};
const message = mock<Message>();
message.channel.send = jest.fn();
const context: ICommandContext = {
name: "about",
args: [],
message: message
};
const about = new About();
const result = await about.execute(context);
expect(result.embeds.length).toBe(1);
const embed = result.embeds[0];
expect(embed.title).toBe('About');
expect(embed.description).toBe('');
expect(embed.fields.length).toBe(3);
});
test('Expect version field to have values', async () => {
process.env = {
BOT_VER: "BOT_VER",
BOT_AUTHOR: "BOT_AUTHOR",
BOT_DATE: "BOT_DATE"
};
const message = mock<Message>();
message.channel.send = jest.fn();
const context: ICommandContext = {
name: "about",
args: [],
message: message
};
const about = new About();
const result = await about.execute(context);
const embed = result.embeds[0];
const field = embed.fields[0];
expect(field.name).toBe('Version');
expect(field.value).toBe('BOT_VER');
});
test('Expect author field to have values', async () => {
process.env = {
BOT_VER: "BOT_VER",
BOT_AUTHOR: "BOT_AUTHOR",
BOT_DATE: "BOT_DATE"
};
const message = mock<Message>();
message.channel.send = jest.fn();
const context: ICommandContext = {
name: "about",
args: [],
message: message
};
const about = new About();
const result = await about.execute(context);
const embed = result.embeds[0];
const field = embed.fields[1];
expect(field.name).toBe('Author');
expect(field.value).toBe('BOT_AUTHOR');
});
test('Expect version field to have values', async () => {
process.env = {
BOT_VER: "BOT_VER",
BOT_AUTHOR: "BOT_AUTHOR",
BOT_DATE: "BOT_DATE"
};
const message = mock<Message>();
message.channel.send = jest.fn();
const context: ICommandContext = {
name: "about",
args: [],
message: message
};
const about = new About();
const result = await about.execute(context);
const embed = result.embeds[0];
const field = embed.fields[2];
expect(field.name).toBe('Date');
expect(field.value).toBe('BOT_DATE');
});
});

View file

@ -1,724 +0,0 @@
import { GuildMember, Message, TextChannel, User } from "discord.js";
import Ban from "../../src/commands/ban";
import { ICommandContext } from "../../src/contracts/ICommandContext";
beforeEach(() => {
process.env = {};
});
describe('Constructor', () => {
test('Expect values to be set', () => {
process.env.ROLES_MODERATOR = 'Moderator';
const ban = new Ban();
expect(ban._category).toBe('Moderation');
expect(ban._roles.length).toBe(1);
expect(ban._roles[0]).toBe('Moderator');
});
});
describe('Execute', () => {
test('Given user has permission, expect user to be banned', async () => {
process.env = {
ROLES_MODERATOR: 'Moderator',
CHANNELS_LOGS_MOD: 'mod-logs'
};
const mentionedUser = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const mentionedMember = {
bannable: true,
ban: jest.fn()
} as unknown as GuildMember;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageChannelSend = jest.fn();
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(mentionedUser);
const messageGuildMember = jest.fn()
.mockReturnValue(mentionedMember);
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
channel: {
send: messageChannelSend
},
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember ,
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
},
available: true
},
author: {
tag: 'AUTHORTAG'
}
} as unknown as Message;
const context: ICommandContext = {
name: 'ban',
args: ['ban', 'Test', 'Reason'],
message: message
};
const ban = new Ban();
const result = await ban.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(logChannel.send).toBeCalledTimes(1);
expect(mentionedMember.ban).toBeCalledWith({ reason: 'Moderator: AUTHORTAG, Reason: Test Reason' });
});
test('Given moderator did not supply a reason, expect default message', async () => {
process.env = {
ROLES_MODERATOR: 'Moderator',
CHANNELS_LOGS_MOD: 'mod-logs'
};
const mentionedUser = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const mentionedMember = {
bannable: true,
ban: jest.fn()
} as unknown as GuildMember;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageChannelSend = jest.fn();
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(mentionedUser);
const messageGuildMember = jest.fn()
.mockReturnValue(mentionedMember);
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
channel: {
send: messageChannelSend
},
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember ,
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
},
available: true
},
author: {
tag: 'AUTHORTAG'
}
} as unknown as Message;
const context: ICommandContext = {
name: 'ban',
args: ['ban'],
message: message
};
const ban = new Ban();
const result = await ban.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(logChannel.send).toBeCalledTimes(1);
expect(mentionedMember.ban).toBeCalledWith({ reason: 'Moderator: AUTHORTAG, Reason: *none*' });
});
test('Given user has permissions, expect embeds to be correct', async () => {
process.env = {
ROLES_MODERATOR: 'Moderator',
CHANNELS_LOGS_MOD: 'mod-logs'
};
const mentionedUser = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const mentionedMember = {
bannable: true,
ban: jest.fn()
} as unknown as GuildMember;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageChannelSend = jest.fn();
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(mentionedUser);
const messageGuildMember = jest.fn()
.mockReturnValue(mentionedMember);
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
channel: {
send: messageChannelSend
},
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember ,
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
},
available: true
},
author: {
tag: 'AUTHORTAG'
}
} as unknown as Message;
const context: ICommandContext = {
name: 'ban',
args: ['ban', 'Test', 'Reason'],
message: message
};
const ban = new Ban();
const result = await ban.execute(context);
expect(result.embeds.length).toBe(2);
const logEmbed = result.embeds[0];
const publicEmbed = result.embeds[1];
expect(logEmbed.title).toBe('Member Banned');
expect(publicEmbed.title).toBe("");
expect(publicEmbed.description).toBe('[object Object] has been banned');
expect(logEmbed.fields.length).toBe(3);
expect(publicEmbed.fields.length).toBe(0);
});
test('Given user has permission, expect logEmbed fields to be correct', async () => {
process.env = {
ROLES_MODERATOR: 'Moderator',
CHANNELS_LOGS_MOD: 'mod-logs'
};
const mentionedUser = {
displayAvatarURL: jest.fn().mockReturnValue('URL'),
tag: 'USERTAG'
} as unknown as User;
const mentionedMember = {
bannable: true,
ban: jest.fn()
} as unknown as GuildMember;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageChannelSend = jest.fn();
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(mentionedUser);
const messageGuildMember = jest.fn()
.mockReturnValue(mentionedMember);
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
channel: {
send: messageChannelSend
},
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember ,
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
},
available: true
},
author: {
tag: 'AUTHORTAG'
}
} as unknown as Message;
const context: ICommandContext = {
name: 'ban',
args: ['ban', 'Test', 'Reason'],
message: message
};
const ban = new Ban();
const result = await ban.execute(context);
const logEmbed = result.embeds[0];
const fieldUser = logEmbed.fields[0];
const fieldModerator = logEmbed.fields[1];
const fieldReason = logEmbed.fields[2];
expect(fieldUser.name).toBe("User");
expect(fieldUser.value).toBe("[object Object] `USERTAG`");
expect(logEmbed.thumbnail?.url).toBe("URL");
expect(fieldModerator.name).toBe('Moderator');
expect(fieldModerator.value).toBe('[object Object] `AUTHORTAG`');
expect(fieldReason.name).toBe('Reason');
expect(fieldReason.value).toBe('Test Reason');
});
test('Given moderator did not supply a reason, expect reason field to be default message', async () => {
process.env = {
ROLES_MODERATOR: 'Moderator',
CHANNELS_LOGS_MOD: 'mod-logs'
};
const mentionedUser = {
displayAvatarURL: jest.fn().mockReturnValue('URL'),
tag: 'USERTAG'
} as unknown as User;
const mentionedMember = {
bannable: true,
ban: jest.fn()
} as unknown as GuildMember;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageChannelSend = jest.fn();
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(mentionedUser);
const messageGuildMember = jest.fn()
.mockReturnValue(mentionedMember);
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
channel: {
send: messageChannelSend
},
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember ,
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
},
available: true
},
author: {
tag: 'AUTHORTAG'
}
} as unknown as Message;
const context: ICommandContext = {
name: 'ban',
args: ['ban'],
message: message
};
const ban = new Ban();
const result = await ban.execute(context);
const logEmbed = result.embeds[0];
const fieldUser = logEmbed.fields[0];
const fieldModerator = logEmbed.fields[1];
const fieldReason = logEmbed.fields[2];
expect(fieldUser.name).toBe("User");
expect(fieldUser.value).toBe("[object Object] `USERTAG`");
expect(logEmbed.thumbnail?.url).toBe("URL");
expect(fieldModerator.name).toBe('Moderator');
expect(fieldModerator.value).toBe('[object Object] `AUTHORTAG`');
expect(fieldReason.name).toBe('Reason');
expect(fieldReason.value).toBe('*none*');
});
test('Given user is not mentioned, expect error embed to be sent', async () => {
process.env = {
ROLES_MODERATOR: 'Moderator',
CHANNELS_LOGS_MOD: 'mod-logs'
};
const mentionedMember = {
bannable: true,
ban: jest.fn()
} as unknown as GuildMember;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageChannelSend = jest.fn();
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(null);
const messageGuildMember = jest.fn()
.mockReturnValue(mentionedMember);
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
channel: {
send: messageChannelSend
},
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember ,
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
},
available: true
},
author: {
tag: 'AUTHORTAG'
}
} as unknown as Message;
const context: ICommandContext = {
name: 'ban',
args: ['ban', 'Test', 'Reason'],
message: message
};
const ban = new Ban();
const result = await ban.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(logChannel.send).not.toBeCalled();
expect(mentionedMember.ban).not.toBeCalled();
expect(result.embeds.length).toBe(1);
const embedError = result.embeds[0];
expect(embedError.description).toBe('User does not exist');
});
test('Given member is not in server, expect error embed to be sent', async () => {
process.env = {
ROLES_MODERATOR: 'Moderator',
CHANNELS_LOGS_MOD: 'mod-logs'
};
const mentionedUser = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const mentionedMember = {
bannable: true,
ban: jest.fn()
} as unknown as GuildMember;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageChannelSend = jest.fn();
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(mentionedUser);
const messageGuildMember = jest.fn()
.mockReturnValue(null);
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
channel: {
send: messageChannelSend
},
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember ,
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
},
available: true
},
author: {
tag: 'AUTHORTAG'
}
} as unknown as Message;
const context: ICommandContext = {
name: 'ban',
args: ['ban', 'Test', 'Reason'],
message: message
};
const ban = new Ban();
const result = await ban.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(logChannel.send).not.toBeCalled();
expect(mentionedMember.ban).not.toBeCalled();
expect(result.embeds.length).toBe(1);
const embedError = result.embeds[0];
expect(embedError.description).toBe('User is not in this server');
});
test('Given guild is unavailable, expect return and do nothing', async () => {
process.env = {
ROLES_MODERATOR: 'Moderator',
CHANNELS_LOGS_MOD: 'mod-logs'
};
const mentionedUser = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const mentionedMember = {
bannable: true,
ban: jest.fn()
} as unknown as GuildMember;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageChannelSend = jest.fn();
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(mentionedUser);
const messageGuildMember = jest.fn()
.mockReturnValue(mentionedMember);
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
channel: {
send: messageChannelSend
},
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember ,
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
},
available: false
},
author: {
tag: 'AUTHORTAG'
}
} as unknown as Message;
const context: ICommandContext = {
name: 'ban',
args: ['ban', 'Test', 'Reason'],
message: message
};
const ban = new Ban();
const result = await ban.execute(context);
expect(messageChannelSend).not.toBeCalled();
expect(logChannel.send).not.toBeCalled();
expect(mentionedMember.ban).not.toBeCalled();
expect(result.embeds.length).toBe(0);
});
test('Given bot cant ban user, expect error embed to be sent', async () => {
process.env = {
ROLES_MODERATOR: 'Moderator',
CHANNELS_LOGS_MOD: 'mod-logs'
};
const mentionedUser = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const mentionedMember = {
bannable: false,
ban: jest.fn()
} as unknown as GuildMember;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageChannelSend = jest.fn();
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(mentionedUser);
const messageGuildMember = jest.fn()
.mockReturnValue(mentionedMember);
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
channel: {
send: messageChannelSend
},
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember ,
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
},
available: true
},
author: {
tag: 'AUTHORTAG'
}
} as unknown as Message;
const context: ICommandContext = {
name: 'ban',
args: ['ban', 'Test', 'Reason'],
message: message
};
const ban = new Ban();
const result = await ban.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(logChannel.send).not.toBeCalled();
expect(mentionedMember.ban).not.toBeCalled();
expect(result.embeds.length).toBe(1);
const embedError = result.embeds[0];
expect(embedError.description).toBe('Unable to do this action, am I missing permissions?');
});
});

View file

@ -1,178 +0,0 @@
import { Message } from "discord.js";
import Clear from "../../src/commands/clear";
import { ICommandContext } from "../../src/contracts/ICommandContext";
beforeEach(() => {
process.env = {};
});
describe('Constructor', () => {
test('Expect values to be set', () => {
process.env = {
ROLES_MODERATOR: "Moderator"
};
const clear = new Clear();
expect(clear._category).toBe('Moderation');
expect(clear._roles.length).toBe(1);
expect(clear._roles[0]).toBe('Moderator');
});
});
describe('Execute', () => {
test('Given valid arguments, expect messages to be cleared', async () => {
const messageChannelSend = jest.fn();
const messageChannelBulkDelete = jest.fn();
const message = {
channel: {
send: messageChannelSend,
bulkDelete: messageChannelBulkDelete
}
} as unknown as Message;
const context: ICommandContext = {
name: 'clear',
args: ['5'],
message: message
};
const clear = new Clear();
const result = await clear.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(messageChannelBulkDelete).toBeCalledWith(5);
expect(result.embeds.length).toBe(1);
// PublicEmbed
const publicEmbed = result.embeds[0];
expect(publicEmbed.title).toBe('');
expect(publicEmbed.description).toBe('5 message(s) were removed');
});
test('Given argument is not given, expect error embed to be sent', async () => {
const messageChannelSend = jest.fn();
const messageChannelBulkDelete = jest.fn();
const message = {
channel: {
send: messageChannelSend,
bulkDelete: messageChannelBulkDelete
}
} as unknown as Message;
const context: ICommandContext = {
name: 'clear',
args: [],
message: message
};
const clear = new Clear();
const result = await clear.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(messageChannelBulkDelete).not.toBeCalled();
expect(result.embeds.length).toBe(1);
// ErrorEmbed
const errorEmbed = result.embeds[0];
expect(errorEmbed.title).toBeNull();
expect(errorEmbed.description).toBe('Please specify an amount between 1 and 100');
});
test('Given argument is not a number, expect error embed to be sent', async () => {
const messageChannelSend = jest.fn();
const messageChannelBulkDelete = jest.fn();
const message = {
channel: {
send: messageChannelSend,
bulkDelete: messageChannelBulkDelete
}
} as unknown as Message;
const context: ICommandContext = {
name: 'clear',
args: ['A'],
message: message
};
const clear = new Clear();
const result = await clear.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(messageChannelBulkDelete).not.toBeCalled();
expect(result.embeds.length).toBe(1);
// ErrorEmbed
const errorEmbed = result.embeds[0];
expect(errorEmbed.title).toBeNull();
expect(errorEmbed.description).toBe('Please specify an amount between 1 and 100');
});
test('Given argument is less than 1, expect error embed to be sent', async () => {
const messageChannelSend = jest.fn();
const messageChannelBulkDelete = jest.fn();
const message = {
channel: {
send: messageChannelSend,
bulkDelete: messageChannelBulkDelete
}
} as unknown as Message;
const context: ICommandContext = {
name: 'clear',
args: ['0'],
message: message
};
const clear = new Clear();
const result = await clear.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(messageChannelBulkDelete).not.toBeCalled();
expect(result.embeds.length).toBe(1);
// ErrorEmbed
const errorEmbed = result.embeds[0];
expect(errorEmbed.title).toBeNull();
expect(errorEmbed.description).toBe('Please specify an amount between 1 and 100');
});
test('Given argument is more than 100, expect error embed to be sent', async () => {
const messageChannelSend = jest.fn();
const messageChannelBulkDelete = jest.fn();
const message = {
channel: {
send: messageChannelSend,
bulkDelete: messageChannelBulkDelete
}
} as unknown as Message;
const context: ICommandContext = {
name: 'clear',
args: ['101'],
message: message
};
const clear = new Clear();
const result = await clear.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(messageChannelBulkDelete).not.toBeCalled();
expect(result.embeds.length).toBe(1);
// ErrorEmbed
const errorEmbed = result.embeds[0];
expect(errorEmbed.title).toBeNull();
expect(errorEmbed.description).toBe('Please specify an amount between 1 and 100');
});
});

View file

@ -1,136 +0,0 @@
import { Message } from "discord.js";
import Evaluate from "../../src/commands/eval";
import { ICommandContext } from "../../src/contracts/ICommandContext";
beforeEach(() => {
process.env = {};
});
describe('Constructor', () => {
test('Expect values to be set', () => {
const evaluate = new Evaluate();
expect(evaluate._category).toBe('Owner');
});
});
describe('Execute', () => {
test('Given user has permission, expect eval statement ran', () => {
process.env = {
BOT_OWNERID: 'OWNERID'
};
console.log = jest.fn();
global.eval = jest.fn()
.mockReturnValue('General Kenobi');
const messageChannelSend = jest.fn();
const message = {
author: {
id: 'OWNERID'
},
channel: {
send: messageChannelSend
}
} as unknown as Message;
const context: ICommandContext = {
name: 'eval',
args: ['echo', 'Hello', 'there'],
message: message
};
const evaluate = new Evaluate();
const result = evaluate.execute(context);
expect(console.log).toBeCalledWith('Eval Statement: echo Hello there');
expect(global.eval).toBeCalledWith('echo Hello there');
expect(result.embeds.length).toBe(1);
// PublicEmbed
const publicEmbed = result.embeds[0];
expect(publicEmbed.title).toBe('');
expect(publicEmbed.description).toBe('General Kenobi');
});
test('Given user does not have permission, expect nothing to occur', () => {
process.env = {
BOT_OWNERID: 'DIFFERENT'
};
console.log = jest.fn();
global.eval = jest.fn()
.mockReturnValue('General Kenobi');
const messageChannelSend = jest.fn();
const message = {
author: {
id: 'OWNERID'
},
channel: {
send: messageChannelSend
}
} as unknown as Message;
const context: ICommandContext = {
name: 'eval',
args: ['echo', 'Hello', 'there'],
message: message
};
const evaluate = new Evaluate();
const result = evaluate.execute(context);
expect(console.log).not.toBeCalled();
expect(global.eval).not.toBeCalled();
expect(result.embeds.length).toBe(0);
});
test('Given eval failed, expect error embed to be sent', () => {
process.env = {
BOT_OWNERID: 'OWNERID'
};
console.log = jest.fn();
global.eval = jest.fn()
.mockImplementation(() => {
throw new Error('Error message');
});
const messageChannelSend = jest.fn();
const message = {
author: {
id: 'OWNERID'
},
channel: {
send: messageChannelSend
}
} as unknown as Message;
const context: ICommandContext = {
name: 'eval',
args: ['echo', 'Hello', 'there'],
message: message
};
const evaluate = new Evaluate();
const result = evaluate.execute(context);
expect(console.log).toBeCalledWith('Eval Statement: echo Hello there');
expect(global.eval).toBeCalledWith('echo Hello there');
expect(result.embeds.length).toBe(1);
// ErrorEmbed
const errorEmbed = result.embeds[0];
expect(errorEmbed.title).toBeNull();
expect(errorEmbed.description).toBe('Error: Error message');
});
});

View file

@ -1,267 +0,0 @@
import Help, { ICommandData } from "../../src/commands/help";
import { Message } from "discord.js";
import { ICommandContext } from "../../src/contracts/ICommandContext";
const oldCwd = process.cwd();
describe('Constructor', () => {
test('Expect properties to be set', () => {
const help = new Help();
expect(help._category).toBe('General');
});
});
describe('Execute', () => {
test('Given no arguments were given, expect SendAll to be executed', () => {
const message = {} as unknown as Message;
const context: ICommandContext = {
name: 'help',
args: [],
message: message
};
const help = new Help();
help.SendAll = jest.fn();
help.SendSingle = jest.fn();
help.execute(context);
expect(help.SendAll).toBeCalled();
expect(help.SendSingle).not.toBeCalled();
});
test('Given an argument was given, expect SendSingle to be executed', () => {
const message = {} as unknown as Message;
const context: ICommandContext = {
name: 'help',
args: ['about'],
message: message
};
const help = new Help();
help.SendAll = jest.fn();
help.SendSingle = jest.fn();
help.execute(context);
expect(help.SendAll).not.toBeCalled();
expect(help.SendSingle).toBeCalled();
});
});
describe('SendAll', () => {
test('Expect embed with all commands to be sent', () => {
const messageChannelSend = jest.fn();
const message = {
channel: {
send: messageChannelSend
}
} as unknown as Message;
const context: ICommandContext = {
name: 'help',
args: [],
message: message
};
const help = new Help();
const commandData0: ICommandData = {
Exists: true,
Name: 'about',
Category: 'general',
Roles: []
};
const commandData1: ICommandData = {
Exists: true,
Name: 'role',
Category: 'general',
Roles: []
};
help.GetAllCommandData = jest.fn()
.mockReturnValue([commandData0, commandData1]);
const result = help.SendAll(context);
expect(help.GetAllCommandData).toBeCalled();
expect(messageChannelSend).toBeCalled();
expect(result.embeds.length).toBe(1);
// PublicEmbed
const publicEmbed = result.embeds[0];
expect(publicEmbed.fields.length).toBe(1);
// PublicEmbed -> GeneralCategory Field
const publicEmbedFieldGeneral = publicEmbed.fields[0];
expect(publicEmbedFieldGeneral.name).toBe('General');
expect(publicEmbedFieldGeneral.value).toBe('about, role');
});
});
describe('SendSingle', () => {
test('Given command exists, expect embed to be sent with command fields', () => {
const messageChannelSend = jest.fn();
const message = {
channel: {
send: messageChannelSend
}
} as unknown as Message;
const context: ICommandContext = {
name: 'help',
args: ['about'],
message: message
};
const commandData: ICommandData = {
Exists: true,
Name: 'about',
Category: 'general',
Roles: ['role1', 'role2']
};
const help = new Help();
help.GetCommandData = jest.fn()
.mockReturnValue(commandData);
const result = help.SendSingle(context);
expect(help.GetCommandData).toBeCalledWith('about');
expect(messageChannelSend).toBeCalled();
expect(result.embeds.length).toBe(1);
// PublicEmbed
const publicEmbed = result.embeds[0];
expect(publicEmbed.title).toBe('About');
expect(publicEmbed.description).toBe('');
expect(publicEmbed.fields.length).toBe(2);
// PublicEmbed -> Category Field
const fieldCategory = publicEmbed.fields[0];
expect(fieldCategory.name).toBe('Category');
expect(fieldCategory.value).toBe('General');
// PublicEmbed -> RequiredRoles Field
const fieldRoles = publicEmbed.fields[1];
expect(fieldRoles.name).toBe('Required Roles');
expect(fieldRoles.value).toBe('Role1, Role2');
});
test('Given command does not exist, expect error embed to be sent', () => {
const messageChannelSend = jest.fn();
const message = {
channel: {
send: messageChannelSend
}
} as unknown as Message;
const context: ICommandContext = {
name: 'help',
args: ['about'],
message: message
};
const commandData: ICommandData = {
Exists: false
};
const help = new Help();
help.GetCommandData = jest.fn()
.mockReturnValue(commandData);
const result = help.SendSingle(context);
expect(help.GetCommandData).toBeCalledWith('about');
expect(messageChannelSend).toBeCalled();
expect(result.embeds.length).toBe(1);
// ErrorEmbed
const errorEmbed = result.embeds[0];
expect(errorEmbed.description).toBe('Command does not exist');
});
});
describe('GetAllCommandData', () => {
test('Expect array of command data to be returned', () => {
process.env = {
FOLDERS_COMMANDS: "commands"
};
process.cwd = jest.fn()
.mockReturnValue(`${oldCwd}/tests/_mocks`);
const help = new Help();
const result = help.GetAllCommandData();
expect(result.length).toBe(1);
// Mock Command
const mockCommand = result[0];
expect(mockCommand.Exists).toBeTruthy();
expect(mockCommand.Name).toBe("mockCmd");
expect(mockCommand.Category).toBe("General");
expect(mockCommand.Roles!.length).toBe(1);
expect(mockCommand.Roles![0]).toBe("Moderator");
});
});
describe('GetCommandData', () => {
test('Given command exists, expect data to be returned', () => {
process.env = {
FOLDERS_COMMANDS: "commands"
};
process.cwd = jest.fn()
.mockReturnValue(`${oldCwd}/tests/_mocks`);
const help = new Help();
const result = help.GetCommandData('mockCmd');
expect(result.Exists).toBeTruthy();
expect(result.Name).toBe("mockCmd");
expect(result.Category).toBe("General");
expect(result.Roles!.length).toBe(1);
expect(result.Roles![0]).toBe("Moderator");
});
test('Given command does not exist, expect exists false to be returned', () => {
process.env = {
FOLDERS_COMMANDS: "commands"
};
const oldCwd = process.cwd();
process.cwd = jest.fn()
.mockReturnValue(`${oldCwd}/tests/_mocks`);
const help = new Help();
const result = help.GetCommandData('none');
expect(result.Exists).toBeFalsy();
});
});

View file

@ -1,549 +0,0 @@
import { mock } from "jest-mock-extended";
import { GuildMember, Message, TextChannel, User } from "discord.js";
import Kick from "../../src/commands/kick";
import { ICommandContext } from "../../src/contracts/ICommandContext";
beforeEach(() => {
process.env = {};
});
describe('Constructor', () => {
test('Expect properties to be set', () => {
process.env = {
ROLES_MODERATOR: "Moderator"
};
const kick = new Kick();
expect(kick._category).toBe('Moderation');
expect(kick._roles.length).toBe(1);
expect(kick._roles[0]).toBe('Moderator');
});
});
describe('Execute', () => {
test('Given user has permission, expect user to be kicked', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs'
};
const user = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const member = {
kickable: true,
kick: jest.fn()
} as unknown as GuildMember;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(user);
const messageGuildMember = jest.fn()
.mockReturnValue(member);
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const messageChannelSend = jest.fn();
const message = {
channel: {
send: messageChannelSend
},
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember,
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
},
available: true
},
author: {
tag: 'AUTHORTAG'
}
} as unknown as Message;
const context: ICommandContext = {
name: "kick",
args: ["USER", "Test", "Reason"],
message: message
}
const kick = new Kick();
const result = await kick.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(logChannel.send).toBeCalledTimes(1);
expect(member.kick).toBeCalledWith('Moderator: AUTHORTAG, Reason: Test Reason');
expect(result.embeds.length).toBe(2);
// Log Embed
const logEmbed = result.embeds[0];
expect(logEmbed.title).toBe('Member Kicked');
expect(logEmbed.fields.length).toBe(3);
// Log Embed -> User Field
const logEmbedFieldUser = logEmbed.fields[0];
expect(logEmbedFieldUser.name).toBe('User');
expect(logEmbedFieldUser.value).toBe('[object Object] `USERTAG`');
expect(logEmbedFieldUser.inline).toBeTruthy();
// Log Embed -> Moderator Field
const logEmbedFieldModerator = logEmbed.fields[1];
expect(logEmbedFieldModerator.name).toBe('Moderator');
expect(logEmbedFieldModerator.value).toBe('[object Object] `AUTHORTAG`');
// Log Embed -> Reason Field
const logEmbedFieldReason = logEmbed.fields[2];
expect(logEmbedFieldReason.name).toBe('Reason');
expect(logEmbedFieldReason.value).toBe('Test Reason');
});
test('Given moderator did not supply a reason, expect default reason to be added', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs'
};
const user = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const member = {
kickable: true,
kick: jest.fn()
} as unknown as GuildMember;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(user);
const messageGuildMember = jest.fn()
.mockReturnValue(member);
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const messageChannelSend = jest.fn();
const message = {
channel: {
send: messageChannelSend
},
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember,
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
},
available: true
},
author: {
tag: 'AUTHORTAG'
}
} as unknown as Message;
const context: ICommandContext = {
name: "kick",
args: ["USER"],
message: message
}
const kick = new Kick();
const result = await kick.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(logChannel.send).toBeCalledTimes(1);
expect(member.kick).toBeCalledWith('Moderator: AUTHORTAG, Reason: *none*');
expect(result.embeds.length).toBe(2);
// Log Embed
const logEmbed = result.embeds[0];
expect(logEmbed.title).toBe('Member Kicked');
expect(logEmbed.fields.length).toBe(3);
// Log Embed -> User Field
const logEmbedFieldUser = logEmbed.fields[0];
expect(logEmbedFieldUser.name).toBe('User');
expect(logEmbedFieldUser.value).toBe('[object Object] `USERTAG`');
expect(logEmbedFieldUser.inline).toBeTruthy();
// Log Embed -> Moderator Field
const logEmbedFieldModerator = logEmbed.fields[1];
expect(logEmbedFieldModerator.name).toBe('Moderator');
expect(logEmbedFieldModerator.value).toBe('[object Object] `AUTHORTAG`');
// Log Embed -> Reason Field
const logEmbedFieldReason = logEmbed.fields[2];
expect(logEmbedFieldReason.name).toBe('Reason');
expect(logEmbedFieldReason.value).toBe('*none*');
});
test('Given target user is not found, expect user does not exist error', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs'
}
const user = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const member = {
kickable: true,
kick: jest.fn()
} as unknown as GuildMember;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(null);
const messageGuildMember = jest.fn()
.mockReturnValue(member);
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const messageChannelSend = jest.fn();
const message = {
channel: {
send: messageChannelSend
},
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember,
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
},
available: true
},
author: {
tag: 'AUTHORTAG'
}
} as unknown as Message;
const context: ICommandContext = {
name: "kick",
args: ["USER", "Test", "Reason"],
message: message
}
const kick = new Kick();
const result = await kick.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(logChannel.send).not.toBeCalled();
expect(member.kick).not.toBeCalled();
expect(result.embeds.length).toBe(1);
// Embed
const embed = result.embeds[0];
expect(embed.title).toBe(null);
expect(embed.description).toBe('User does not exist');
});
test('Given target member is not found, expect user is not in this server error', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs'
}
const user = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const member = {
kickable: true,
kick: jest.fn()
} as unknown as GuildMember;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(user);
const messageGuildMember = jest.fn()
.mockReturnValue(null);
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const messageChannelSend = jest.fn();
const message = {
channel: {
send: messageChannelSend
},
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember,
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
},
available: true
},
author: {
tag: 'AUTHORTAG'
}
} as unknown as Message;
const context: ICommandContext = {
name: "kick",
args: ["USER", "Test", "Reason"],
message: message
}
const kick = new Kick();
const result = await kick.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(logChannel.send).not.toBeCalled();
expect(member.kick).not.toBeCalled();
expect(result.embeds.length).toBe(1);
// Embed
const embed = result.embeds[0];
expect(embed.title).toBe(null);
expect(embed.description).toBe('User is not in this server');
});
test('Given guild is not available, expect to stop', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs'
}
const user = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const member = {
kickable: true,
kick: jest.fn()
} as unknown as GuildMember;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(user);
const messageGuildMember = jest.fn()
.mockReturnValue(member);
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const messageChannelSend = jest.fn();
const message = {
channel: {
send: messageChannelSend
},
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember,
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
},
available: false
},
author: {
tag: 'AUTHORTAG'
}
} as unknown as Message;
const context: ICommandContext = {
name: "kick",
args: ["USER", "Test", "Reason"],
message: message
}
const kick = new Kick();
const result = await kick.execute(context);
expect(messageChannelSend).not.toBeCalled();
expect(logChannel.send).not.toBeCalled();
expect(member.kick).not.toBeCalled();
expect(result.embeds.length).toBe(0);
});
test('Given client can not kick member, expect error', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs'
}
const user = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const member = {
kickable: false,
kick: jest.fn()
} as unknown as GuildMember;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(user);
const messageGuildMember = jest.fn()
.mockReturnValue(member);
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const messageChannelSend = jest.fn();
const message = {
channel: {
send: messageChannelSend
},
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember,
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
},
available: true
},
author: {
tag: 'AUTHORTAG'
}
} as unknown as Message;
const context: ICommandContext = {
name: "kick",
args: ["USER", "Test", "Reason"],
message: message
}
const kick = new Kick();
const result = await kick.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(logChannel.send).not.toBeCalled();
expect(member.kick).not.toBeCalled();
expect(result.embeds.length).toBe(1);
// Embed
const embed = result.embeds[0];
expect(embed.title).toBe(null);
expect(embed.description).toBe('Unable to do this action, am I missing permissions?');
});
});

View file

@ -1,815 +0,0 @@
import { mock } from "jest-mock-extended";
import { GuildMember, Message, Role, TextChannel, User } from "discord.js";
import Mute from "../../src/commands/mute";
import { ICommandContext } from "../../src/contracts/ICommandContext";
beforeEach(() => {
process.env = {};
});
describe('Constructor', () => {
test('Expect properties to be set', () => {
process.env = {
ROLES_MODERATOR: 'Moderator'
};
const mute = new Mute();
expect(mute._category).toBe("Moderation");
expect(mute._roles.length).toBe(1);
expect(mute._roles[0]).toBe('Moderator');
});
});
describe('Execute', () => {
test('Given user has permission, expect user to be given muted role', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs',
ROLES_MUTED: 'Muted'
};
const user = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const messageAuthor = {
tag: 'AUTHORTAG'
} as unknown as User;
const member = {
manageable: true,
roles: {
add: jest.fn()
}
} as unknown as GuildMember;
const role = {
name: 'Muted'
} as unknown as Role;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(user);
const messageGuildMember = jest.fn()
.mockReturnValue(member);
const messageGuildRolesCacheFind = jest.fn()
.mockImplementation((callback): Role | undefined => {
const result = callback(role);
if (!result) {
return undefined;
}
return role;
});
const messageChannelSend = jest.fn();
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember,
available: true,
roles: {
cache: {
find: messageGuildRolesCacheFind
}
},
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
}
},
channel: {
send: messageChannelSend
},
author: messageAuthor
} as unknown as Message;
const context: ICommandContext = {
name: 'mute',
args: ['USER', 'Test', 'Reason'],
message: message
};
const mute = new Mute();
const result = await mute.execute(context);
expect(messageMentionsUsersFirst).toBeCalledTimes(1);
expect(messageGuildMember).toBeCalledWith(user);
expect(messageGuildRolesCacheFind).toBeCalledTimes(1);
expect(messageGuildChannelsCacheFind).toBeCalledTimes(1);
expect(messageChannelSend).toBeCalledTimes(1);
expect(member.roles.add).toBeCalledWith(role, 'Moderator: AUTHORTAG, Reason: Test Reason');
expect(result.embeds.length).toBe(2);
// Log Embed
const logEmbed = result.embeds[0];
expect(logEmbed.title).toBe('Member Muted');
expect(logEmbed.fields.length).toBe(3);
// Log Embed -> User Field
const logEmbedUserField = logEmbed.fields[0];
expect(logEmbedUserField.name).toBe('User');
expect(logEmbedUserField.value).toBe('[object Object] `USERTAG`');
expect(logEmbedUserField.inline).toBeTruthy();
// Log Embed -> Moderator Field
const logEmbedModeratorField = logEmbed.fields[1];
expect(logEmbedModeratorField.name).toBe('Moderator');
expect(logEmbedModeratorField.value).toBe('[object Object] `AUTHORTAG`');
// Log Embed -> Reason Field
const logEmbedFieldReason = logEmbed.fields[2];
expect(logEmbedFieldReason.name).toBe('Reason');
expect(logEmbedFieldReason.value).toBe('Test Reason');
// Public Embed
const publicEmbed = result.embeds[1];
expect(publicEmbed.title).toBe('');
expect(publicEmbed.description).toBe('[object Object] has been muted');
});
test('Given moderator did not supply a reason, expect default reason used', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs',
ROLES_MUTED: 'Muted'
};
const user = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const messageAuthor = {
tag: 'AUTHORTAG'
} as unknown as User;
const member = {
manageable: true,
roles: {
add: jest.fn()
}
} as unknown as GuildMember;
const role = {
name: 'Muted'
} as unknown as Role;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(user);
const messageGuildMember = jest.fn()
.mockReturnValue(member);
const messageGuildRolesCacheFind = jest.fn()
.mockImplementation((callback): Role | undefined => {
const result = callback(role);
if (!result) {
return undefined;
}
return role;
});
const messageChannelSend = jest.fn();
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember,
available: true,
roles: {
cache: {
find: messageGuildRolesCacheFind
}
},
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
}
},
channel: {
send: messageChannelSend
},
author: messageAuthor
} as unknown as Message;
const context: ICommandContext = {
name: 'mute',
args: ['USER'],
message: message
};
const mute = new Mute();
const result = await mute.execute(context);
expect(messageMentionsUsersFirst).toBeCalledTimes(1);
expect(messageGuildMember).toBeCalledWith(user);
expect(messageGuildRolesCacheFind).toBeCalledTimes(1);
expect(messageGuildChannelsCacheFind).toBeCalledTimes(1);
expect(messageChannelSend).toBeCalledTimes(1);
expect(member.roles.add).toBeCalledWith(role, 'Moderator: AUTHORTAG, Reason: *none*');
expect(result.embeds.length).toBe(2);
// Log Embed
const logEmbed = result.embeds[0];
expect(logEmbed.title).toBe('Member Muted');
expect(logEmbed.fields.length).toBe(3);
// Log Embed -> User Field
const logEmbedUserField = logEmbed.fields[0];
expect(logEmbedUserField.name).toBe('User');
expect(logEmbedUserField.value).toBe('[object Object] `USERTAG`');
expect(logEmbedUserField.inline).toBeTruthy();
// Log Embed -> Moderator Field
const logEmbedModeratorField = logEmbed.fields[1];
expect(logEmbedModeratorField.name).toBe('Moderator');
expect(logEmbedModeratorField.value).toBe('[object Object] `AUTHORTAG`');
// Log Embed -> Reason Field
const logEmbedFieldReason = logEmbed.fields[2];
expect(logEmbedFieldReason.name).toBe('Reason');
expect(logEmbedFieldReason.value).toBe('*none*');
// Public Embed
const publicEmbed = result.embeds[1];
expect(publicEmbed.title).toBe('');
expect(publicEmbed.description).toBe('[object Object] has been muted');
});
test('Given user did not mention a user, expect user not to exist', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs',
ROLES_MUTED: 'Muted'
};
const user = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const messageAuthor = {
tag: 'AUTHORTAG'
} as unknown as User;
const member = {
manageable: true,
roles: {
add: jest.fn()
}
} as unknown as GuildMember;
const role = {
name: 'Muted'
} as unknown as Role;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(null);
const messageGuildMember = jest.fn()
.mockReturnValue(member);
const messageGuildRolesCacheFind = jest.fn()
.mockImplementation((callback): Role | undefined => {
const result = callback(role);
if (!result) {
return undefined;
}
return role;
});
const messageChannelSend = jest.fn();
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember,
available: true,
roles: {
cache: {
find: messageGuildRolesCacheFind
}
},
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
}
},
channel: {
send: messageChannelSend
},
author: messageAuthor
} as unknown as Message;
const context: ICommandContext = {
name: 'mute',
args: ['USER', 'Test', 'Reason'],
message: message
};
const mute = new Mute();
const result = await mute.execute(context);
expect(messageMentionsUsersFirst).toBeCalledTimes(1);
expect(messageGuildMember).not.toBeCalled();
expect(messageGuildRolesCacheFind).not.toBeCalled();
expect(messageGuildChannelsCacheFind).not.toBeCalled();
expect(messageChannelSend).toBeCalledTimes(1);
expect(result.embeds.length).toBe(1);
// Error Embed
const errorEmbed = result.embeds[0];
expect(errorEmbed.description).toBe('User does not exist');
});
test('Given member can not be found from user, expect user to not be in server', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs',
ROLES_MUTED: 'Muted'
};
const user = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const messageAuthor = {
tag: 'AUTHORTAG'
} as unknown as User;
const member = {
manageable: true,
roles: {
add: jest.fn()
}
} as unknown as GuildMember;
const role = {
name: 'Muted'
} as unknown as Role;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(user);
const messageGuildMember = jest.fn()
.mockReturnValue(null);
const messageGuildRolesCacheFind = jest.fn()
.mockImplementation((callback): Role | undefined => {
const result = callback(role);
if (!result) {
return undefined;
}
return role;
});
const messageChannelSend = jest.fn();
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember,
available: true,
roles: {
cache: {
find: messageGuildRolesCacheFind
}
},
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
}
},
channel: {
send: messageChannelSend
},
author: messageAuthor
} as unknown as Message;
const context: ICommandContext = {
name: 'mute',
args: ['USER', 'Test', 'Reason'],
message: message
};
const mute = new Mute();
const result = await mute.execute(context);
expect(messageMentionsUsersFirst).toBeCalledTimes(1);
expect(messageGuildMember).toBeCalledWith(user);
expect(messageGuildRolesCacheFind).not.toBeCalled();
expect(messageGuildChannelsCacheFind).not.toBeCalled();
expect(messageChannelSend).toBeCalledTimes(1);
expect(result.embeds.length).toBe(1);
// Error Embed
const errorEmbed = result.embeds[0];
expect(errorEmbed.description).toBe('User is not in this server');
});
test('Given guild is unavailable, expect execution to stop', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs',
ROLES_MUTED: 'Muted'
};
const user = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const messageAuthor = {
tag: 'AUTHORTAG'
} as unknown as User;
const member = {
manageable: true,
roles: {
add: jest.fn()
}
} as unknown as GuildMember;
const role = {
name: 'Muted'
} as unknown as Role;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(user);
const messageGuildMember = jest.fn()
.mockReturnValue(member);
const messageGuildRolesCacheFind = jest.fn()
.mockImplementation((callback): Role | undefined => {
const result = callback(role);
if (!result) {
return undefined;
}
return role;
});
const messageChannelSend = jest.fn();
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember,
available: false,
roles: {
cache: {
find: messageGuildRolesCacheFind
}
},
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
}
},
channel: {
send: messageChannelSend
},
author: messageAuthor
} as unknown as Message;
const context: ICommandContext = {
name: 'mute',
args: ['USER', 'Test', 'Reason'],
message: message
};
const mute = new Mute();
const result = await mute.execute(context);
expect(messageMentionsUsersFirst).toBeCalledTimes(1);
expect(messageGuildMember).toBeCalledWith(user);
expect(messageGuildRolesCacheFind).not.toBeCalled();
expect(messageGuildChannelsCacheFind).not.toBeCalled();
expect(messageChannelSend).not.toBeCalled();
expect(result.embeds.length).toBe(0);
});
test('Given client can not manage user, expect insufficient permissions', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs',
ROLES_MUTED: 'Muted'
};
const user = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const messageAuthor = {
tag: 'AUTHORTAG'
} as unknown as User;
const member = {
manageable: false,
roles: {
add: jest.fn()
}
} as unknown as GuildMember;
const role = {
name: 'Muted'
} as unknown as Role;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(user);
const messageGuildMember = jest.fn()
.mockReturnValue(member);
const messageGuildRolesCacheFind = jest.fn()
.mockImplementation((callback): Role | undefined => {
const result = callback(role);
if (!result) {
return undefined;
}
return role;
});
const messageChannelSend = jest.fn();
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember,
available: true,
roles: {
cache: {
find: messageGuildRolesCacheFind
}
},
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
}
},
channel: {
send: messageChannelSend
},
author: messageAuthor
} as unknown as Message;
const context: ICommandContext = {
name: 'mute',
args: ['USER', 'Test', 'Reason'],
message: message
};
const mute = new Mute();
const result = await mute.execute(context);
expect(messageMentionsUsersFirst).toBeCalledTimes(1);
expect(messageGuildMember).toBeCalledWith(user);
expect(messageGuildRolesCacheFind).not.toBeCalled();
expect(messageGuildChannelsCacheFind).not.toBeCalled();
expect(messageChannelSend).toBeCalledTimes(1);
expect(result.embeds.length).toBe(1);
// Error Embed
const errorEmbed = result.embeds[0];
expect(errorEmbed.description).toBe('Unable to do this action, am I missing permissions?');
});
test('Given muted role can not be found, expect role not found', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs',
ROLES_MUTED: 'Muted'
};
const user = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const messageAuthor = {
tag: 'AUTHORTAG'
} as unknown as User;
const member = {
manageable: true,
roles: {
add: jest.fn()
}
} as unknown as GuildMember;
const role = {
name: 'Muted'
} as unknown as Role;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(user);
const messageGuildMember = jest.fn()
.mockReturnValue(member);
const messageGuildRolesCacheFind = jest.fn()
.mockReturnValue(undefined);
const messageChannelSend = jest.fn();
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember,
available: true,
roles: {
cache: {
find: messageGuildRolesCacheFind
}
},
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
}
},
channel: {
send: messageChannelSend
},
author: messageAuthor
} as unknown as Message;
const context: ICommandContext = {
name: 'mute',
args: ['USER', 'Test', 'Reason'],
message: message
};
const mute = new Mute();
const result = await mute.execute(context);
expect(messageMentionsUsersFirst).toBeCalledTimes(1);
expect(messageGuildMember).toBeCalledWith(user);
expect(messageGuildRolesCacheFind).toBeCalledTimes(1);
expect(messageGuildChannelsCacheFind).not.toBeCalled();
expect(messageChannelSend).toBeCalledTimes(1);
expect(result.embeds.length).toBe(1);
// Error Embed
const errorEmbed = result.embeds[0];
expect(errorEmbed.description).toBe('Unable to find role');
});
});

View file

@ -1,262 +0,0 @@
import { Message, MessageEmbed } from "discord.js";
import Poll from "../../src/commands/poll";
import { ICommandContext } from "../../src/contracts/ICommandContext";
describe('Constructor', () => {
test('Expect properties to be set', () => {
const poll = new Poll();
expect(poll._category).toBe('General');
});
});
describe('Execute', () => {
test('Given input is valid, expect poll to be generated', async () => {
const returnMessageReact = jest.fn();
const returnMessage = {
react: returnMessageReact
} as unknown as Message;
const messageChannelSend = jest.fn()
.mockReturnValue(returnMessage);
const messageDelete = jest.fn();
const message = {
channel: {
send: messageChannelSend
},
delete: messageDelete,
deletable: true
} as unknown as Message;
const context: ICommandContext = {
name: 'poll',
args: ['Test', 'title;', 'one;', 'two'],
message: message
};
const poll = new Poll();
const result = await poll.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(messageDelete).toBeCalledTimes(1);
expect(returnMessageReact).toBeCalledTimes(2);
expect(result.embeds.length).toBe(1);
// Embed
const embed = result.embeds[0];
expect(embed.title).toBe('Test title');
expect(embed.description).toBe(':one: one\n:two: two');
});
test('Given message is not deletable by client, expect it not to attempt deletion', async () => {
const returnMessageReact = jest.fn();
const returnMessage = {
react: returnMessageReact
} as unknown as Message;
const messageChannelSend = jest.fn()
.mockReturnValue(returnMessage);
const messageDelete = jest.fn();
const message = {
channel: {
send: messageChannelSend
},
delete: messageDelete,
deletable: false
} as unknown as Message;
const context: ICommandContext = {
name: 'poll',
args: ['Test', 'title;', 'one;', 'two'],
message: message
};
const poll = new Poll();
const result = await poll.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(messageDelete).not.toBeCalled();
expect(returnMessageReact).toBeCalledTimes(2);
expect(result.embeds.length).toBe(1);
// Embed
const embed = result.embeds[0];
expect(embed.title).toBe('Test title');
expect(embed.description).toBe(':one: one\n:two: two');
});
test('Given no arguments, expect error embed', async () => {
const returnMessageReact = jest.fn();
const returnMessage = {
react: returnMessageReact
} as unknown as Message;
const messageChannelSend = jest.fn()
.mockReturnValue(returnMessage);
const messageDelete = jest.fn();
const message = {
channel: {
send: messageChannelSend
},
delete: messageDelete,
deletable: true
} as unknown as Message;
const context: ICommandContext = {
name: 'poll',
args: [],
message: message
};
const poll = new Poll();
const result = await poll.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(messageDelete).not.toBeCalled();
expect(returnMessageReact).not.toBeCalled();
expect(result.embeds.length).toBe(1);
// Error Embed
const errorEmbed = result.embeds[0];
expect(errorEmbed.description).toBe('Usage: <title>;<option 1>;<option 2>... (separate options with semicolons), maximum of 9 options');
});
test('Given only 1 option, expect error embed', async () => {
const returnMessageReact = jest.fn();
const returnMessage = {
react: returnMessageReact
} as unknown as Message;
const messageChannelSend = jest.fn()
.mockReturnValue(returnMessage);
const messageDelete = jest.fn();
const message = {
channel: {
send: messageChannelSend
},
delete: messageDelete,
deletable: true
} as unknown as Message;
const context: ICommandContext = {
name: 'poll',
args: ['Test', 'title;', 'one'],
message: message
};
const poll = new Poll();
const result = await poll.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(messageDelete).not.toBeCalled();
expect(returnMessageReact).not.toBeCalled();
expect(result.embeds.length).toBe(1);
// Error Embed
const errorEmbed = result.embeds[0];
expect(errorEmbed.description).toBe('Usage: <title>;<option 1>;<option 2>... (separate options with semicolons), maximum of 9 options');
});
test('Given 9 options, expect poll to be generated', async () => {
const returnMessageReact = jest.fn();
const returnMessage = {
react: returnMessageReact
} as unknown as Message;
const messageChannelSend = jest.fn()
.mockReturnValue(returnMessage);
const messageDelete = jest.fn();
const message = {
channel: {
send: messageChannelSend
},
delete: messageDelete,
deletable: true
} as unknown as Message;
const context: ICommandContext = {
name: 'poll',
args: ['Test', 'title;', 'one;', 'two;', 'three;', 'four;', 'five;', 'six;', 'seven;', 'eight;', 'nine'],
message: message
};
const poll = new Poll();
const result = await poll.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(messageDelete).toBeCalledTimes(1);
expect(returnMessageReact).toBeCalledTimes(9);
expect(result.embeds.length).toBe(1);
// Embed
const embed = result.embeds[0];
expect(embed.title).toBe('Test title');
expect(embed.description).toBe(':one: one\n:two: two\n:three: three\n:four: four\n:five: five\n:six: six\n:seven: seven\n:eight: eight\n:nine: nine');
});
test('Given 10 options, expect error embed', async () => {
const returnMessageReact = jest.fn();
const returnMessage = {
react: returnMessageReact
} as unknown as Message;
const messageChannelSend = jest.fn()
.mockReturnValue(returnMessage);
const messageDelete = jest.fn();
const message = {
channel: {
send: messageChannelSend
},
delete: messageDelete,
deletable: true
} as unknown as Message;
const context: ICommandContext = {
name: 'poll',
args: ['Test', 'title;', 'one;', 'two;', 'three;', 'four;', 'five;', 'six;', 'seven;', 'eight;', 'nine;', 'ten'],
message: message
};
const poll = new Poll();
const result = await poll.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(messageDelete).not.toBeCalled();
expect(returnMessageReact).not.toBeCalled();
expect(result.embeds.length).toBe(1);
// Error Embed
const errorEmbed = result.embeds[0];
expect(errorEmbed.description).toBe('Usage: <title>;<option 1>;<option 2>... (separate options with semicolons), maximum of 9 options');
});
});

View file

@ -1,411 +0,0 @@
import { GuildMemberRoleManager, Message, Role as DiscordRole } from "discord.js";
import { mock } from "jest-mock-extended";
import Role from "../../src/commands/role";
import { ICommandContext } from "../../src/contracts/ICommandContext";
beforeEach(() => {
process.env = {};
});
describe('Constructor', () => {
test('Expect properties are set', () => {
const role = new Role();
expect(role._category).toBe("General");
});
});
describe('Execute', () => {
test('Given no arguments were given, expect SendRolesList to be executed', async () => {
process.env = {
COMMANDS_ROLE_ROLES: 'One,Two'
};
const message = {} as unknown as Message;
const context: ICommandContext = {
name: 'role',
args: [],
message: message
};
const role = new Role();
role.SendRolesList = jest.fn();
role.ToggleRole = jest.fn();
await role.execute(context);
expect(role.SendRolesList).toBeCalledWith(context, ['One', 'Two']);
expect(role.ToggleRole).not.toBeCalled();
});
test('Given an argument was given, expect ToggleRole to be executed', async () => {
process.env = {
COMMANDS_ROLE_ROLES: 'One,Two'
};
const message = {} as unknown as Message;
const context: ICommandContext = {
name: 'role',
args: ['One'],
message: message
};
const role = new Role();
role.SendRolesList = jest.fn();
role.ToggleRole = jest.fn();
await role.execute(context);
expect(role.SendRolesList).not.toBeCalled();
expect(role.ToggleRole).toBeCalledWith(context, ['One', 'Two']);
});
});
describe('SendRolesList', () => {
test('Expect embed with roles to be sent to the current channel', () => {
process.env = {
BOT_PREFIX: '!'
};
const messageChannelSend = jest.fn();
const message = {
channel: {
send: messageChannelSend
}
} as unknown as Message;
const context: ICommandContext = {
name: 'role',
args: [],
message: message
};
const roles = ['One', 'Two'];
const role = new Role();
const result = role.SendRolesList(context, roles);
expect(messageChannelSend).toBeCalledTimes(1);
expect(result.embeds.length).toBe(1);
// Embed
const embed = result.embeds[0];
expect(embed.title).toBe('Roles');
expect(embed.description).toBe('Do !role <role> to get the role!\nOne\nTwo');
});
});
describe('ToggleRole', () => {
test('Given role name is a valid role AND user does not have the role, expect role to be added', async () => {
const discordRole = {} as unknown as DiscordRole;
const messageMemberRolesCacheFind = jest.fn()
.mockReturnValue(undefined);
const messageGuildRolesCacheFind = jest.fn()
.mockReturnValue(discordRole);
const messageChannelSend = jest.fn();
const message = {
member: {
roles: {
cache: {
find: messageMemberRolesCacheFind
}
}
},
guild: {
roles: {
cache: {
find: messageGuildRolesCacheFind
}
}
},
channel: {
send: messageChannelSend
}
} as unknown as Message;
const context: ICommandContext = {
name: 'role',
args: ['One'],
message: message
};
const roles = ['One', 'Two'];
const role = new Role();
role.AddRole = jest.fn();
role.RemoveRole = jest.fn();
const result = await role.ToggleRole(context, roles);
expect(messageMemberRolesCacheFind).toBeCalledTimes(1);
expect(messageGuildRolesCacheFind).toBeCalledTimes(1);
expect(messageChannelSend).not.toBeCalled();
expect(role.AddRole).toBeCalledWith(context, discordRole);
expect(role.RemoveRole).not.toBeCalled();
expect(result.embeds.length).toBe(0);
});
test('Given role name is a valid role AND user has the role, expect role to be removed', async () => {
const discordRole = {} as unknown as DiscordRole;
const messageMemberRolesCacheFind = jest.fn()
.mockReturnValue(discordRole);
const messageGuildRolesCacheFind = jest.fn()
.mockReturnValue(discordRole);
const messageChannelSend = jest.fn();
const message = {
member: {
roles: {
cache: {
find: messageMemberRolesCacheFind
}
}
},
guild: {
roles: {
cache: {
find: messageGuildRolesCacheFind
}
}
},
channel: {
send: messageChannelSend
}
} as unknown as Message;
const context: ICommandContext = {
name: 'role',
args: ['One'],
message: message
};
const roles = ['One', 'Two'];
const role = new Role();
role.AddRole = jest.fn();
role.RemoveRole = jest.fn();
const result = await role.ToggleRole(context, roles);
expect(messageMemberRolesCacheFind).toBeCalledTimes(1);
expect(messageGuildRolesCacheFind).toBeCalledTimes(1);
expect(messageChannelSend).not.toBeCalled();
expect(role.AddRole).not.toBeCalled();
expect(role.RemoveRole).toBeCalledWith(context, discordRole);
expect(result.embeds.length).toBe(0);
});
test('Given role requested is not in the roles array, expect role not assignable error', async () => {
const discordRole = {} as unknown as DiscordRole;
const messageMemberRolesCacheFind = jest.fn()
.mockReturnValue(undefined);
const messageGuildRolesCacheFind = jest.fn()
.mockReturnValue(discordRole);
const messageChannelSend = jest.fn();
const message = {
member: {
roles: {
cache: {
find: messageMemberRolesCacheFind
}
}
},
guild: {
roles: {
cache: {
find: messageGuildRolesCacheFind
}
}
},
channel: {
send: messageChannelSend
}
} as unknown as Message;
const context: ICommandContext = {
name: 'role',
args: ['Three'],
message: message
};
const roles = ['One', 'Two'];
const role = new Role();
role.AddRole = jest.fn();
role.RemoveRole = jest.fn();
const result = await role.ToggleRole(context, roles);
expect(messageMemberRolesCacheFind).not.toBeCalled();
expect(messageGuildRolesCacheFind).not.toBeCalled();
expect(messageChannelSend).toBeCalledTimes(1);
expect(role.AddRole).not.toBeCalled();
expect(role.RemoveRole).not.toBeCalled();
expect(result.embeds.length).toBe(1);
// Error Embed
const errorEmbed = result.embeds[0];
expect(errorEmbed.description).toBe("This role isn't marked as assignable, to see a list of assignable roles, run this command without any parameters");
});
test('Given the role is not in the guild, expect error', async () => {
const discordRole = {} as unknown as DiscordRole;
const messageMemberRolesCacheFind = jest.fn()
.mockReturnValue(undefined);
const messageGuildRolesCacheFind = jest.fn()
.mockReturnValue(undefined);
const messageChannelSend = jest.fn();
const message = {
member: {
roles: {
cache: {
find: messageMemberRolesCacheFind
}
}
},
guild: {
roles: {
cache: {
find: messageGuildRolesCacheFind
}
}
},
channel: {
send: messageChannelSend
}
} as unknown as Message;
const context: ICommandContext = {
name: 'role',
args: ['One'],
message: message
};
const roles = ['One', 'Two'];
const role = new Role();
role.AddRole = jest.fn();
role.RemoveRole = jest.fn();
const result = await role.ToggleRole(context, roles);
expect(messageMemberRolesCacheFind).not.toBeCalled();
expect(messageGuildRolesCacheFind).toBeCalledTimes(1);
expect(messageChannelSend).toBeCalledTimes(1);
expect(role.AddRole).not.toBeCalled();
expect(role.RemoveRole).not.toBeCalled();
expect(result.embeds.length).toBe(1);
// Error Embed
const errorEmbed = result.embeds[0];
expect(errorEmbed.description).toBe("The current server doesn't have this role. Please contact the server's moderators");
});
});
describe('AddRole', () => {
test('Expect role to be added to user', async () => {
const messageChannelSend = jest.fn();
const guildMemberRoleManager = mock<GuildMemberRoleManager>();
const message = {
member: {
roles: guildMemberRoleManager
},
channel: {
send: messageChannelSend
}
} as unknown as Message;
const context: ICommandContext = {
name: 'role',
args: ['One'],
message: message
};
const discordRole = {
name: 'One'
} as unknown as DiscordRole;
const role = new Role();
const result = await role.AddRole(context, discordRole);
expect(guildMemberRoleManager.add).toBeCalledWith(discordRole, "Toggled with role command");
expect(messageChannelSend).toBeCalled();
expect(result.embeds.length).toBe(1);
// Embed
const embed = result.embeds[0];
expect(embed.title).toBe('');
expect(embed.description).toBe('Gave role: One');
});
});
describe('RemoveRole', () => {
test('Expect role to be removed from user', async () => {
const messageChannelSend = jest.fn();
const guildMemberRoleManager = mock<GuildMemberRoleManager>();
const message = {
member: {
roles: guildMemberRoleManager
},
channel: {
send: messageChannelSend
}
} as unknown as Message;
const context: ICommandContext = {
name: 'role',
args: ['One'],
message: message
};
const discordRole = {
name: 'One'
} as unknown as DiscordRole;
const role = new Role();
const result = await role.RemoveRole(context, discordRole);
expect(guildMemberRoleManager.remove).toBeCalledWith(discordRole, "Toggled with role command");
expect(messageChannelSend).toBeCalled();
expect(result.embeds.length).toBe(1);
// Embed
const embed = result.embeds[0];
expect(embed.title).toBe('');
expect(embed.description).toBe('Removed role: One');
});
});

View file

@ -1,106 +0,0 @@
import { Message } from "discord.js";
import Rules from "../../src/commands/rules";
import { ICommandContext } from "../../src/contracts/ICommandContext";
const oldCwd = process.cwd();
beforeEach(() => {
process.env = {};
});
describe('Constructor', () => {
test('Expect properties to be set', () => {
process.env = {
ROLES_MODERATOR: "Moderator"
};
const rules = new Rules();
expect(rules._category).toBe("Admin");
expect(rules._roles.length).toBe(1);
expect(rules._roles[0]).toBe("Moderator");
});
});
describe('Execute', () => {
test('Given rules exist, expect rules to be sent to current channel', () => {
process.env = {
COMMANDS_RULES_FILE: 'rules/rules.json'
};
process.cwd = jest.fn()
.mockReturnValue(`${oldCwd}/tests/_mocks`);
const messageChannelSend = jest.fn();
const message = {
channel: {
send: messageChannelSend
}
} as unknown as Message;
const context: ICommandContext = {
name: 'rules',
args: [],
message: message
};
const rules = new Rules();
const result = rules.execute(context);
expect(messageChannelSend).toBeCalledTimes(2);
expect(result.embeds.length).toBe(2);
// Header Embed
const embedHeader = result.embeds[0];
expect(embedHeader.title).toBe("");
expect(embedHeader.description).toBe("");
expect(embedHeader.image?.url).toBe("IMAGEURL");
expect(embedHeader.footer?.text).toBe("");
// Main Embed
const embedMain = result.embeds[1];
expect(embedMain.title).toBe("TITLE 1");
expect(embedMain.description).toBe("DESCRIPTION 1A\nDESCRIPTION 1B");
expect(embedMain.image?.url).toBe("");
expect(embedMain.footer?.text).toBe("FOOTER 1");
});
test('Given rules file does not exist, expect does not exist error', () => {
process.env = {
COMMANDS_RULES_FILE: 'rules/none.json'
};
process.cwd = jest.fn()
.mockReturnValue(`${oldCwd}/tests/_mocks`);
const messageChannelSend = jest.fn();
const message = {
channel: {
send: messageChannelSend
}
} as unknown as Message;
const context: ICommandContext = {
name: 'rules',
args: [],
message: message
};
const rules = new Rules();
const result = rules.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(result.embeds.length).toBe(1);
// Error Embed
const errorEmbed = result.embeds[0];
expect(errorEmbed.description).toBe("Rules file doesn't exist");
});
});

View file

@ -1,766 +0,0 @@
import { APIEmbed, CacheType, CommandInteraction, CommandInteractionOption, DMChannel, Embed, EmbedBuilder, EmbedField, Guild, GuildChannel, GuildMember, InteractionReplyOptions, JSONEncodable, Message, MessageCreateOptions, MessagePayload, SlashCommandBuilder, TextChannel, User } from "discord.js";
import { mock } from "jest-mock-extended";
import Timeout from "../../src/commands/timeout";
import SettingsHelper from "../../src/helpers/SettingsHelper";
import Audit from "../../src/database/entities/Audit";
import EmbedColours from "../../src/constants/EmbedColours";
import { DeepPartial, EntityTarget } from "typeorm";
import BaseEntity from "../../src/contracts/BaseEntity";
import { AuditType } from "../../src/constants/AuditType";
describe('Constructor', () => {
test('EXPECT CommandBuilder to be configured', () => {
const command = new Timeout();
expect(command.CommandBuilder).toBeDefined();
const commandBuilder = command.CommandBuilder as SlashCommandBuilder;
expect(commandBuilder.name).toBe("timeout");
expect(commandBuilder.description).toBe("Timeouts a user out, sending them a DM with the reason if possible");
expect(commandBuilder.options.length).toBe(3);
});
});
describe('execute', () => {
// Happy flow
test('GIVEN all checks have passed, EXPECT user to be timed out', async () => {
let embeds: APIEmbed[] | undefined;
const command = new Timeout();
const interactionReply = jest.fn((options: InteractionReplyOptions) => {
embeds = options.embeds as APIEmbed[];
});
let savedAudit: DeepPartial<Audit> | undefined;
const getSetting = jest.spyOn(SettingsHelper, 'GetSetting').mockResolvedValue('mod-logs');
const auditSave = jest.spyOn(Audit.prototype, 'Save').mockImplementation((target: EntityTarget<BaseEntity>, entity: DeepPartial<BaseEntity>): Promise<void> => {
savedAudit = entity;
return Promise.resolve();
});
const timeoutFunc = jest.fn();
let dmChannelSentEmbeds: (APIEmbed | JSONEncodable<APIEmbed>)[] | undefined;
let logsChannelSentEmbeds: (APIEmbed | JSONEncodable<APIEmbed>)[] | undefined;
const dmChannel = {
send: jest.fn().mockImplementation((options: MessageCreateOptions) => {
dmChannelSentEmbeds = options.embeds;
}),
} as unknown as DMChannel;
const userInput = {
user: {
id: 'userId',
tag: 'userTag',
createDM: jest.fn().mockResolvedValue(dmChannel),
} as unknown as User,
member: {
manageable: true,
timeout: timeoutFunc,
} as unknown as GuildMember,
} as CommandInteractionOption;
const lengthInput = {
value: '1s',
} as CommandInteractionOption;
const reasonInput = {
value: 'Test reason',
} as CommandInteractionOption;
const logsChannel = {
name: 'mod-logs',
send: jest.fn().mockImplementation((options: MessageCreateOptions) => {
logsChannelSentEmbeds = options.embeds;
}),
} as unknown as TextChannel;
const interaction = {
guild: {
channels: {
cache: {
find: jest.fn()
.mockReturnValue(logsChannel),
}
},
name: "Test Guild",
} as unknown as Guild,
guildId: 'guildId',
reply: interactionReply,
options: {
get: jest.fn()
.mockReturnValueOnce(userInput)
.mockReturnValueOnce(lengthInput)
.mockReturnValue(reasonInput),
},
user: {
id: 'moderatorId'
}
} as unknown as CommandInteraction;
await command.execute(interaction);
// EXPECT user to be timed out
expect(timeoutFunc).toBeCalledWith(1000, 'Test reason');
// EXPECT embeds to be sent
expect(embeds).toBeDefined();
expect(embeds!.length).toBe(1);
// EXPECT resultEmbed to be correctly configured
const resultEmbed = embeds![0] as EmbedBuilder;
expect(resultEmbed.data.description).toBe('<@userId> has been timed out');
expect(resultEmbed.data.fields).toBeDefined();
expect(resultEmbed.data.fields!.length).toBe(1);
// EXPECT DM field to be configured
const resultEmbedDMField = resultEmbed.data.fields![0];
expect(resultEmbedDMField.name).toBe("DM Sent");
expect(resultEmbedDMField.value).toBe("true");
// EXPECT user to be DM's with embed
expect(dmChannel.send).toBeCalled();
expect(dmChannelSentEmbeds).toBeDefined();
expect(dmChannelSentEmbeds?.length).toBe(1);
const dmChannelSentEmbed = (dmChannelSentEmbeds![0] as any).data;
expect(dmChannelSentEmbed.color).toBe(EmbedColours.Ok);
expect(dmChannelSentEmbed.description).toBe("You have been timed out in Test Guild");
expect(dmChannelSentEmbed.fields?.length).toBe(3);
expect(dmChannelSentEmbed.fields![0].name).toBe("Reason");
expect(dmChannelSentEmbed.fields![0].value).toBe("Test reason");
expect(dmChannelSentEmbed.fields![1].name).toBe("Length");
expect(dmChannelSentEmbed.fields![1].value).toBe("1s");
expect(dmChannelSentEmbed.fields![2].name).toBe("Until");
expect(dmChannelSentEmbed.fields![2].value).toBeDefined();
// EXPECT log embed to be sent
expect(logsChannel.send).toBeCalled();
expect(logsChannelSentEmbeds).toBeDefined();
expect(logsChannelSentEmbeds?.length).toBe(1);
const logsChannelSentEmbed = (logsChannelSentEmbeds![0] as any).data;
expect(logsChannelSentEmbed.color).toBe(EmbedColours.Ok);
expect(logsChannelSentEmbed.title).toBe("Member Timed Out");
expect(logsChannelSentEmbed.description).toBe("<@userId> `userTag`");
expect(logsChannelSentEmbed.fields?.length).toBe(4);
expect(logsChannelSentEmbed.fields![0].name).toBe("Moderator");
expect(logsChannelSentEmbed.fields![0].value).toBe("<@moderatorId>");
expect(logsChannelSentEmbed.fields![1].name).toBe("Reason");
expect(logsChannelSentEmbed.fields![1].value).toBe("Test reason");
expect(logsChannelSentEmbed.fields![2].name).toBe("Length");
expect(logsChannelSentEmbed.fields![2].value).toBe("1s");
expect(logsChannelSentEmbed.fields![3].name).toBe("Until");
expect(logsChannelSentEmbed.fields![3].value).toBeDefined();
// EXPECT Audit to be saved
expect(auditSave).toBeCalled();
expect(savedAudit).toBeDefined();
expect(savedAudit?.UserId).toBe('userId');
expect(savedAudit?.AuditType).toBe(AuditType.Timeout);
expect(savedAudit?.Reason).toBe("Test reason");
expect(savedAudit?.ModeratorId).toBe('moderatorId');
expect(savedAudit?.ServerId).toBe('guildId');
});
// Null checks
test('GIVEN interaction.guild IS NULL, EXPECT nothing to happen', async () => {
const command = new Timeout();
const interaction = {
guild: null,
reply: jest.fn(),
} as unknown as CommandInteraction;
await command.execute(interaction);
expect(interaction.reply).not.toBeCalled();
});
test('GIVEN interaction.guildId IS NULL, EXPECT nothing to happen', async () => {
const command = new Timeout();
const interaction = {
guild: mock<Guild>(),
guildId: null,
reply: jest.fn(),
} as unknown as CommandInteraction;
await command.execute(interaction);
expect(interaction.reply).not.toBeCalled();
});
// Validation
test('GIVEN targetUser IS NULL, EXPECT validation error', async () => {
const command = new Timeout();
const interaction = {
reply: jest.fn(),
guild: mock<Guild>(),
guildId: 'guildId',
options: {
get: jest.fn().mockReturnValue(undefined),
}
} as unknown as CommandInteraction;
await command.execute(interaction);
expect(interaction.reply).toBeCalledWith('Fields are required.');
});
test('GIVEN targetUser.user IS NULL, EXPECT validation error', async () => {
const command = new Timeout();
const interaction = {
reply: jest.fn(),
guild: mock<Guild>(),
guildId: 'guildId',
options: {
get: jest.fn((value: string): CommandInteractionOption<CacheType> | null => {
switch (value) {
case 'target':
return {} as CommandInteractionOption;
case 'length':
return {
value: '1m',
} as CommandInteractionOption;
case 'reason':
return {
value: 'Test reason',
} as CommandInteractionOption;
default:
return null;
}
}),
}
} as unknown as CommandInteraction;
await command.execute(interaction);
expect(interaction.reply).toBeCalledWith('Fields are required.');
});
test('GIVEN targetUser.member IS NULL, EXPECT validation error', async () => {
const command = new Timeout();
const interaction = {
reply: jest.fn(),
guild: mock<Guild>(),
guildId: 'guildId',
options: {
get: jest.fn((value: string): CommandInteractionOption<CacheType> | null => {
switch (value) {
case 'target':
return {
user: {} as User,
} as CommandInteractionOption;
case 'length':
return {
value: '1m',
} as CommandInteractionOption;
case 'reason':
return {
value: 'Test reason',
} as CommandInteractionOption;
default:
return null;
}
}),
}
} as unknown as CommandInteraction;
await command.execute(interaction);
expect(interaction.reply).toBeCalledWith('Fields are required.');
});
test('GIVEN lengthInput IS NULL, EXPECT validation error', async () => {
const command = new Timeout();
const interaction = {
reply: jest.fn(),
guild: mock<Guild>(),
guildId: 'guildId',
options: {
get: jest.fn((value: string): CommandInteractionOption<CacheType> | null => {
switch (value) {
case 'target':
return {
user: {} as User,
member: {} as GuildMember
} as CommandInteractionOption;
case 'length':
return null;
case 'reason':
return {
value: 'Test reason',
} as CommandInteractionOption;
default:
return null;
}
}),
}
} as unknown as CommandInteraction;
await command.execute(interaction);
expect(interaction.reply).toBeCalledWith('Fields are required.');
});
test('GIVEN lengthInput.value IS NULL, EXPECT validation error', async () => {
const command = new Timeout();
const interaction = {
reply: jest.fn(),
guild: mock<Guild>(),
guildId: 'guildId',
options: {
get: jest.fn((value: string): CommandInteractionOption<CacheType> | null => {
switch (value) {
case 'target':
return {
user: {} as User,
member: {} as GuildMember
} as CommandInteractionOption;
case 'length':
return {
value: undefined,
} as CommandInteractionOption;
case 'reason':
return {
value: 'Test reason',
} as CommandInteractionOption;
default:
return null;
}
}),
}
} as unknown as CommandInteraction;
await command.execute(interaction);
expect(interaction.reply).toBeCalledWith('Fields are required.');
});
test('GIVEN targetUser is a bot, EXPECT error', async () => {
const interaction = {
reply: jest.fn(),
guild: mock<Guild>(),
guildId: 'guildId',
options: {
get: jest.fn((value: string): CommandInteractionOption<CacheType> | null => {
switch (value) {
case 'target':
return {
user: {
bot: true,
} as User,
member: {} as GuildMember
} as CommandInteractionOption;
case 'length':
return {
value: '1m',
} as CommandInteractionOption;
case 'reason':
return {
value: 'Test reason',
} as CommandInteractionOption;
default:
return null;
}
}),
}
} as unknown as CommandInteraction;
const command = new Timeout();
await command.execute(interaction);
expect(interaction.reply).toBeCalledWith('Cannot timeout bots.');
});
test('GIVEN targetMember IS NOT manageable by the bot, EXPECT insufficient permissions error', async () => {
const command = new Timeout();
const interaction = {
reply: jest.fn(),
guild: mock<Guild>(),
guildId: 'guildId',
user: {
id: 'moderatorId',
},
options: {
get: jest.fn((value: string): CommandInteractionOption<CacheType> | null => {
switch (value) {
case 'target':
return {
user: {
id: 'userId',
tag: 'userTag',
} as User,
member: {
manageable: false,
} as GuildMember
} as CommandInteractionOption;
case 'length':
return {
value: '1m',
} as CommandInteractionOption;
case 'reason':
return {
value: 'Test reason',
} as CommandInteractionOption;
default:
return null;
}
}),
}
} as unknown as CommandInteraction;
await command.execute(interaction);
expect(interaction.reply).toBeCalledWith('Insufficient bot permissions. Please contact a moderator.');
});
// Reason variable
test('GIVEN reason IS NULL, EXPECT to be ran with empty string', async () => {
const command = new Timeout();
let savedAudit: DeepPartial<Audit> | undefined;
const auditSave = jest.spyOn(Audit.prototype, 'Save').mockImplementation((target: EntityTarget<BaseEntity>, entity: DeepPartial<BaseEntity>): Promise<void> => {
savedAudit = entity;
return Promise.resolve();
});
const timeoutFunc = jest.fn();
const sentEmbeds: EmbedBuilder[] = [];
const interaction = {
reply: jest.fn(),
guild: {
channels: {
cache: {
find: jest.fn().mockReturnValue(mock<TextChannel>()),
}
}
},
guildId: 'guildId',
user: {
id: 'moderatorId',
},
options: {
get: jest.fn((value: string): CommandInteractionOption<CacheType> | null => {
switch (value) {
case 'target':
return {
user: {
id: 'userId',
tag: 'userTag',
createDM: jest.fn().mockReturnValue({
send: jest.fn(async (options: MessageCreateOptions): Promise<Message<false>> => {
sentEmbeds.push(options.embeds![0] as EmbedBuilder);
return mock<Message<false>>();
})
}) as unknown as DMChannel,
} as unknown as User,
member: {
manageable: true,
timeout: timeoutFunc,
} as unknown as GuildMember
} as CommandInteractionOption;
case 'length':
return {
value: '1m'
} as CommandInteractionOption;
case 'reason':
return {
value: undefined,
} as CommandInteractionOption;
default:
return null;
}
}),
}
} as unknown as CommandInteraction;
await command.execute(interaction);
expect(timeoutFunc).toBeCalledWith(1000 * 60 * 1, "");
expect(savedAudit?.Reason).toBe("*none*");
const dmEmbed = (sentEmbeds[0] as any).data;
const dmEmbedReasonField = dmEmbed.fields![0] as EmbedField;
expect(dmEmbedReasonField.value).toBe("*none*");
});
// Log embed
test('GIVEN channelName IS NULL, EXPECT execution to return', async () => {
const command = new Timeout();
let savedAudit: DeepPartial<Audit> | undefined;
const auditSave = jest.spyOn(Audit.prototype, 'Save').mockImplementation((target: EntityTarget<BaseEntity>, entity: DeepPartial<BaseEntity>): Promise<void> => {
savedAudit = entity;
return Promise.resolve();
});
const settingsGet = jest.spyOn(SettingsHelper, 'GetSetting').mockResolvedValue(undefined);
const timeoutFunc = jest.fn();
const sentEmbeds: EmbedBuilder[] = [];
const logChannelSendFunc = jest.fn();
const interaction = {
reply: jest.fn(),
guild: {
channels: {
cache: {
find: jest.fn().mockReturnValue({
send: logChannelSendFunc,
} as unknown as TextChannel),
}
}
},
guildId: 'guildId',
user: {
id: 'moderatorId',
},
options: {
get: jest.fn((value: string): CommandInteractionOption<CacheType> | null => {
switch (value) {
case 'target':
return {
user: {
id: 'userId',
tag: 'userTag',
createDM: jest.fn().mockReturnValue({
send: jest.fn(async (options: MessageCreateOptions): Promise<Message<false>> => {
sentEmbeds.push(options.embeds![0] as EmbedBuilder);
return mock<Message<false>>();
})
}) as unknown as DMChannel,
} as unknown as User,
member: {
manageable: true,
timeout: timeoutFunc,
} as unknown as GuildMember
} as CommandInteractionOption;
case 'length':
return {
value: '1m'
} as CommandInteractionOption;
case 'reason':
return {
value: 'Test reason',
} as CommandInteractionOption;
default:
return null;
}
}),
}
} as unknown as CommandInteraction;
await command.execute(interaction);
expect(timeoutFunc).toBeCalled();
expect(sentEmbeds.length).toBe(0);
expect(logChannelSendFunc).not.toBeCalled();
});
test('GIVEN channel IS NULL, EXPECT embed to not be sent', async () => {
const command = new Timeout();
let savedAudit: DeepPartial<Audit> | undefined;
const auditSave = jest.spyOn(Audit.prototype, 'Save').mockImplementation((target: EntityTarget<BaseEntity>, entity: DeepPartial<BaseEntity>): Promise<void> => {
savedAudit = entity;
return Promise.resolve();
});
const settingsGet = jest.spyOn(SettingsHelper, 'GetSetting').mockResolvedValue('mod-logs');
const timeoutFunc = jest.fn();
const sentEmbeds: EmbedBuilder[] = [];
const interaction = {
reply: jest.fn(),
guild: {
channels: {
cache: {
find: jest.fn().mockReturnValue(undefined),
}
}
},
guildId: 'guildId',
user: {
id: 'moderatorId',
},
options: {
get: jest.fn((value: string): CommandInteractionOption<CacheType> | null => {
switch (value) {
case 'target':
return {
user: {
id: 'userId',
tag: 'userTag',
createDM: jest.fn().mockReturnValue({
send: jest.fn(async (options: MessageCreateOptions): Promise<Message<false>> => {
sentEmbeds.push(options.embeds![0] as EmbedBuilder);
return mock<Message<false>>();
})
}) as unknown as DMChannel,
} as unknown as User,
member: {
manageable: true,
timeout: timeoutFunc,
} as unknown as GuildMember
} as CommandInteractionOption;
case 'length':
return {
value: '1m'
} as CommandInteractionOption;
case 'reason':
return {
value: 'Test reason',
} as CommandInteractionOption;
default:
return null;
}
}),
}
} as unknown as CommandInteraction;
await command.execute(interaction);
expect(timeoutFunc).toBeCalled();
expect(sentEmbeds.length).toBeGreaterThan(0);
});
// DM user
test('GIVEN user can NOT be messaged, EXPECT resultEmbed to contain "DM Sent = false"', async () => {
let embeds: APIEmbed[] | undefined;
const command = new Timeout();
const interactionReply = jest.fn((options: InteractionReplyOptions) => {
embeds = options.embeds as APIEmbed[];
});
let savedAudit: DeepPartial<Audit> | undefined;
const getSetting = jest.spyOn(SettingsHelper, 'GetSetting').mockResolvedValue('mod-logs');
const auditSave = jest.spyOn(Audit.prototype, 'Save').mockImplementation((target: EntityTarget<BaseEntity>, entity: DeepPartial<BaseEntity>): Promise<void> => {
savedAudit = entity;
return Promise.resolve();
});
const timeoutFunc = jest.fn();
let dmChannelSentEmbeds: (APIEmbed | JSONEncodable<APIEmbed>)[] | undefined;
let logsChannelSentEmbeds: (APIEmbed | JSONEncodable<APIEmbed>)[] | undefined;
const dmChannel = {
send: jest.fn().mockImplementation((options: MessageCreateOptions) => {
dmChannelSentEmbeds = options.embeds;
}),
} as unknown as DMChannel;
const userInput = {
user: {
id: 'userId',
tag: 'userTag',
createDM: jest.fn().mockRejectedValue(undefined),
} as unknown as User,
member: {
manageable: true,
timeout: timeoutFunc,
} as unknown as GuildMember,
} as CommandInteractionOption;
const lengthInput = {
value: '1s',
} as CommandInteractionOption;
const reasonInput = {
value: 'Test reason',
} as CommandInteractionOption;
const logsChannel = {
name: 'mod-logs',
send: jest.fn().mockImplementation((options: MessageCreateOptions) => {
logsChannelSentEmbeds = options.embeds;
}),
} as unknown as TextChannel;
const interaction = {
guild: {
channels: {
cache: {
find: jest.fn()
.mockReturnValue(logsChannel),
}
},
name: "Test Guild",
} as unknown as Guild,
guildId: 'guildId',
reply: interactionReply,
options: {
get: jest.fn()
.mockReturnValueOnce(userInput)
.mockReturnValueOnce(lengthInput)
.mockReturnValue(reasonInput),
},
user: {
id: 'moderatorId'
}
} as unknown as CommandInteraction;
await command.execute(interaction);
// EXPECT embeds to be sent
expect(embeds).toBeDefined();
expect(embeds!.length).toBe(1);
const resultEmbed = embeds![0] as EmbedBuilder;
// EXPECT DM field to be configured
const resultEmbedDMField = resultEmbed.data.fields![0];
expect(resultEmbedDMField.name).toBe("DM Sent");
expect(resultEmbedDMField.value).toBe("false");
});
});

View file

@ -1,813 +0,0 @@
import { GuildMember, Message, Role, TextChannel, User } from "discord.js";
import Unmute from "../../src/commands/unmute";
import { ICommandContext } from "../../src/contracts/ICommandContext";
beforeEach(() => {
process.env = {};
});
describe('Constructor', () => {
test('Expect properties to be set', () => {
process.env = {
ROLES_MODERATOR: 'Moderator'
};
const mute = new Unmute();
expect(mute._category).toBe("Moderation");
expect(mute._roles.length).toBe(1);
expect(mute._roles[0]).toBe('Moderator');
});
});
describe('Execute', () => {
test('Given user has permission, expect user to be given muted role', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs',
ROLES_MUTED: 'Muted'
};
const user = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const messageAuthor = {
tag: 'AUTHORTAG'
} as unknown as User;
const member = {
manageable: true,
roles: {
remove: jest.fn()
}
} as unknown as GuildMember;
const role = {
name: 'Muted'
} as unknown as Role;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(user);
const messageGuildMember = jest.fn()
.mockReturnValue(member);
const messageGuildRolesCacheFind = jest.fn()
.mockImplementation((callback): Role | undefined => {
const result = callback(role);
if (!result) {
return undefined;
}
return role;
});
const messageChannelSend = jest.fn();
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember,
available: true,
roles: {
cache: {
find: messageGuildRolesCacheFind
}
},
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
}
},
channel: {
send: messageChannelSend
},
author: messageAuthor
} as unknown as Message;
const context: ICommandContext = {
name: 'mute',
args: ['USER', 'Test', 'Reason'],
message: message
};
const mute = new Unmute();
const result = await mute.execute(context);
expect(messageMentionsUsersFirst).toBeCalledTimes(1);
expect(messageGuildMember).toBeCalledWith(user);
expect(messageGuildRolesCacheFind).toBeCalledTimes(1);
expect(messageGuildChannelsCacheFind).toBeCalledTimes(1);
expect(messageChannelSend).toBeCalledTimes(1);
expect(member.roles.remove).toBeCalledWith(role, 'Moderator: AUTHORTAG, Reason: Test Reason');
expect(result.embeds.length).toBe(2);
// Log Embed
const logEmbed = result.embeds[0];
expect(logEmbed.title).toBe('Member Unmuted');
expect(logEmbed.fields.length).toBe(3);
// Log Embed -> User Field
const logEmbedUserField = logEmbed.fields[0];
expect(logEmbedUserField.name).toBe('User');
expect(logEmbedUserField.value).toBe('[object Object] `USERTAG`');
expect(logEmbedUserField.inline).toBeTruthy();
// Log Embed -> Moderator Field
const logEmbedModeratorField = logEmbed.fields[1];
expect(logEmbedModeratorField.name).toBe('Moderator');
expect(logEmbedModeratorField.value).toBe('[object Object] `AUTHORTAG`');
// Log Embed -> Reason Field
const logEmbedFieldReason = logEmbed.fields[2];
expect(logEmbedFieldReason.name).toBe('Reason');
expect(logEmbedFieldReason.value).toBe('Test Reason');
// Public Embed
const publicEmbed = result.embeds[1];
expect(publicEmbed.title).toBe('');
expect(publicEmbed.description).toBe('[object Object] has been unmuted');
});
test('Given moderator did not supply a reason, expect default reason is used', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs',
ROLES_MUTED: 'Muted'
};
const user = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const messageAuthor = {
tag: 'AUTHORTAG'
} as unknown as User;
const member = {
manageable: true,
roles: {
remove: jest.fn()
}
} as unknown as GuildMember;
const role = {
name: 'Muted'
} as unknown as Role;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(user);
const messageGuildMember = jest.fn()
.mockReturnValue(member);
const messageGuildRolesCacheFind = jest.fn()
.mockImplementation((callback): Role | undefined => {
const result = callback(role);
if (!result) {
return undefined;
}
return role;
});
const messageChannelSend = jest.fn();
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember,
available: true,
roles: {
cache: {
find: messageGuildRolesCacheFind
}
},
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
}
},
channel: {
send: messageChannelSend
},
author: messageAuthor
} as unknown as Message;
const context: ICommandContext = {
name: 'mute',
args: ['USER'],
message: message
};
const mute = new Unmute();
const result = await mute.execute(context);
expect(messageMentionsUsersFirst).toBeCalledTimes(1);
expect(messageGuildMember).toBeCalledWith(user);
expect(messageGuildRolesCacheFind).toBeCalledTimes(1);
expect(messageGuildChannelsCacheFind).toBeCalledTimes(1);
expect(messageChannelSend).toBeCalledTimes(1);
expect(member.roles.remove).toBeCalledWith(role, 'Moderator: AUTHORTAG, Reason: *none*');
expect(result.embeds.length).toBe(2);
// Log Embed
const logEmbed = result.embeds[0];
expect(logEmbed.title).toBe('Member Unmuted');
expect(logEmbed.fields.length).toBe(3);
// Log Embed -> User Field
const logEmbedUserField = logEmbed.fields[0];
expect(logEmbedUserField.name).toBe('User');
expect(logEmbedUserField.value).toBe('[object Object] `USERTAG`');
expect(logEmbedUserField.inline).toBeTruthy();
// Log Embed -> Moderator Field
const logEmbedModeratorField = logEmbed.fields[1];
expect(logEmbedModeratorField.name).toBe('Moderator');
expect(logEmbedModeratorField.value).toBe('[object Object] `AUTHORTAG`');
// Log Embed -> Reason Field
const logEmbedFieldReason = logEmbed.fields[2];
expect(logEmbedFieldReason.name).toBe('Reason');
expect(logEmbedFieldReason.value).toBe('*none*');
// Public Embed
const publicEmbed = result.embeds[1];
expect(publicEmbed.title).toBe('');
expect(publicEmbed.description).toBe('[object Object] has been unmuted');
});
test('Given user did not mention a user, expect user not to exist', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs',
ROLES_MUTED: 'Muted'
};
const user = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const messageAuthor = {
tag: 'AUTHORTAG'
} as unknown as User;
const member = {
manageable: true,
roles: {
remove: jest.fn()
}
} as unknown as GuildMember;
const role = {
name: 'Muted'
} as unknown as Role;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(null);
const messageGuildMember = jest.fn()
.mockReturnValue(member);
const messageGuildRolesCacheFind = jest.fn()
.mockImplementation((callback): Role | undefined => {
const result = callback(role);
if (!result) {
return undefined;
}
return role;
});
const messageChannelSend = jest.fn();
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember,
available: true,
roles: {
cache: {
find: messageGuildRolesCacheFind
}
},
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
}
},
channel: {
send: messageChannelSend
},
author: messageAuthor
} as unknown as Message;
const context: ICommandContext = {
name: 'mute',
args: ['USER', 'Test', 'Reason'],
message: message
};
const mute = new Unmute();
const result = await mute.execute(context);
expect(messageMentionsUsersFirst).toBeCalledTimes(1);
expect(messageGuildMember).not.toBeCalled();
expect(messageGuildRolesCacheFind).not.toBeCalled();
expect(messageGuildChannelsCacheFind).not.toBeCalled();
expect(messageChannelSend).toBeCalledTimes(1);
expect(result.embeds.length).toBe(1);
// Error Embed
const errorEmbed = result.embeds[0];
expect(errorEmbed.description).toBe('User does not exist');
});
test('Given member can not be found from user, expect user to not be in server', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs',
ROLES_MUTED: 'Muted'
};
const user = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const messageAuthor = {
tag: 'AUTHORTAG'
} as unknown as User;
const member = {
manageable: true,
roles: {
remove: jest.fn()
}
} as unknown as GuildMember;
const role = {
name: 'Muted'
} as unknown as Role;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(user);
const messageGuildMember = jest.fn()
.mockReturnValue(null);
const messageGuildRolesCacheFind = jest.fn()
.mockImplementation((callback): Role | undefined => {
const result = callback(role);
if (!result) {
return undefined;
}
return role;
});
const messageChannelSend = jest.fn();
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember,
available: true,
roles: {
cache: {
find: messageGuildRolesCacheFind
}
},
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
}
},
channel: {
send: messageChannelSend
},
author: messageAuthor
} as unknown as Message;
const context: ICommandContext = {
name: 'mute',
args: ['USER', 'Test', 'Reason'],
message: message
};
const mute = new Unmute();
const result = await mute.execute(context);
expect(messageMentionsUsersFirst).toBeCalledTimes(1);
expect(messageGuildMember).toBeCalledWith(user);
expect(messageGuildRolesCacheFind).not.toBeCalled();
expect(messageGuildChannelsCacheFind).not.toBeCalled();
expect(messageChannelSend).toBeCalledTimes(1);
expect(result.embeds.length).toBe(1);
// Error Embed
const errorEmbed = result.embeds[0];
expect(errorEmbed.description).toBe('User is not in this server');
});
test('Given guild is unavailable, expect execution to stop', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs',
ROLES_MUTED: 'Muted'
};
const user = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const messageAuthor = {
tag: 'AUTHORTAG'
} as unknown as User;
const member = {
manageable: true,
roles: {
remove: jest.fn()
}
} as unknown as GuildMember;
const role = {
name: 'Muted'
} as unknown as Role;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(user);
const messageGuildMember = jest.fn()
.mockReturnValue(member);
const messageGuildRolesCacheFind = jest.fn()
.mockImplementation((callback): Role | undefined => {
const result = callback(role);
if (!result) {
return undefined;
}
return role;
});
const messageChannelSend = jest.fn();
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember,
available: false,
roles: {
cache: {
find: messageGuildRolesCacheFind
}
},
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
}
},
channel: {
send: messageChannelSend
},
author: messageAuthor
} as unknown as Message;
const context: ICommandContext = {
name: 'mute',
args: ['USER', 'Test', 'Reason'],
message: message
};
const mute = new Unmute();
const result = await mute.execute(context);
expect(messageMentionsUsersFirst).toBeCalledTimes(1);
expect(messageGuildMember).toBeCalledWith(user);
expect(messageGuildRolesCacheFind).not.toBeCalled();
expect(messageGuildChannelsCacheFind).not.toBeCalled();
expect(messageChannelSend).not.toBeCalled();
expect(result.embeds.length).toBe(0);
});
test('Given client can not manage user, expect insufficient permissions', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs',
ROLES_MUTED: 'Muted'
};
const user = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const messageAuthor = {
tag: 'AUTHORTAG'
} as unknown as User;
const member = {
manageable: false,
roles: {
remove: jest.fn()
}
} as unknown as GuildMember;
const role = {
name: 'Muted'
} as unknown as Role;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(user);
const messageGuildMember = jest.fn()
.mockReturnValue(member);
const messageGuildRolesCacheFind = jest.fn()
.mockImplementation((callback): Role | undefined => {
const result = callback(role);
if (!result) {
return undefined;
}
return role;
});
const messageChannelSend = jest.fn();
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember,
available: true,
roles: {
cache: {
find: messageGuildRolesCacheFind
}
},
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
}
},
channel: {
send: messageChannelSend
},
author: messageAuthor
} as unknown as Message;
const context: ICommandContext = {
name: 'mute',
args: ['USER', 'Test', 'Reason'],
message: message
};
const mute = new Unmute();
const result = await mute.execute(context);
expect(messageMentionsUsersFirst).toBeCalledTimes(1);
expect(messageGuildMember).toBeCalledWith(user);
expect(messageGuildRolesCacheFind).not.toBeCalled();
expect(messageGuildChannelsCacheFind).not.toBeCalled();
expect(messageChannelSend).toBeCalledTimes(1);
expect(result.embeds.length).toBe(1);
// Error Embed
const errorEmbed = result.embeds[0];
expect(errorEmbed.description).toBe('Unable to do this action, am I missing permissions?');
});
test('Given muted role can not be found, expect role not found', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs',
ROLES_MUTED: 'Muted'
};
const user = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const messageAuthor = {
tag: 'AUTHORTAG'
} as unknown as User;
const member = {
manageable: true,
roles: {
remove: jest.fn()
}
} as unknown as GuildMember;
const role = {
name: 'Muted'
} as unknown as Role;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(user);
const messageGuildMember = jest.fn()
.mockReturnValue(member);
const messageGuildRolesCacheFind = jest.fn()
.mockReturnValue(undefined);
const messageChannelSend = jest.fn();
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember,
available: true,
roles: {
cache: {
find: messageGuildRolesCacheFind
}
},
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
}
},
channel: {
send: messageChannelSend
},
author: messageAuthor
} as unknown as Message;
const context: ICommandContext = {
name: 'mute',
args: ['USER', 'Test', 'Reason'],
message: message
};
const mute = new Unmute();
const result = await mute.execute(context);
expect(messageMentionsUsersFirst).toBeCalledTimes(1);
expect(messageGuildMember).toBeCalledWith(user);
expect(messageGuildRolesCacheFind).toBeCalledTimes(1);
expect(messageGuildChannelsCacheFind).not.toBeCalled();
expect(messageChannelSend).toBeCalledTimes(1);
expect(result.embeds.length).toBe(1);
// Error Embed
const errorEmbed = result.embeds[0];
expect(errorEmbed.description).toBe('Unable to find role');
});
});

View file

@ -1,485 +0,0 @@
import { GuildMember, Message, TextChannel, User } from "discord.js";
import Warn from "../../src/commands/warn";
import { ICommandContext } from "../../src/contracts/ICommandContext";
beforeEach(() => {
process.env = {};
});
describe('Constructor', () => {
test('Expect values to be set', () => {
process.env.ROLES_MODERATOR = 'Moderator';
const warn = new Warn();
expect(warn._category).toBe('Moderation');
expect(warn._roles.length).toBe(1);
expect(warn._roles[0]).toBe('Moderator');
});
});
describe('Execute', () => {
test('Given user has permission, expect user to be warnned', async () => {
process.env = {
ROLES_MODERATOR: 'Moderator',
CHANNELS_LOGS_MOD: 'mod-logs'
};
const mentionedUser = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const mentionedMember = {
warnnable: true,
warn: jest.fn()
} as unknown as GuildMember;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageChannelSend = jest.fn();
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(mentionedUser);
const messageGuildMember = jest.fn()
.mockReturnValue(mentionedMember);
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
channel: {
send: messageChannelSend
},
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember ,
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
},
available: true
},
author: {
tag: 'AUTHORTAG'
}
} as unknown as Message;
const context: ICommandContext = {
name: 'warn',
args: ['warn', 'Test', 'Reason'],
message: message
};
const warn = new Warn();
const result = await warn.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(logChannel.send).toBeCalledTimes(1);
});
test('Given user has permissions, expect embeds to be correct', async () => {
process.env = {
ROLES_MODERATOR: 'Moderator',
CHANNELS_LOGS_MOD: 'mod-logs'
};
const mentionedUser = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const mentionedMember = {
warnnable: true,
warn: jest.fn()
} as unknown as GuildMember;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageChannelSend = jest.fn();
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(mentionedUser);
const messageGuildMember = jest.fn()
.mockReturnValue(mentionedMember);
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
channel: {
send: messageChannelSend
},
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember ,
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
},
available: true
},
author: {
tag: 'AUTHORTAG'
}
} as unknown as Message;
const context: ICommandContext = {
name: 'warn',
args: ['warn', 'Test', 'Reason'],
message: message
};
const warn = new Warn();
const result = await warn.execute(context);
expect(result.embeds.length).toBe(2);
const logEmbed = result.embeds[0];
const publicEmbed = result.embeds[1];
expect(logEmbed.title).toBe('Member Warned');
expect(publicEmbed.title).toBe("");
expect(publicEmbed.description).toBe('[object Object] has been warned');
expect(logEmbed.fields.length).toBe(3);
expect(publicEmbed.fields.length).toBe(1);
expect(publicEmbed.fields[0].name).toBe('Reason');
expect(publicEmbed.fields[0].value).toBe('Test Reason');
});
test('Given user has permission, expect logEmbed fields to be correct', async () => {
process.env = {
ROLES_MODERATOR: 'Moderator',
CHANNELS_LOGS_MOD: 'mod-logs'
};
const mentionedUser = {
displayAvatarURL: jest.fn().mockReturnValue('URL'),
tag: 'USERTAG'
} as unknown as User;
const mentionedMember = {
warnnable: true,
warn: jest.fn()
} as unknown as GuildMember;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageChannelSend = jest.fn();
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(mentionedUser);
const messageGuildMember = jest.fn()
.mockReturnValue(mentionedMember);
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
channel: {
send: messageChannelSend
},
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember ,
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
},
available: true
},
author: {
tag: 'AUTHORTAG'
}
} as unknown as Message;
const context: ICommandContext = {
name: 'warn',
args: ['warn', 'Test', 'Reason'],
message: message
};
const warn = new Warn();
const result = await warn.execute(context);
const logEmbed = result.embeds[0];
const fieldUser = logEmbed.fields[0];
const fieldModerator = logEmbed.fields[1];
const fieldReason = logEmbed.fields[2];
expect(fieldUser.name).toBe("User");
expect(fieldUser.value).toBe("[object Object] `USERTAG`");
expect(logEmbed.thumbnail?.url).toBe("URL");
expect(fieldModerator.name).toBe('Moderator');
expect(fieldModerator.value).toBe('[object Object] `AUTHORTAG`');
expect(fieldReason.name).toBe('Reason');
expect(fieldReason.value).toBe('Test Reason');
});
test('Given user is not mentioned, expect error embed to be sent', async () => {
process.env = {
ROLES_MODERATOR: 'Moderator',
CHANNELS_LOGS_MOD: 'mod-logs'
};
const mentionedMember = {
warnnable: true,
warn: jest.fn()
} as unknown as GuildMember;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageChannelSend = jest.fn();
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(null);
const messageGuildMember = jest.fn()
.mockReturnValue(mentionedMember);
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
channel: {
send: messageChannelSend
},
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember ,
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
},
available: true
},
author: {
tag: 'AUTHORTAG'
}
} as unknown as Message;
const context: ICommandContext = {
name: 'warn',
args: ['warn', 'Test', 'Reason'],
message: message
};
const warn = new Warn();
const result = await warn.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(logChannel.send).not.toBeCalled();
expect(result.embeds.length).toBe(1);
const embedError = result.embeds[0];
expect(embedError.description).toBe('User does not exist');
});
test('Given member is not in server, expect error embed to be sent', async () => {
process.env = {
ROLES_MODERATOR: 'Moderator',
CHANNELS_LOGS_MOD: 'mod-logs'
};
const mentionedUser = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const mentionedMember = {
warnnable: true,
warn: jest.fn()
} as unknown as GuildMember;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageChannelSend = jest.fn();
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(mentionedUser);
const messageGuildMember = jest.fn()
.mockReturnValue(null);
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
channel: {
send: messageChannelSend
},
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember ,
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
},
available: true
},
author: {
tag: 'AUTHORTAG'
}
} as unknown as Message;
const context: ICommandContext = {
name: 'warn',
args: ['warn', 'Test', 'Reason'],
message: message
};
const warn = new Warn();
const result = await warn.execute(context);
expect(messageChannelSend).toBeCalledTimes(1);
expect(logChannel.send).not.toBeCalled();
expect(result.embeds.length).toBe(1);
const embedError = result.embeds[0];
expect(embedError.description).toBe('User is not in this server');
});
test('Given guild is unavailable, expect return and do nothing', async () => {
process.env = {
ROLES_MODERATOR: 'Moderator',
CHANNELS_LOGS_MOD: 'mod-logs'
};
const mentionedUser = {
displayAvatarURL: jest.fn(),
tag: 'USERTAG'
} as unknown as User;
const mentionedMember = {
warnnable: true,
warn: jest.fn()
} as unknown as GuildMember;
const logChannel = {
name: 'mod-logs',
send: jest.fn()
} as unknown as TextChannel;
const messageChannelSend = jest.fn();
const messageMentionsUsersFirst = jest.fn()
.mockReturnValue(mentionedUser);
const messageGuildMember = jest.fn()
.mockReturnValue(mentionedMember);
const messageGuildChannelsCacheFind = jest.fn()
.mockImplementation((callback): TextChannel | undefined => {
const result = callback(logChannel);
if (!result) {
return undefined;
}
return logChannel;
});
const message = {
channel: {
send: messageChannelSend
},
mentions: {
users: {
first: messageMentionsUsersFirst
}
},
guild: {
member: messageGuildMember ,
channels: {
cache: {
find: messageGuildChannelsCacheFind
}
},
available: false
},
author: {
tag: 'AUTHORTAG'
}
} as unknown as Message;
const context: ICommandContext = {
name: 'warn',
args: ['warn', 'Test', 'Reason'],
message: message
};
const warn = new Warn();
const result = await warn.execute(context);
expect(messageChannelSend).not.toBeCalled();
expect(logChannel.send).not.toBeCalled();
expect(result.embeds.length).toBe(0);
});
});

View file

@ -1,164 +0,0 @@
import { GuildMember, TextChannel, User } from "discord.js";
import MemberEvents from "../../src/events/MemberEvents";
import GuildMemberUpdate from "../../src/events/MemberEvents/GuildMemberUpdate";
describe('GuildMemberAdd', () => {
test('When event is fired, expect embed to be sent to logs channel', async () => {
const currentDate = new Date();
const textChannel = {
send: jest.fn()
} as unknown as TextChannel;
const memberGuildChannelsCacheFind = jest.fn()
.mockReturnValue(textChannel);
const userDisplayAvatarURL = jest.fn();
const guildUser = {
tag: 'USERTAG',
createdAt: currentDate,
id: 'USERID',
displayAvatarURL: userDisplayAvatarURL
} as unknown as User;
const guildMember = {
user: guildUser,
guild: {
channels: {
cache: {
find: memberGuildChannelsCacheFind
}
}
}
} as unknown as GuildMember;
const memberEvents = new MemberEvents();
const result = await memberEvents.guildMemberAdd(guildMember);
expect(textChannel.send).toBeCalledTimes(1);
expect(userDisplayAvatarURL).toBeCalledTimes(1);
expect(result.embeds.length).toBe(1);
// Embed
const embed = result.embeds[0];
expect(embed.title).toBe("Member Joined");
expect(embed.footer?.text).toBe("Id: USERID");
expect(embed.fields.length).toBe(2);
// Embed -> User Field
const embedFieldUser = embed.fields[0];
expect(embedFieldUser.name).toBe("User");
expect(embedFieldUser.value).toBe("[object Object] `USERTAG`");
expect(embedFieldUser.inline).toBeTruthy();
// Embed -> Created Field
const embedFieldCreated = embed.fields[1];
expect(embedFieldCreated.name).toBe("Created");
expect(embedFieldCreated.value).toBe(currentDate.toString());
});
});
describe('GuildMemberRemove', () => {
test('When event is fired, expect embed to be sent to logs channel', async () => {
const currentDate = new Date();
const textChannel = {
send: jest.fn()
} as unknown as TextChannel;
const memberGuildChannelsCacheFind = jest.fn()
.mockReturnValue(textChannel);
const userDisplayAvatarURL = jest.fn();
const guildUser = {
tag: 'USERTAG',
createdAt: currentDate,
id: 'USERID',
displayAvatarURL: userDisplayAvatarURL
} as unknown as User;
const guildMember = {
user: guildUser,
guild: {
channels: {
cache: {
find: memberGuildChannelsCacheFind
}
}
},
joinedAt: currentDate
} as unknown as GuildMember;
const memberEvents = new MemberEvents();
const result = await memberEvents.guildMemberRemove(guildMember);
expect(textChannel.send).toBeCalledTimes(1);
expect(userDisplayAvatarURL).toBeCalledTimes(1);
expect(result.embeds.length).toBe(1);
// Embed
const embed = result.embeds[0];
expect(embed.title).toBe("Member Left");
expect(embed.footer?.text).toBe("Id: USERID");
expect(embed.fields.length).toBe(2);
// Embed -> User Field
const embedFieldUser = embed.fields[0];
expect(embedFieldUser.name).toBe("User");
expect(embedFieldUser.value).toBe("[object Object] `USERTAG`");
expect(embedFieldUser.inline).toBeTruthy();
// Embed -> Joined Field
const embedFieldJoined = embed.fields[1];
expect(embedFieldJoined.name).toBe("Joined");
expect(embedFieldJoined.value).toBe(currentDate.toString());
});
});
describe('GuildMemberUpdate', () => {
test('Given nicknames are the same, expect NicknameChanged NOT to be called', async () => {
const member = {
nickname: 'member'
} as unknown as GuildMember;
const nicknameChanged = jest.fn();
GuildMemberUpdate.prototype.NicknameChanged = nicknameChanged;
const memberEvents = new MemberEvents();
const result = await memberEvents.guildMemberUpdate(member, member);
expect(result.embeds.length).toBe(0);
expect(nicknameChanged).not.toBeCalled();
});
test('Given nicknames are the different, expect NicknameChanged to be called', async () => {
const oldMember = {
nickname: 'oldMember'
} as unknown as GuildMember;
const newMember = {
nickname: 'newMember'
} as unknown as GuildMember;
const nicknameChanged = jest.fn();
GuildMemberUpdate.prototype.NicknameChanged = nicknameChanged;
const memberEvents = new MemberEvents();
const result = await memberEvents.guildMemberUpdate(oldMember, newMember);
expect(result.embeds.length).toBe(0);
expect(nicknameChanged).toBeCalledTimes(1);
});
});

View file

@ -1,235 +0,0 @@
import { GuildMember, TextChannel } from "discord.js";
import GuildMemberUpdate from "../../../src/events/MemberEvents/GuildMemberUpdate";
beforeEach(() => {
process.env = {};
});
describe('Constructor', () => {
test('Expect properties are set', () => {
const oldMember = {
nickname: 'Old Nickname'
} as unknown as GuildMember;
const newMember = {
nickname: 'New Nickname'
} as unknown as GuildMember;
const guildMemberUpdate = new GuildMemberUpdate(oldMember, newMember);
expect(guildMemberUpdate.oldMember).toBe(oldMember);
expect(guildMemberUpdate.newMember).toBe(newMember);
});
});
describe('NicknameChanged', () => {
test('Given nickname has changed from one to another, expect embed to be sent with both', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs'
}
const channelSend = jest.fn();
const textChannel = {
name: 'mod-logs',
send: channelSend
} as unknown as TextChannel;
const memberGuildChannelsCacheFind = jest.fn()
.mockReturnValue(textChannel);
const memberUserDisplayAvatarURL = jest.fn();
const oldMember = {
nickname: 'Old Nickname'
} as unknown as GuildMember;
const newMember = {
nickname: 'New Nickname',
guild: {
channels: {
cache: {
find: memberGuildChannelsCacheFind
}
}
},
user: {
tag: 'USERTAG',
id: 'USERID',
displayAvatarURL: memberUserDisplayAvatarURL
}
} as unknown as GuildMember;
const guildMemberUpdate = new GuildMemberUpdate(oldMember, newMember);
const result = await guildMemberUpdate.NicknameChanged();
expect(channelSend).toBeCalledTimes(1);
expect(memberGuildChannelsCacheFind).toBeCalledTimes(1);
expect(memberUserDisplayAvatarURL).toBeCalledTimes(1);
expect(result.embeds.length).toBe(1);
// Embed
const embed = result.embeds[0];
expect(embed.title).toBe('Nickname Changed');
expect(embed.footer?.text).toBe('Id: USERID');
expect(embed.fields.length).toBe(3);
// Embed -> User Field
const embedFieldUser = embed.fields[0];
expect(embedFieldUser.name).toBe('User');
expect(embedFieldUser.value).toBe('[object Object] `USERTAG`');
// Embed -> Before Field
const embedFieldBefore = embed.fields[1];
expect(embedFieldBefore.name).toBe('Before');
expect(embedFieldBefore.value).toBe('Old Nickname');
// Embed -> After Field
const embedFieldAfter = embed.fields[2];
expect(embedFieldAfter.name).toBe('After');
expect(embedFieldAfter.value).toBe('New Nickname');
});
test('Given old nickname was null, expect embed to say old nickname was none', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs'
}
const channelSend = jest.fn();
const textChannel = {
name: 'mod-logs',
send: channelSend
} as unknown as TextChannel;
const memberGuildChannelsCacheFind = jest.fn()
.mockReturnValue(textChannel);
const memberUserDisplayAvatarURL = jest.fn();
const oldMember = {} as unknown as GuildMember;
const newMember = {
nickname: 'New Nickname',
guild: {
channels: {
cache: {
find: memberGuildChannelsCacheFind
}
}
},
user: {
tag: 'USERTAG',
id: 'USERID',
displayAvatarURL: memberUserDisplayAvatarURL
}
} as unknown as GuildMember;
const guildMemberUpdate = new GuildMemberUpdate(oldMember, newMember);
const result = await guildMemberUpdate.NicknameChanged();
expect(channelSend).toBeCalledTimes(1);
expect(memberGuildChannelsCacheFind).toBeCalledTimes(1);
expect(memberUserDisplayAvatarURL).toBeCalledTimes(1);
expect(result.embeds.length).toBe(1);
// Embed
const embed = result.embeds[0];
expect(embed.title).toBe('Nickname Changed');
expect(embed.footer?.text).toBe('Id: USERID');
expect(embed.fields.length).toBe(3);
// Embed -> User Field
const embedFieldUser = embed.fields[0];
expect(embedFieldUser.name).toBe('User');
expect(embedFieldUser.value).toBe('[object Object] `USERTAG`');
// Embed -> Before Field
const embedFieldBefore = embed.fields[1];
expect(embedFieldBefore.name).toBe('Before');
expect(embedFieldBefore.value).toBe('*none*');
// Embed -> After Field
const embedFieldAfter = embed.fields[2];
expect(embedFieldAfter.name).toBe('After');
expect(embedFieldAfter.value).toBe('New Nickname');
});
test('Given new nickname was null, expect embed to say new nickname was none', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs'
}
const channelSend = jest.fn();
const textChannel = {
name: 'mod-logs',
send: channelSend
} as unknown as TextChannel;
const memberGuildChannelsCacheFind = jest.fn()
.mockReturnValue(textChannel);
const memberUserDisplayAvatarURL = jest.fn();
const oldMember = {
nickname: 'Old Nickname'
} as unknown as GuildMember;
const newMember = {
guild: {
channels: {
cache: {
find: memberGuildChannelsCacheFind
}
}
},
user: {
tag: 'USERTAG',
id: 'USERID',
displayAvatarURL: memberUserDisplayAvatarURL
}
} as unknown as GuildMember;
const guildMemberUpdate = new GuildMemberUpdate(oldMember, newMember);
const result = await guildMemberUpdate.NicknameChanged();
expect(channelSend).toBeCalledTimes(1);
expect(memberGuildChannelsCacheFind).toBeCalledTimes(1);
expect(memberUserDisplayAvatarURL).toBeCalledTimes(1);
expect(result.embeds.length).toBe(1);
// Embed
const embed = result.embeds[0];
expect(embed.title).toBe('Nickname Changed');
expect(embed.footer?.text).toBe('Id: USERID');
expect(embed.fields.length).toBe(3);
// Embed -> User Field
const embedFieldUser = embed.fields[0];
expect(embedFieldUser.name).toBe('User');
expect(embedFieldUser.value).toBe('[object Object] `USERTAG`');
// Embed -> Before Field
const embedFieldBefore = embed.fields[1];
expect(embedFieldBefore.name).toBe('Before');
expect(embedFieldBefore.value).toBe('Old Nickname');
// Embed -> After Field
const embedFieldAfter = embed.fields[2];
expect(embedFieldAfter.name).toBe('After');
expect(embedFieldAfter.value).toBe('*none*');
});
});

View file

@ -1,648 +0,0 @@
import { Collection, Message, MessageAttachment, TextChannel } from "discord.js";
import MessageEvents from "../../src/events/MessageEvents";
beforeEach(() => {
process.env = {};
});
describe('MessageDelete', () => {
test('Given message was in a guild AND user was NOT a bot, expect message deleted embed to be sent', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs'
}
const channelSend = jest.fn();
const textChannel = {
name: 'mod-logs',
send: channelSend
} as unknown as TextChannel;
const memberGuildChannelsCacheFind = jest.fn()
.mockReturnValue(textChannel);
const messageAuthorDisplayAvatarURL = jest.fn();
const messageAttachments = new Collection<string, MessageAttachment>([
[
"0",
{
url: 'image0.png'
} as unknown as MessageAttachment
],
[
"1",
{
url: 'image1.png'
} as unknown as MessageAttachment
]
]);
const message = {
guild: {
channels: {
cache: {
find: memberGuildChannelsCacheFind
}
}
},
author: {
bot: false,
displayAvatarURL: messageAuthorDisplayAvatarURL,
tag: 'USERTAG'
},
channel: {},
content: 'Message Content',
attachments: messageAttachments
} as unknown as Message;
const messageEvents = new MessageEvents();
const result = await messageEvents.messageDelete(message);
expect(channelSend).toBeCalledTimes(1);
expect(memberGuildChannelsCacheFind).toBeCalledTimes(1);
expect(messageAuthorDisplayAvatarURL).toBeCalledTimes(1);
expect(result.embeds.length).toBe(1);
// Embed
const embed = result.embeds[0];
expect(embed.title).toBe('Message Deleted');
expect(embed.fields.length).toBe(4);
// Embed -> User Field
const embedFieldUser = embed.fields[0];
expect(embedFieldUser.name).toBe('User');
expect(embedFieldUser.value).toBe('[object Object] `USERTAG`');
// Embed -> Channel Field
const embedFieldChannel = embed.fields[1];
expect(embedFieldChannel.name).toBe('Channel');
expect(embedFieldChannel.value).toBe('[object Object]');
// Embed -> Content Field
const embedFieldContent = embed.fields[2];
expect(embedFieldContent.name).toBe('Content');
expect(embedFieldContent.value).toBe('```Message Content```');
// Embed -> Attachments Field
const embedFieldAttachments = embed.fields[3];
expect(embedFieldAttachments.name).toBe('Attachments');
expect(embedFieldAttachments.value).toBe('```image0.png\nimage1.png```');
});
test('Given message was not sent in a guild, expect execution stopped', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs'
}
const channelSend = jest.fn();
const textChannel = {
name: 'mod-logs',
send: channelSend
} as unknown as TextChannel;
const memberGuildChannelsCacheFind = jest.fn()
.mockReturnValue(textChannel);
const messageAuthorDisplayAvatarURL = jest.fn();
const messageAttachments = new Collection<string, MessageAttachment>([
[
"0",
{
url: 'image0.png'
} as unknown as MessageAttachment
],
[
"1",
{
url: 'image1.png'
} as unknown as MessageAttachment
]
]);
const message = {
author: {
bot: false,
displayAvatarURL: messageAuthorDisplayAvatarURL,
tag: 'USERTAG'
},
channel: {},
content: 'Message Content',
attachments: messageAttachments
} as unknown as Message;
const messageEvents = new MessageEvents();
const result = await messageEvents.messageDelete(message);
expect(channelSend).not.toBeCalled();
expect(memberGuildChannelsCacheFind).not.toBeCalled();
expect(messageAuthorDisplayAvatarURL).not.toBeCalled();
expect(result.embeds.length).toBe(0);
});
test('Given author is a bot, expect execution stopped', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs'
}
const channelSend = jest.fn();
const textChannel = {
name: 'mod-logs',
send: channelSend
} as unknown as TextChannel;
const memberGuildChannelsCacheFind = jest.fn()
.mockReturnValue(textChannel);
const messageAuthorDisplayAvatarURL = jest.fn();
const messageAttachments = new Collection<string, MessageAttachment>([
[
"0",
{
url: 'image0.png'
} as unknown as MessageAttachment
],
[
"1",
{
url: 'image1.png'
} as unknown as MessageAttachment
]
]);
const message = {
guild: {
channels: {
cache: {
find: memberGuildChannelsCacheFind
}
}
},
author: {
bot: true,
displayAvatarURL: messageAuthorDisplayAvatarURL,
tag: 'USERTAG'
},
channel: {},
content: 'Message Content',
attachments: messageAttachments
} as unknown as Message;
const messageEvents = new MessageEvents();
const result = await messageEvents.messageDelete(message);
expect(channelSend).not.toBeCalled();
expect(memberGuildChannelsCacheFind).not.toBeCalled();
expect(messageAuthorDisplayAvatarURL).not.toBeCalled();
expect(result.embeds.length).toBe(0);
});
test('Given message does not contain any attachments, expect attachments field to be omitted', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs'
}
const channelSend = jest.fn();
const textChannel = {
name: 'mod-logs',
send: channelSend
} as unknown as TextChannel;
const memberGuildChannelsCacheFind = jest.fn()
.mockReturnValue(textChannel);
const messageAuthorDisplayAvatarURL = jest.fn();
const messageAttachments = new Collection<string, MessageAttachment>([]);
const message = {
guild: {
channels: {
cache: {
find: memberGuildChannelsCacheFind
}
}
},
author: {
bot: false,
displayAvatarURL: messageAuthorDisplayAvatarURL,
tag: 'USERTAG'
},
channel: {},
content: 'Message Content',
attachments: messageAttachments
} as unknown as Message;
const messageEvents = new MessageEvents();
const result = await messageEvents.messageDelete(message);
expect(channelSend).toBeCalledTimes(1);
expect(memberGuildChannelsCacheFind).toBeCalledTimes(1);
expect(messageAuthorDisplayAvatarURL).toBeCalledTimes(1);
expect(result.embeds.length).toBe(1);
// Embed
const embed = result.embeds[0];
expect(embed.title).toBe('Message Deleted');
expect(embed.fields.length).toBe(3);
// Embed -> User Field
const embedFieldUser = embed.fields[0];
expect(embedFieldUser.name).toBe('User');
expect(embedFieldUser.value).toBe('[object Object] `USERTAG`');
// Embed -> Channel Field
const embedFieldChannel = embed.fields[1];
expect(embedFieldChannel.name).toBe('Channel');
expect(embedFieldChannel.value).toBe('[object Object]');
// Embed -> Content Field
const embedFieldContent = embed.fields[2];
expect(embedFieldContent.name).toBe('Content');
expect(embedFieldContent.value).toBe('```Message Content```');
});
});
describe('MessageUpdate', () => {
test('Given message is in a guild AND user is not a bot AND the content has actually changed, e xpect log embed to be sent', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs'
}
const channelSend = jest.fn();
const textChannel = {
name: 'mod-logs',
send: channelSend
} as unknown as TextChannel;
const memberGuildChannelsCacheFind = jest.fn()
.mockReturnValue(textChannel);
const messageAuthorDisplayAvatarURL = jest.fn();
const oldMessage = {
content: 'Old Message'
} as unknown as Message;
const newMessage = {
guild: {
channels: {
cache: {
find: memberGuildChannelsCacheFind
}
}
},
author: {
bot: false,
displayAvatarURL: messageAuthorDisplayAvatarURL,
tag: 'USERTAG'
},
content: 'New Message',
channel: {},
} as unknown as Message;
const messageEvents = new MessageEvents();
const result = await messageEvents.messageUpdate(oldMessage, newMessage);
expect(channelSend).toBeCalledTimes(1);
expect(memberGuildChannelsCacheFind).toBeCalledTimes(1);
expect(messageAuthorDisplayAvatarURL).toBeCalledTimes(1);
expect(result.embeds.length).toBe(1);
// Embed
const embed = result.embeds[0];
expect(embed.title).toBe('Message Edited');
expect(embed.fields.length).toBe(4);
// Embed -> User Field
const embedFieldUser = embed.fields[0];
expect(embedFieldUser.name).toBe('User');
expect(embedFieldUser.value).toBe('[object Object] `USERTAG`');
expect(embedFieldUser.inline).toBeTruthy();
// Embed -> Channel Field
const embedFieldChannel = embed.fields[1];
expect(embedFieldChannel.name).toBe('Channel');
expect(embedFieldChannel.value).toBe('[object Object]');
expect(embedFieldChannel.inline).toBeTruthy();
// Embed -> Before Field
const embedFieldBefore = embed.fields[2];
expect(embedFieldBefore.name).toBe('Before');
expect(embedFieldBefore.value).toBe('```Old Message```');
// Embed -> After Field
const embedFieldAfter = embed.fields[3];
expect(embedFieldAfter.name).toBe('After');
expect(embedFieldAfter.value).toBe('```New Message```');
});
test('Given message was not in a guild, expect execution stopped', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs'
}
const channelSend = jest.fn();
const textChannel = {
name: 'mod-logs',
send: channelSend
} as unknown as TextChannel;
const memberGuildChannelsCacheFind = jest.fn()
.mockReturnValue(textChannel);
const messageAuthorDisplayAvatarURL = jest.fn();
const oldMessage = {
content: 'Old Message'
} as unknown as Message;
const newMessage = {
author: {
bot: false,
displayAvatarURL: messageAuthorDisplayAvatarURL,
tag: 'USERTAG'
},
content: 'New Message',
channel: {},
} as unknown as Message;
const messageEvents = new MessageEvents();
const result = await messageEvents.messageUpdate(oldMessage, newMessage);
expect(channelSend).not.toBeCalled();
expect(memberGuildChannelsCacheFind).not.toBeCalled();
expect(messageAuthorDisplayAvatarURL).not.toBeCalled();
expect(result.embeds.length).toBe(0);
});
test('Given author is a bot, expect execution stopped', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs'
}
const channelSend = jest.fn();
const textChannel = {
name: 'mod-logs',
send: channelSend
} as unknown as TextChannel;
const memberGuildChannelsCacheFind = jest.fn()
.mockReturnValue(textChannel);
const messageAuthorDisplayAvatarURL = jest.fn();
const oldMessage = {
content: 'Old Message'
} as unknown as Message;
const newMessage = {
guild: {
channels: {
cache: {
find: memberGuildChannelsCacheFind
}
}
},
author: {
bot: true,
displayAvatarURL: messageAuthorDisplayAvatarURL,
tag: 'USERTAG'
},
content: 'New Message',
channel: {},
} as unknown as Message;
const messageEvents = new MessageEvents();
const result = await messageEvents.messageUpdate(oldMessage, newMessage);
expect(channelSend).not.toBeCalled();
expect(memberGuildChannelsCacheFind).not.toBeCalled();
expect(messageAuthorDisplayAvatarURL).not.toBeCalled();
expect(result.embeds.length).toBe(0);
});
test('Given the message contents are the same, expect execution stopped', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs'
}
const channelSend = jest.fn();
const textChannel = {
name: 'mod-logs',
send: channelSend
} as unknown as TextChannel;
const memberGuildChannelsCacheFind = jest.fn()
.mockReturnValue(textChannel);
const messageAuthorDisplayAvatarURL = jest.fn();
const oldMessage = {
content: 'Message'
} as unknown as Message;
const newMessage = {
guild: {
channels: {
cache: {
find: memberGuildChannelsCacheFind
}
}
},
author: {
bot: false,
displayAvatarURL: messageAuthorDisplayAvatarURL,
tag: 'USERTAG'
},
content: 'Message',
channel: {},
} as unknown as Message;
const messageEvents = new MessageEvents();
const result = await messageEvents.messageUpdate(oldMessage, newMessage);
expect(channelSend).not.toBeCalled();
expect(memberGuildChannelsCacheFind).not.toBeCalled();
expect(messageAuthorDisplayAvatarURL).not.toBeCalled();
expect(result.embeds.length).toBe(0);
});
test('Given Old Message did not have a content, expect field to account for this', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs'
}
const channelSend = jest.fn();
const textChannel = {
name: 'mod-logs',
send: channelSend
} as unknown as TextChannel;
const memberGuildChannelsCacheFind = jest.fn()
.mockReturnValue(textChannel);
const messageAuthorDisplayAvatarURL = jest.fn();
const oldMessage = {} as unknown as Message;
const newMessage = {
guild: {
channels: {
cache: {
find: memberGuildChannelsCacheFind
}
}
},
author: {
bot: false,
displayAvatarURL: messageAuthorDisplayAvatarURL,
tag: 'USERTAG'
},
content: 'New Message',
channel: {},
} as unknown as Message;
const messageEvents = new MessageEvents();
const result = await messageEvents.messageUpdate(oldMessage, newMessage);
expect(channelSend).toBeCalledTimes(1);
expect(memberGuildChannelsCacheFind).toBeCalledTimes(1);
expect(messageAuthorDisplayAvatarURL).toBeCalledTimes(1);
expect(result.embeds.length).toBe(1);
// Embed
const embed = result.embeds[0];
expect(embed.title).toBe('Message Edited');
expect(embed.fields.length).toBe(4);
// Embed -> User Field
const embedFieldUser = embed.fields[0];
expect(embedFieldUser.name).toBe('User');
expect(embedFieldUser.value).toBe('[object Object] `USERTAG`');
expect(embedFieldUser.inline).toBeTruthy();
// Embed -> Channel Field
const embedFieldChannel = embed.fields[1];
expect(embedFieldChannel.name).toBe('Channel');
expect(embedFieldChannel.value).toBe('[object Object]');
expect(embedFieldChannel.inline).toBeTruthy();
// Embed -> Before Field
const embedFieldBefore = embed.fields[2];
expect(embedFieldBefore.name).toBe('Before');
expect(embedFieldBefore.value).toBe('```*none*```');
// Embed -> After Field
const embedFieldAfter = embed.fields[3];
expect(embedFieldAfter.name).toBe('After');
expect(embedFieldAfter.value).toBe('```New Message```');
});
test('Given New Message does not have a content, expect field to account for this', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs'
}
const channelSend = jest.fn();
const textChannel = {
name: 'mod-logs',
send: channelSend
} as unknown as TextChannel;
const memberGuildChannelsCacheFind = jest.fn()
.mockReturnValue(textChannel);
const messageAuthorDisplayAvatarURL = jest.fn();
const oldMessage = {
content: 'Old Message'
} as unknown as Message;
const newMessage = {
guild: {
channels: {
cache: {
find: memberGuildChannelsCacheFind
}
}
},
author: {
bot: false,
displayAvatarURL: messageAuthorDisplayAvatarURL,
tag: 'USERTAG'
},
channel: {},
} as unknown as Message;
const messageEvents = new MessageEvents();
const result = await messageEvents.messageUpdate(oldMessage, newMessage);
expect(channelSend).toBeCalledTimes(1);
expect(memberGuildChannelsCacheFind).toBeCalledTimes(1);
expect(messageAuthorDisplayAvatarURL).toBeCalledTimes(1);
expect(result.embeds.length).toBe(1);
// Embed
const embed = result.embeds[0];
expect(embed.title).toBe('Message Edited');
expect(embed.fields.length).toBe(4);
// Embed -> User Field
const embedFieldUser = embed.fields[0];
expect(embedFieldUser.name).toBe('User');
expect(embedFieldUser.value).toBe('[object Object] `USERTAG`');
expect(embedFieldUser.inline).toBeTruthy();
// Embed -> Channel Field
const embedFieldChannel = embed.fields[1];
expect(embedFieldChannel.name).toBe('Channel');
expect(embedFieldChannel.value).toBe('[object Object]');
expect(embedFieldChannel.inline).toBeTruthy();
// Embed -> Before Field
const embedFieldBefore = embed.fields[2];
expect(embedFieldBefore.name).toBe('Before');
expect(embedFieldBefore.value).toBe('```Old Message```');
// Embed -> After Field
const embedFieldAfter = embed.fields[3];
expect(embedFieldAfter.name).toBe('After');
expect(embedFieldAfter.value).toBe('```*none*```');
});
});

View file

@ -1,11 +0,0 @@
import StringTools from "../../src/helpers/StringTools";
describe('Capitalise', () => {
test('Expect sentence to be captilised', () => {
const inputString = 'the big brown fox jumps over the lazy dog';
const result = StringTools.Capitalise(inputString);
expect(result).toBe('The Big Brown Fox Jumps Over The Lazy Dog');
});
});

View file

@ -1,57 +0,0 @@
import { Message } from "discord.js";
import { ICommandContext } from "../../../src/contracts/ICommandContext";
import ErrorEmbed from "../../../src/helpers/embeds/ErrorEmbed";
beforeEach(() => {
process.env = {};
});
describe('Constructor', () => {
test('Expect properties to be set', () => {
process.env = {
EMBED_COLOUR_ERROR: '0xd52803'
}
const message = {} as unknown as Message;
const context: ICommandContext = {
name: 'command',
args: [],
message: message
};
const errorEmbed = new ErrorEmbed(context, 'Error Message');
expect(errorEmbed.color?.toString()).toBe('13969411'); // 0xd52803 in decimal
expect(errorEmbed.description).toBe('Error Message');
expect(errorEmbed.context).toBe(context);
});
});
describe('SendToCurrentChannel', () => {
test('Expect embed to be sent to the current channel in context', () => {
process.env = {
EMBED_COLOUR_ERROR: '0xd52803'
}
const messageChannelSend = jest.fn();
const message = {
channel: {
send: messageChannelSend
}
} as unknown as Message;
const context: ICommandContext = {
name: 'command',
args: [],
message: message
};
const errorEmbed = new ErrorEmbed(context, 'Error Message');
errorEmbed.SendToCurrentChannel();
expect(messageChannelSend).toBeCalledWith(errorEmbed);
});
});

View file

@ -1,292 +0,0 @@
import { Guild, Message, TextChannel, User } from "discord.js";
import { ICommandContext } from "../../../src/contracts/ICommandContext";
import EventEmbed from "../../../src/helpers/embeds/EventEmbed";
import SettingsHelper from "../../../src/helpers/SettingsHelper";
beforeEach(() => {
process.env = {};
jest.resetAllMocks();
});
describe('Constructor', () => {
test('Expect properties to be set', () => {
const guild = {} as unknown as Guild;
const errorEmbed = new EventEmbed(guild, 'Event Message');
expect(errorEmbed.color?.toString()).toBe('3166394'); // 0x3050ba in decimal
expect(errorEmbed.title).toBe('Event Message');
expect(errorEmbed.guild).toBe(guild);
});
});
describe('AddUser', () => {
test('Given setThumbnail is false, add field WITHOUT user thumbnail', () => {
process.env = {
EMBED_COLOUR: '0xd52803',
CHANNELS_LOGS_MESSAGE: 'message-logs',
CHANNELS_LOGS_MEMBER: 'member-logs',
CHANNELS_LOGS_MOD: 'mod-logs'
}
const addField = jest.fn();
const setThumbnail = jest.fn();
const guild = {} as unknown as Guild;
const user = {
tag: 'USERTAG'
} as unknown as User;
const errorEmbed = new EventEmbed(guild, 'Event Message');
errorEmbed.addField = addField;
errorEmbed.setThumbnail = setThumbnail;
errorEmbed.AddUser('User', user);
expect(addField).toBeCalledWith('User', '[object Object] `USERTAG`', true);
expect(setThumbnail).not.toBeCalled();
});
test('Given setThumbnail is true, add field WITH user thumbnail', () => {
process.env = {
EMBED_COLOUR: '0xd52803',
CHANNELS_LOGS_MESSAGE: 'message-logs',
CHANNELS_LOGS_MEMBER: 'member-logs',
CHANNELS_LOGS_MOD: 'mod-logs'
}
const addField = jest.fn();
const setThumbnail = jest.fn();
const displayAvatarURL = jest.fn()
.mockReturnValue('image0.png');
const guild = {} as unknown as Guild;
const user = {
tag: 'USERTAG',
displayAvatarURL: displayAvatarURL
} as unknown as User;
const errorEmbed = new EventEmbed(guild, 'Event Message');
errorEmbed.addField = addField;
errorEmbed.setThumbnail = setThumbnail;
errorEmbed.AddUser('User', user, true);
expect(addField).toBeCalledWith('User', '[object Object] `USERTAG`', true);
expect(setThumbnail).toBeCalledWith('image0.png');
expect(displayAvatarURL).toBeCalled();
});
});
describe('AddReason', () => {
test('Given a non-empty string is supplied, expect field with message', () => {
const guild = {} as Guild;
const eventEmbed = new EventEmbed(guild, "Event Embed");
eventEmbed.addField = jest.fn();
eventEmbed.AddReason("Test reason");
expect(eventEmbed.addField).toBeCalledWith("Reason", "Test reason");
});
test('Given an empty string is supplied, expect field with default message', () => {
const guild = {} as Guild;
const eventEmbed = new EventEmbed(guild, "Event Embed");
eventEmbed.addField = jest.fn();
eventEmbed.AddReason("");
expect(eventEmbed.addField).toBeCalledWith("Reason", "*none*");
});
});
describe('SendToChannel', () => {
test('Given channel can be found, expect embed to be sent to that channel', () => {
const channelSend = jest.fn();
const channel = {
send: channelSend
} as unknown as TextChannel;
const guildChannelsCacheFind = jest.fn()
.mockReturnValue(channel);
const guild = {
channels: {
cache: {
find: guildChannelsCacheFind
}
}
} as unknown as Guild;
const errorEmbed = new EventEmbed(guild, 'Event Message');
errorEmbed.SendToChannel('channel-name');
expect(guildChannelsCacheFind).toBeCalledTimes(1);
expect(channelSend).toBeCalledWith(errorEmbed);
});
test('Given channel can NOT be found, expect error logged', () => {
process.env = {
EMBED_COLOUR: '0xd52803',
CHANNELS_LOGS_MESSAGE: 'message-logs',
CHANNELS_LOGS_MEMBER: 'member-logs',
CHANNELS_LOGS_MOD: 'mod-logs'
}
const guildChannelsCacheFind = jest.fn()
.mockReturnValue(null);
const guild = {
channels: {
cache: {
find: guildChannelsCacheFind
}
}
} as unknown as Guild;
console.error = jest.fn();
const errorEmbed = new EventEmbed(guild, 'Event Message');
errorEmbed.SendToChannel('channel-name');
expect(guildChannelsCacheFind).toBeCalledTimes(1);
expect(console.error).toBeCalledWith('Unable to find channel channel-name');
});
});
describe('SendToMessageLogsChannel', () => {
test('Given setting is set, expect SendToChannel to be called with value', async () => {
const sendToChannel = jest.fn();
const getSetting = jest.fn().mockResolvedValue("message-logs");
const guild = {
id: "guildId"
} as unknown as Guild;
SettingsHelper.GetSetting = getSetting;
const errorEmbed = new EventEmbed(guild, 'Event Message');
errorEmbed.SendToChannel = sendToChannel;
await errorEmbed.SendToMessageLogsChannel();
expect(sendToChannel).toBeCalledWith('message-logs');
expect(getSetting).toBeCalledWith("channels.logs.message", "guildId");
});
test('Given setting is not set, expect function to return', async () => {
const sendToChannel = jest.fn();
const getSetting = jest.fn().mockResolvedValue(undefined);
const guild = {
id: "guildId"
} as unknown as Guild;
SettingsHelper.GetSetting = getSetting;
const errorEmbed = new EventEmbed(guild, 'Event Message');
errorEmbed.SendToChannel = sendToChannel;
await errorEmbed.SendToMessageLogsChannel();
expect(sendToChannel).not.toBeCalled();
expect(getSetting).toBeCalledWith("channels.logs.message", "guildId");
});
});
describe('SendToMemberLogsChannel', () => {
test('Given setting is set, expect SendToChannel to be called with value', async () => {
const sendToChannel = jest.fn();
const getSetting = jest.fn().mockResolvedValue("member-logs");
const guild = {
id: "guildId"
} as unknown as Guild;
SettingsHelper.GetSetting = getSetting;
const errorEmbed = new EventEmbed(guild, 'Event Message');
errorEmbed.SendToChannel = sendToChannel;
await errorEmbed.SendToMemberLogsChannel();
expect(sendToChannel).toBeCalledWith('member-logs');
expect(getSetting).toBeCalledWith("channels.logs.member", "guildId");
});
test('Given setting is not set, expect function to return', async () => {
const sendToChannel = jest.fn();
const getSetting = jest.fn().mockResolvedValue(undefined);
const guild = {
id: "guildId"
} as unknown as Guild;
SettingsHelper.GetSetting = getSetting;
const errorEmbed = new EventEmbed(guild, 'Event Message');
errorEmbed.SendToChannel = sendToChannel;
await errorEmbed.SendToMemberLogsChannel();
expect(sendToChannel).not.toBeCalled();
expect(getSetting).toBeCalledWith("channels.logs.member", "guildId");
});
});
describe('SendToModLogsChannel', () => {
test('Given setting is set, expect SendToChannel to be called with value', async () => {
const sendToChannel = jest.fn();
const getSetting = jest.fn().mockResolvedValue("mod-logs");
const guild = {
id: "guildId"
} as unknown as Guild;
SettingsHelper.GetSetting = getSetting;
const errorEmbed = new EventEmbed(guild, 'Event Message');
errorEmbed.SendToChannel = sendToChannel;
await errorEmbed.SendToModLogsChannel();
expect(sendToChannel).toBeCalledWith('mod-logs');
expect(getSetting).toBeCalledWith("channels.logs.mod", "guildId");
});
test('Given setting is not set, expect function to return', async () => {
const sendToChannel = jest.fn();
const getSetting = jest.fn().mockResolvedValue(undefined);
const guild = {
id: "guildId"
} as unknown as Guild;
SettingsHelper.GetSetting = getSetting;
const errorEmbed = new EventEmbed(guild, 'Event Message');
errorEmbed.SendToChannel = sendToChannel;
await errorEmbed.SendToModLogsChannel();
expect(sendToChannel).not.toBeCalled();
expect(getSetting).toBeCalledWith("channels.logs.mod", "guildId");
});
});

View file

@ -1,407 +0,0 @@
import { Guild, Message, TextChannel, User } from "discord.js";
import { ICommandContext } from "../../../src/contracts/ICommandContext";
import LogEmbed from "../../../src/helpers/embeds/LogEmbed";
import SettingsHelper from "../../../src/helpers/SettingsHelper";
beforeEach(() => {
process.env = {};
jest.resetAllMocks();
});
describe('Constructor', () => {
test('Expect properties to be set', () => {
process.env = {
EMBED_COLOUR: '0xd52803',
CHANNELS_LOGS_MESSAGE: 'message-logs',
CHANNELS_LOGS_MEMBER: 'member-logs',
CHANNELS_LOGS_MOD: 'mod-logs'
}
const messageChannelSend = jest.fn();
const message = {
channel: {
send: messageChannelSend
}
} as unknown as Message;
const context: ICommandContext = {
name: 'command',
args: [],
message: message
};
const errorEmbed = new LogEmbed(context, 'Log Message');
expect(errorEmbed.color?.toString()).toBe('3166394'); // 0x3050ba in decimal
expect(errorEmbed.title).toBe('Log Message');
expect(errorEmbed.context).toBe(context);
});
});
describe('AddUser', () => {
test('Given setThumbnail is false, add field WITHOUT user thumbnail', () => {
process.env = {
EMBED_COLOUR: '0xd52803',
CHANNELS_LOGS_MESSAGE: 'message-logs',
CHANNELS_LOGS_MEMBER: 'member-logs',
CHANNELS_LOGS_MOD: 'mod-logs'
}
const addField = jest.fn();
const setThumbnail = jest.fn();
const user = {
tag: 'USERTAG'
} as unknown as User;
const messageChannelSend = jest.fn();
const message = {
channel: {
send: messageChannelSend
},
author: user
} as unknown as Message;
const context: ICommandContext = {
name: 'command',
args: [],
message: message
};
const errorEmbed = new LogEmbed(context, 'Event Message');
errorEmbed.addField = addField;
errorEmbed.setThumbnail = setThumbnail;
errorEmbed.AddUser('User', user);
expect(addField).toBeCalledWith('User', '[object Object] `USERTAG`', true);
expect(setThumbnail).not.toBeCalled();
});
test('Given setThumbnail is true, add field WITH user thumbnail', () => {
process.env = {
EMBED_COLOUR: '0xd52803',
CHANNELS_LOGS_MESSAGE: 'message-logs',
CHANNELS_LOGS_MEMBER: 'member-logs',
CHANNELS_LOGS_MOD: 'mod-logs'
}
const addField = jest.fn();
const setThumbnail = jest.fn();
const displayAvatarURL = jest.fn()
.mockReturnValue('image0.png');
const user = {
tag: 'USERTAG',
displayAvatarURL: displayAvatarURL
} as unknown as User;
const messageChannelSend = jest.fn();
const message = {
channel: {
send: messageChannelSend
},
author: user
} as unknown as Message;
const context: ICommandContext = {
name: 'command',
args: [],
message: message
};
const errorEmbed = new LogEmbed(context, 'Event Message');
errorEmbed.addField = addField;
errorEmbed.setThumbnail = setThumbnail;
errorEmbed.AddUser('User', user, true);
expect(addField).toBeCalledWith('User', '[object Object] `USERTAG`', true);
expect(setThumbnail).toBeCalledWith('image0.png');
expect(displayAvatarURL).toBeCalled();
});
});
describe('SendToChannel', () => {
test('Given channel can be found, expect embed to be sent to that channel', () => {
process.env = {
EMBED_COLOUR: '0xd52803',
CHANNELS_LOGS_MESSAGE: 'message-logs',
CHANNELS_LOGS_MEMBER: 'member-logs',
CHANNELS_LOGS_MOD: 'mod-logs'
}
const channelSend = jest.fn();
const channel = {
send: channelSend
} as unknown as TextChannel;
const guildChannelsCacheFind = jest.fn()
.mockReturnValue(channel);
const guild = {
channels: {
cache: {
find: guildChannelsCacheFind
}
}
} as unknown as Guild;
const messageChannelSend = jest.fn();
const message = {
channel: {
send: messageChannelSend
},
guild: guild
} as unknown as Message;
const context: ICommandContext = {
name: 'command',
args: [],
message: message
};
const errorEmbed = new LogEmbed(context, 'Event Message');
errorEmbed.SendToChannel('channel-name');
expect(guildChannelsCacheFind).toBeCalledTimes(1);
expect(channelSend).toBeCalledWith(errorEmbed);
});
test('Given channel can NOT be found, expect error logged', () => {
process.env = {
EMBED_COLOUR: '0xd52803',
CHANNELS_LOGS_MESSAGE: 'message-logs',
CHANNELS_LOGS_MEMBER: 'member-logs',
CHANNELS_LOGS_MOD: 'mod-logs'
}
const guildChannelsCacheFind = jest.fn()
.mockReturnValue(null);
const guild = {
channels: {
cache: {
find: guildChannelsCacheFind
}
}
} as unknown as Guild;
console.error = jest.fn();
const messageChannelSend = jest.fn();
const message = {
channel: {
send: messageChannelSend
},
guild: guild
} as unknown as Message;
const context: ICommandContext = {
name: 'command',
args: [],
message: message
};
const errorEmbed = new LogEmbed(context, 'Event Message');
errorEmbed.SendToChannel('channel-name');
expect(guildChannelsCacheFind).toBeCalledTimes(1);
});
});
describe('SendToMessageLogsChannel', () => {
test('Given setting is set, expect SendToChannel to be called with value', async () => {
const sendToChannel = jest.fn();
const getSetting = jest.fn().mockResolvedValue("message-logs");
const guild = {
id: "guildId"
} as unknown as Guild;
const message = {
guild: guild
} as Message;
const context: ICommandContext = {
name: 'log',
args: [],
message: message
};
SettingsHelper.GetSetting = getSetting;
const logEmbed = new LogEmbed(context, 'Event Message');
logEmbed.SendToChannel = sendToChannel;
await logEmbed.SendToMessageLogsChannel();
expect(sendToChannel).toBeCalledWith('message-logs');
expect(getSetting).toBeCalledWith("channels.logs.message", "guildId");
});
test('Given setting is not set, expect function to return', async () => {
const sendToChannel = jest.fn();
const getSetting = jest.fn().mockResolvedValue(undefined);
const guild = {
id: "guildId"
} as unknown as Guild;
const message = {
guild: guild
} as Message;
const context: ICommandContext = {
name: 'log',
args: [],
message: message
};
SettingsHelper.GetSetting = getSetting;
const logEmbed = new LogEmbed(context, 'Event Message');
logEmbed.SendToChannel = sendToChannel;
await logEmbed.SendToMessageLogsChannel();
expect(sendToChannel).not.toBeCalled();
expect(getSetting).toBeCalledWith("channels.logs.message", "guildId");
});
});
describe('SendToMemberLogsChannel', () => {
test('Given setting is set, expect SendToChannel to be called with value', async () => {
const sendToChannel = jest.fn();
const getSetting = jest.fn().mockResolvedValue("member-logs");
const guild = {
id: "guildId"
} as unknown as Guild;
const message = {
guild: guild
} as Message;
const context: ICommandContext = {
name: 'log',
args: [],
message: message
};
SettingsHelper.GetSetting = getSetting;
const logEmbed = new LogEmbed(context, 'Event Message');
logEmbed.SendToChannel = sendToChannel;
await logEmbed.SendToMemberLogsChannel();
expect(sendToChannel).toBeCalledWith('member-logs');
expect(getSetting).toBeCalledWith("channels.logs.member", "guildId");
});
test('Given setting is not set, expect function to return', async () => {
const sendToChannel = jest.fn();
const getSetting = jest.fn().mockResolvedValue(undefined);
const guild = {
id: "guildId"
} as unknown as Guild;
const message = {
guild: guild
} as Message;
const context: ICommandContext = {
name: 'log',
args: [],
message: message
};
SettingsHelper.GetSetting = getSetting;
const logEmbed = new LogEmbed(context, 'Event Message');
logEmbed.SendToChannel = sendToChannel;
await logEmbed.SendToMemberLogsChannel();
expect(sendToChannel).not.toBeCalled();
expect(getSetting).toBeCalledWith("channels.logs.member", "guildId");
});
});
describe('SendToModLogsChannel', () => {
test('Given setting is set, expect SendToChannel to be called with value', async () => {
const sendToChannel = jest.fn();
const getSetting = jest.fn().mockResolvedValue("mod-logs");
const guild = {
id: "guildId"
} as unknown as Guild;
const message = {
guild: guild
} as Message;
const context: ICommandContext = {
name: 'log',
args: [],
message: message
};
SettingsHelper.GetSetting = getSetting;
const logEmbed = new LogEmbed(context, 'Event Message');
logEmbed.SendToChannel = sendToChannel;
await logEmbed.SendToModLogsChannel();
expect(sendToChannel).toBeCalledWith('mod-logs');
expect(getSetting).toBeCalledWith("channels.logs.mod", "guildId");
});
test('Given setting is not set, expect function to return', async () => {
const sendToChannel = jest.fn();
const getSetting = jest.fn().mockResolvedValue(undefined);
const guild = {
id: "guildId"
} as unknown as Guild;
const message = {
guild: guild
} as Message;
const context: ICommandContext = {
name: 'log',
args: [],
message: message
};
SettingsHelper.GetSetting = getSetting;
const logEmbed = new LogEmbed(context, 'Event Message');
logEmbed.SendToChannel = sendToChannel;
await logEmbed.SendToModLogsChannel();
expect(sendToChannel).not.toBeCalled();
expect(getSetting).toBeCalledWith("channels.logs.mod", "guildId");
});
});

View file

@ -1,67 +0,0 @@
import { Guild, Message, TextChannel, User } from "discord.js";
import { ICommandContext } from "../../../src/contracts/ICommandContext";
import PublicEmbed from "../../../src/helpers/embeds/PublicEmbed";
beforeEach(() => {
process.env = {};
});
describe('Constructor', () => {
test('Expect properties to be set', () => {
process.env = {
EMBED_COLOUR: '0xd52803',
CHANNELS_LOGS_MESSAGE: 'message-logs',
CHANNELS_LOGS_MEMBER: 'member-logs',
CHANNELS_LOGS_MOD: 'mod-logs'
}
const messageChannelSend = jest.fn();
const message = {
channel: {
send: messageChannelSend
}
} as unknown as Message;
const context: ICommandContext = {
name: 'command',
args: [],
message: message
};
const errorEmbed = new PublicEmbed(context, 'Log Message', 'Log Description');
expect(errorEmbed.color?.toString()).toBe('13969411'); // 0xd52803 in decimal
expect(errorEmbed.title).toBe('Log Message');
expect(errorEmbed.description).toBe('Log Description');
expect(errorEmbed.context).toBe(context);
});
});
describe('SendToCurrentChannel', () => {
test('Expect embed to be sent to the current channel in context', () => {
process.env = {
EMBED_COLOUR_ERROR: '0xd52803'
}
const messageChannelSend = jest.fn();
const message = {
channel: {
send: messageChannelSend
}
} as unknown as Message;
const context: ICommandContext = {
name: 'command',
args: [],
message: message
};
const errorEmbed = new PublicEmbed(context, 'Message', 'Description');
errorEmbed.SendToCurrentChannel();
expect(messageChannelSend).toBeCalledWith(errorEmbed);
});
});

1545
yarn.lock

File diff suppressed because it is too large Load diff