Added toggle for Verify, new default behaviour for welcome message and k!setup #232

jplam123 · 2021-07-29T13:10:57Z

Summary

close #86
This PR, adds a toggle for verification using k!verifyDM .

Added new default behaviour for welcome messages, they do not happen by default unless one is updated with a welcome message.

Added k!setup command, this blocks all possible sensitive commands until the command is called in the guild by an admin

Checklist

This PR fixes an issue.
This PR adds something new (e.g. new method or parameters).
This PR is a breaking change (e.g. methods or parameters removed/renamed)
This PR is not a code change (e.g. documentation, README, ...)

Have you tested the changes? (pytest & dpytest)
Have you followed PEP-8 for naming and styling?
Has your code been properly documented with RestructuredText docstrings?
Have you added your changes to CHANGELOG.md under the [Unreleased] heading?
If your code added new bot commands, have you updated documentation.json?

All of this code is your own, or follows the author repo's licence.

…ome message

test: added test for introcog without message

…tored

…into WERemoveCog

Fixed: SQL Insertion error, if statement was set up wrong Signed-off-by: Jonathan <[email protected]>

Signed-off-by: Jonathan <[email protected]>

…error dialogue Signed-off-by: Jonathan <[email protected]>

Signed-off-by: Jonathan <[email protected]>

…into WERemoveCog

Signed-off-by: Jonathan <[email protected]>

…with database management Signed-off-by: Jonathan <[email protected]>

Signed-off-by: Jonathan <[email protected]>

codecov · 2021-07-29T13:12:39Z

Codecov Report

Merging #232 (4b1ef73) into master (1b3210f) will increase coverage by 0.99%.
The diff coverage is 95.65%.

❗ Current head 4b1ef73 differs from pull request most recent head 0646e2f. Consider uploading reports for the commit 0646e2f to get more accurate results

@@            Coverage Diff             @@
##           master     #232      +/-   ##
==========================================
+ Coverage   82.26%   83.26%   +0.99%     
==========================================
  Files          26       26              
  Lines        6452     6973     +521     
==========================================
+ Hits         5308     5806     +498     
- Misses       1144     1167      +23

