feat: Allows optional playstyle during creation and updates (#10)

* Allows optional playstyle during creation and updates

* Adds on push to github workflow

* Updates instructions for testing

* Adds config.ini during tests

* Updates badge in Readme

Author: pachev

.github/workflows/general.yml

@@ -0,0 +1,20 @@
+---
+name: "GSBOT Build and Tests"
+
+on: [push]
+
+jobs:
+  gsbot:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/cache@v1
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: Run Tests
+        run: |
+          cp config.ini.example config.ini
+          docker-compose run gsbot sh -c "python -m pytest"

.travis.yml

@@ -1,5 +1,5 @@
 # Gear Score Bot for Black Desert Online
-[![Travis Build](https://travis-ci.org/pachev/gsbot.svg?branch=master)]()
+![GSBOT Build And Tests](https://github.com/pachev/gsbot/workflows/GSBOT%20Tests/badge.svg)
 [![Discord Server](https://img.shields.io/discord/417173590757212162.svg)](https://discord.gg/STa7Ebz)
 
 #### [A Discord Bot][2]

Readme.md

@@ -73,6 +73,7 @@ async def add(self,
                   aap: int,
                   dp: int,
                   char_class,
+                  playstyle = None,
                   user: discord.User = None):
         """Adds your primary character to the guild. This character is linked with your
         discord id and can only be updated by either that member or an officer.
@@ -106,6 +107,7 @@ async def add(self,
                 'ap': ap,
                 'aap': aap,
                 'dp': dp,
+                'playstyle': playstyle.title() if is_playstyle_valid(playstyle) else None,
                 'gear_score': math.trunc((ap + aap) / 2 + dp),
                 'renown_score': math.trunc((ap + aap) / 2 + dp),
                 'primary': is_primary,

cogs/add.py

@@ -81,13 +81,9 @@ async def update_attribute(self, ctx, attribute, user: discord.User = None):
                 })
             elif attribute['name'] == 'playstyle':
                 val = attribute['value']
-                if val.lower() == 'awakening':
+                if is_playstyle_valid(val):
                     character.update_attributes({
-                        attribute['name']: 'Awakening',
-                    })
-                elif val.lower() == 'succession':
-                    character.update_attributes({
-                        attribute['name']: 'Succession',
+                        attribute['name']: val.title(),
                     })
                 else:
                     await ctx.send(codify("Playstyle can only be Awakening or Succession"))
@@ -121,7 +117,15 @@ async def update(self, ctx):
                                   "for more info. ex. gsbot update ap 230 or gsbot update all 61 200 230 250 4.5"))
 
     @update.command(pass_context=True)
-    async def all(self, ctx, level: int, ap: int, aap: int, dp: int, level_percent: float, user: discord.User = None):
+    async def all(self,
+                  ctx,
+                  level: int,
+                  ap: int,
+                  aap: int,
+                  dp: int,
+                  level_percent: float = None,
+                  playstyle: str = None,
+                  user: discord.User = None):
         """Updates user's main character's information. **Officers can tag another user to update for them """
         date = datetime.now()
 
@@ -137,14 +141,18 @@ async def all(self, ctx, level: int, ap: int, aap: int, dp: int, level_percent:
             historical_data = character.hist_data
             historical_data.append(update)
 
+            playstyle = playstyle if is_playstyle_valid(playstyle) else character.playstyle
+            progress = character.progress if level_percent is None else level_percent
+
             character.update_attributes({
                 'ap': ap,
                 'aap': aap,
                 'dp': dp,
                 'level': level,
                 'gear_score': math.trunc((ap + aap) / 2 + dp),
                 'renown_score': math.trunc((ap + aap) / 2 + dp),
-                'progress': level_percent,
+                'progress': progress,
+                'playstyle': playstyle,
                 'updated': date,
                 'hist_data': historical_data
             })

cogs/update.py

@@ -4,3 +4,4 @@ discord.py
 tabulate
 aiohttp
 websockets
+pytest

requirements.txt

@@ -0,0 +1,23 @@
+""" Main test module for all utils. TODO: Add more tests here"""
+from utils import is_playstyle_valid
+
+
+def test_is_playstyle_valid():
+    """ Checks that the playstyle passed in is valid"""
+    result = is_playstyle_valid("awakened")
+    assert result is False
+
+    result = is_playstyle_valid("SUCcesSION")
+    assert result is True
+
+    result = is_playstyle_valid("SUCcesSION")
+    assert result is True
+
+    result = is_playstyle_valid("awakenING")
+    assert result is True
+
+    result = is_playstyle_valid("aakenING")
+    assert result is False
+
+    result = is_playstyle_valid(None)
+    assert result is False

tests/test_utils.py

@@ -194,3 +194,8 @@ async def send_or_display(server: int, author, ctx, content):
             return
 
     await ctx.send(content)
+
+
+def is_playstyle_valid(playstyle: str) -> bool:
+    val = playstyle if playstyle is not None else ""
+    return val.lower() in ["awakening", "succession"]