Flag	Coverage Δ
unittests	`83.26% <95.65%> (+0.99%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
KoalaBot.py	`77.00% <25.00%> (-4.53%)`	⬇️
cogs/IntroCog.py	`84.49% <84.00%> (-0.83%)`	⬇️
tests/test_ReactForRole.py	`89.17% <88.52%> (-0.01%)`	⬇️
tests/test_TwitchAlert.py	`95.87% <91.17%> (-0.47%)`	⬇️
cogs/TextFilter.py	`91.90% <91.66%> (+0.28%)`	⬆️
cogs/Verification.py	`68.04% <91.66%> (+2.33%)`	⬆️
tests/test_TextFilter.py	`96.29% <96.15%> (-0.18%)`	⬇️
cogs/Announce.py	`96.53% <100.00%> (+0.14%)`	⬆️
cogs/BaseCog.py	`62.29% <100.00%> (+0.95%)`	⬆️
cogs/ColourRole.py	`89.14% <100.00%> (+0.25%)`	⬆️
... and 12 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1b3210f...0646e2f. Read the comment docs.

lgtm-com · 2021-07-29T13:23:57Z

This pull request introduces 1 alert when merging af59bbb into 85c3be5 - view on LGTM.com

new alerts:

1 for Unused import

Signed-off-by: Jonathan <[email protected]>

lgtm-com · 2021-07-30T12:47:14Z

This pull request introduces 1 alert when merging 721174e into 85c3be5 - view on LGTM.com

new alerts:

1 for Unused import

Kaspiaan · 2021-08-04T01:37:58Z

documentation.json

+      {
+	"command": "setup",
+	"parameters": []
+	"description": "Allows access to configure the bot, once legal terms are agreed"


please make sure the colon is kept in there, also need to add back in the comma on the line above (52)

Kaspiaan · 2021-08-04T01:38:39Z

documentation.json

+      {
+	"command": "verifyDM",
+	"parameters": ["toggle"]
+	"description" "Toggle the verify DM for a guild, that sends the user a list of emails to verify"


please make sure the colon is there between "description" and "Toggle ...", also need to add back in the comma on the line above (347)

Kaspiaan · 2021-08-04T02:00:56Z

utils/KoalaDBManager.py

+
+        sql_create_guild_dm_email_list_status_table = """
+        CREATE TABLE IF NOT EXISTS GuildDMEmailListStatus(
+        guild_id integer NOT NULL PRIMARY KEY,


This will need to be changed to text later down the line. Same thing on 136

Suggested change

guild_id integer NOT NULL PRIMARY KEY,

guild_id text NOT NULL PRIMARY KEY,

Kaspiaan · 2021-08-04T02:02:11Z

utils/KoalaDBManager.py

+        sql_create_guild_setup_table = """
+        CREATE TABLE IF NOT EXISTS GuildSetupStatus(
+        guild_id integer NOT NULL PRIMARY KEY, 
+        accepted_setup BOOLEAN NOT NULL CHECK (accepted_setup IN (0, 1))


Is it worth DEFAULT ing this?

Kaspiaan · 2021-08-04T02:03:08Z

utils/KoalaDBManager.py

+        guild_id = ?"""
+        self.db_execute_commit(sql_update_dm_email_list_status, args=[toggle, guild_id])
+
+    def remove_dm_email_list_status(self, guild_id):


If possible can you create tests for these new methods

utils/KoalaDBManager.py

…into WERemoveCog

lgtm-com · 2021-08-04T11:53:33Z

This pull request introduces 1 alert when merging ea4bb34 into d666525 - view on LGTM.com

new alerts:

1 for Unused import

lgtm-com · 2021-08-04T13:05:49Z

This pull request introduces 1 alert when merging 7850f15 into d666525 - view on LGTM.com

new alerts:

1 for Unused import

lgtm-com · 2021-08-05T11:33:44Z

This pull request introduces 2 alerts when merging b5f2a40 into 1b3210f - view on LGTM.com

new alerts:

2 for Unused import

JayDwee · 2021-08-05T11:47:02Z

Please remove the unused imports specified by LGTM

Jaddison011 · 2021-08-05T12:20:58Z

Please remove the unused imports specified by LGTM

Done

JayDwee

Couple things to change, also need to check if setup is required for all our commands.
Also need to actually make the terms and conditions, as we currently only have a privacy policy.
Also need to check if privacy policy should be agreed to within setup. But in the meantime there are some things to change

JayDwee · 2021-08-09T07:45:36Z

CHANGELOG.md

@@ -3,6 +3,12 @@ All notable changes to KoalaBot will be documented in this file.
 A lot of these commands will only be available to administrators

 ## [Unreleased]
+### 29-07-2021


Changelog should be in the same format as previously. Use subheadings for different Cogs/ base KoalaBot, and 'other' for anything else mainly dev related

JayDwee · 2021-08-09T08:00:17Z

KoalaBot.py

@@ -97,6 +97,13 @@ def is_admin(ctx):
        return ctx.author.guild_permissions.administrator or is_dpytest


+def terms_agreed(ctx):


When this fails, a 'list index out of range' error is given, either displayed in console, or to the user. This should not be visible.

JayDwee · 2021-08-09T08:02:25Z

KoalaBot.py

@@ -160,6 +167,16 @@ async def on_command_error(ctx, error):
    elif isinstance(error, commands.CommandOnCooldown):
        await ctx.send(embed=error_embed(description=f"{ctx.author.mention}, this command is still on cooldown for "
                                                     f"{str(error.retry_after)}s."))
+    elif isinstance(error, commands.CheckFailure):
+        if database_manager.fetch_guild_setup_status(ctx.guild.id) == 0:
+            await ctx.send(embed=error_embed(description="In order to use this command. You must agree to the Terms & Conditions " \


This error doesn't seem to show up. Instead nothing is sent to the user. needs fixing

JayDwee · 2021-08-09T08:09:25Z

cogs/IntroCog.py

+                        "For legal documents relating to this, please view the following link: http://legal.koalabot.uk/ " \
+                        "Use k!setup to agree"
+        for channel in guild.text_channels:
+            if channel.permissions_for(guild.me).send_messages:


if it doesn't have access, what happens? Also this would be very infuriating to most people as when joining KoalaBot may post in a public announcement channel. Instead it would be best to DM the user that invited Koala, or just wait to send this message when a Koala command is sent in any channel, and respond with this instead

JayDwee · 2021-08-09T08:12:04Z

cogs/IntroCog.py

        KoalaBot.logger.info(f"KoalaBot joined new guild, id = {guild.id}, name = {guild.name}.")
+        await self.send_setup_message(guild)


move to the failed terms agreed check

cogs/Verification.py

JayDwee · 2021-08-09T08:56:09Z

tests/test_Announce.py

+    DBManager.insert_setup_status(guild.id)
+    DBManager.update_guild_setup_status(guild.id)


can these be added to a pytest fixture?

JayDwee · 2021-08-09T08:58:12Z

utils/KoalaDBManager.py

@@ -129,13 +131,123 @@ def create_base_tables(self):
        welcome_message text
        );"""

+        sql_create_guild_setup_table = """
+        CREATE TABLE IF NOT EXISTS GuildSetupStatus(
+        guild_id integer NOT NULL PRIMARY KEY, 


Change IDs to text

JayDwee · 2021-08-09T08:58:22Z

utils/KoalaDBManager.py

+
+        sql_create_guild_dm_email_list_status_table = """
+        CREATE TABLE IF NOT EXISTS GuildDMEmailListStatus(
+        guild_id integer NOT NULL PRIMARY KEY,


Suggested change

guild_id integer NOT NULL PRIMARY KEY,

guild_id text NOT NULL PRIMARY KEY,

JayDwee · 2021-08-09T08:58:47Z

utils/KoalaDBManager.py

+        sql_create_guild_dm_email_list_status_table = """
+        CREATE TABLE IF NOT EXISTS GuildDMEmailListStatus(
+        guild_id integer NOT NULL PRIMARY KEY,
+        dm_email_list_status BOOLEAN NOT NULL CHECK (dm_email_list_status IN (0, 1))
+        );
+        """


should this be moved to Verification.py?

@JayDwee

removal of line as per @JayDwee's suggestion Co-authored-by: Jack Draper <[email protected]>

jplam123 and others added 25 commits July 23, 2021 13:21

feat: when there is no welcome message set up it will not send a welc…

4b65ef8

…ome message

feat: added lack of message when one isn't initialised

2f19f96

test: added test for introcog without message

Added setup command that is required before any data on a server is s…

dcf4193

…tored

Merge branch 'WERemoveCog' of https://github.com/KoalaBotUK/KoalaBot …

f1c3d11

…into WERemoveCog

Added functionality for blocking commands

2e4bfc5

fixed: tests for the new behaviour of koala bot.

2fab180

fixed: bot.check -> commands.check

69d3927

Fixed: Welcome message error, now posts to first available channel

69f0aee

Fixed: SQL Insertion error, if statement was set up wrong Signed-off-by: Jonathan <[email protected]>

feat:added table for guild setup status

ba38d53

Signed-off-by: Jonathan <[email protected]>

terms agreed global check now uses SQL database

122d57c

feat: fixed the setup status, added checks to commands and a special …

304debd

…error dialogue Signed-off-by: Jonathan <[email protected]>

feat: added checks for GDPR reasons to ColourRole, RFR and TextFilter

6fdfe45

Signed-off-by: Jonathan <[email protected]>

Added some command blocking when legal terms aren't agreed

c08a688

Merge branch 'WERemoveCog' of https://github.com/KoalaBotUK/KoalaBot …

e82f5d1

…into WERemoveCog

Added command to toggle verify DM for a guild on user joining a guild

378b7b2

Added email_list_status table

24a938c

fixed: some tests, along with some sql query issues.

aa85a26

Signed-off-by: Jonathan <[email protected]>

Fixed some tests

95d067a

Fixed: Verification cog, and testing

c930433

Signed-off-by: Jonathan <[email protected]>

Fixed some tests again

1da6931

Fixed a broken test

8761098

Fixed: Tests now work with the new statuses, as well as small issues …

50e7600

…with database management Signed-off-by: Jonathan <[email protected]>

feat: added docstrings to a few methods and formatted according the PEP8

e2d957a

Signed-off-by: Jonathan <[email protected]>

feat: added to changelog

1ec4753

Signed-off-by: Jonathan <[email protected]>

Updated documentation.json to include the new commands

af59bbb

jplam123 added the good first issue Good for newcomers label Jul 29, 2021

jplam123 requested a review from Kaspiaan July 29, 2021 13:10

jplam123 assigned Jaddison011 Jul 29, 2021

feat: added more tests to improve coverage

721174e

Signed-off-by: Jonathan <[email protected]>

Kaspiaan reviewed Aug 4, 2021

View reviewed changes

utils/KoalaDBManager.py Show resolved Hide resolved

Jaddison011 added 3 commits August 4, 2021 12:21

Fixed some syntax errors in documentation.json

dd1f097

Merge branch 'WERemoveCog' of https://github.com/KoalaBotUK/KoalaBot …

b5d6a53

…into WERemoveCog

Added doc string for added methods

ea4bb34

Added tests for database methods

7850f15

Merge branch 'master' into WERemoveCog

b5f2a40

Removed unused imports

4b1ef73

JayDwee requested changes Aug 9, 2021

View reviewed changes

Update cogs/Verification.py

0646e2f

removal of line as per @JayDwee's suggestion Co-authored-by: Jack Draper <[email protected]>

Kaspiaan assigned Kaspiaan and unassigned Jaddison011 Oct 18, 2021

Kaspiaan added the high priority label Oct 18, 2021

Kaspiaan assigned Copper76 and unassigned Kaspiaan Oct 18, 2021

VirajShah18 marked this pull request as draft November 9, 2021 00:41

JayDwee removed the high priority label Jun 17, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added toggle for Verify, new default behaviour for welcome message and k!setup #232

Added toggle for Verify, new default behaviour for welcome message and k!setup #232

jplam123 commented Jul 29, 2021 •

edited by Copper76

Loading

codecov bot commented Jul 29, 2021 •

edited

Loading

lgtm-com bot commented Jul 29, 2021

lgtm-com bot commented Jul 30, 2021

Kaspiaan Aug 4, 2021

Jaddison011 Aug 5, 2021

Kaspiaan Aug 4, 2021

Jaddison011 Aug 5, 2021

Kaspiaan Aug 4, 2021

JayDwee Aug 9, 2021

Kaspiaan Aug 4, 2021

Kaspiaan Aug 4, 2021

Jaddison011 Aug 5, 2021

lgtm-com bot commented Aug 4, 2021

lgtm-com bot commented Aug 4, 2021

lgtm-com bot commented Aug 5, 2021

JayDwee commented Aug 5, 2021

Jaddison011 commented Aug 5, 2021

JayDwee left a comment

JayDwee Aug 9, 2021

JayDwee Aug 9, 2021

JayDwee Aug 9, 2021

JayDwee Aug 9, 2021

JayDwee Aug 9, 2021

JayDwee Aug 9, 2021

JayDwee Aug 9, 2021

JayDwee Aug 9, 2021

JayDwee Aug 9, 2021

	guild_id integer NOT NULL PRIMARY KEY,
	guild_id text NOT NULL PRIMARY KEY,

		@@ -97,6 +97,13 @@ def is_admin(ctx):
		return ctx.author.guild_permissions.administrator or is_dpytest


		def terms_agreed(ctx):

		KoalaBot.logger.info(f"KoalaBot joined new guild, id = {guild.id}, name = {guild.name}.")
		await self.send_setup_message(guild)

		DBManager.insert_setup_status(guild.id)
		DBManager.update_guild_setup_status(guild.id)

Added toggle for Verify, new default behaviour for welcome message and k!setup #232

Are you sure you want to change the base?

Added toggle for Verify, new default behaviour for welcome message and k!setup #232

Conversation

jplam123 commented Jul 29, 2021 • edited by Copper76 Loading

Summary

Checklist

codecov bot commented Jul 29, 2021 • edited Loading

Codecov Report

lgtm-com bot commented Jul 29, 2021

lgtm-com bot commented Jul 30, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lgtm-com bot commented Aug 4, 2021

lgtm-com bot commented Aug 4, 2021

lgtm-com bot commented Aug 5, 2021

JayDwee commented Aug 5, 2021

Jaddison011 commented Aug 5, 2021

JayDwee left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jplam123 commented Jul 29, 2021 •

edited by Copper76

Loading

codecov bot commented Jul 29, 2021 •

edited

Loading