Merge pull request #3 from MisterZeus/master

various fixes to readme, upgrade module versions, get pytests closer to running ok

Author: ABaumher

README.md

@@ -13,43 +13,43 @@ This project is in open beta. It is not completely bulletproof, but it has been
 ### Installation:
 * There is a zip file in the releases directory. Download this.
 * Navigate to where GOG stores the steam plugin. 
-  * For windows, this is `%localappdata%\GOG.com\Galaxy\plugins\installed\steam_ca27391f-2675-49b1-92c0-896d43afa4f8`
-  * For MacOS, this is `~/Library/Application Support/GOG.com/Galaxy/plugins/installed/steam_ca27391f-2675-49b1-92c0-896d43afa4f8`
+  * Windows:
+    <br>`%localappdata%\GOG.com\Galaxy\plugins\installed\steam_ca27391f-2675-49b1-92c0-896d43afa4f8`
+  * MacOS:
+    <br>`~/Library/Application Support/GOG.com/Galaxy/plugins/installed/steam_ca27391f-2675-49b1-92c0-896d43afa4f8`
 * If the file does not exist, create it. If it does, delete everything inside it. 
 * Extract the zip release so all the contents are in that file. 
 * Start GOG Galaxy. 
 
 ### Logging: 
-We tried to kill as many bugs and test as many behaviors as possible, but we aren't perfect. You may find some case we haven't tested. Please raise an issue here, and in the comment, attach your logs. They can be found here: 
-* For windows, this is `%programdata%\GOG.com\Galaxy\logs`
-* For MacOS, this is `/Users/Shared/GOG.com/Galaxy/Logs`
+We tried to kill as many bugs and test as many behaviors as possible, but we aren't perfect.
+<br>You may find some case we haven't tested.
+<br>Please raise an issue here, and in the comment, attach your logs.
+<br>They can be found here: 
+* Windows:<br>`%programdata%\GOG.com\Galaxy\logs`
+* MacOS:  <br>`/Users/Shared/GOG.com/Galaxy/Logs`
 
 We typically only need the `steam_<numbers and letters>.log` file.
 
 ## Setup (For Developers)
-* Download Python 3.7.9 32-bit
+* Download [Python 3.7.9 32-bit][Python379]
 * Install it with the defaults
 * Create a new virtual env:
-    - If you only have python 3.7.9<br/>
+    - If you only have Python 3.7.9<br>
     `python -m venv .venv`
-    - IF you have multiple python versions installed (assumes you have `py` as well)<br/>
+    - If you have multiple Python versions installed (assumes you have `py` as well)<br>
     `py -3.7 -m venv .venv`
 * Activate the virtual env 
-  - Windows, Powershell:<br/>
-  `.\.venv\Scripts\activate.ps1`
-  - MacOS, terminal:<br/>
-  `.venv/Scripts/activate
-* Downgrade/Upgrade `pip`<br/>
-    - If you only have python 3.7.9<br/>
-    `python -m pip install --upgrade pip==22.0.4`
-    - IF you have multiple python versions installed (assumes you have `py` as well)<br/>
-    `py -m pip install --upgrade pip==22.0.4`
-* Install the dev dependencies:<br/>
+  - Windows, Powershell:<br>
+  `.venv\Scripts\activate`
+  - MacOS, terminal:<br>
+  `.venv/Scripts/activate`
+* Install the dev dependencies:<br>
   `pip install -r requirements/dev.txt`
 * Make your edits
 * Update the protobufs (See README_UPDATE_PROTOBUF_FILES.md for more info)
-  Take notice of the initial diff between the files in `protobuf_files` and `protobuf_files/orig`
-  Generating the python files is done via:
+  <br>Take notice of the initial diff between the files in `protobuf_files` and `protobuf_files/orig`
+  <br>Generating the python files is done via:
   `inv GenerateProtobufMessages`
 * Build your edits:
   `inv build`
@@ -60,74 +60,70 @@ We typically only need the `steam_<numbers and letters>.log` file.
 * Build a release package (zip):
   `inv pack`
 
-This is a fork of the repository from FriendsOfGalaxy, intended to continue development until they resume their work.
-
-**This is unofficial and purely maintained by fans!**
-
 ## Installation (non-developers)
 
 *~~The latest release should be available for download via the "Connect" button in Galaxy~~*
 We aren't ready to publish this project to Galaxy just yet. We have the tools to do so, but the code is not stable enough for us to consider that just yet. 
 
-In the meantime, we've provided a simplified version of the developer install process that only does the bare minimum to install the plugin. There are only a few commands you need to run, but if you want to know what they do, they are documented above each command. A tl;dr: version is below it. Please do the following:
+In the meantime, we've provided a simplified version of the developer install process that only does the bare minimum to install the plugin. There are only a few commands you need to run, but if you want to know what they do, they are documented above each command. A tl;dr: version is below it.
+
+Please do the following:
 * Download or clone this repo. If you download a zip, make sure to extract it. You need to be in the main directory for this to work. 
-* Download Python 3.7.9 32-bit. If you have another version of python installed, make sure `install py` is checked. This makes it easier to select which version of python you are using and we need our virtual environment in 3.7.9. Also, make sure you have the setting that adds python to the path environmental variable checked (windows). These should be the default, but make sure anyway.
+* Download [Python 3.7.9 32-bit][Python379].
+  <br> If you have another version of python installed, make sure `install py` is checked.
+  <br> This makes it easier to select which version of python you are using and we need our virtual environment in 3.7.9.
+  <br> If using Windows, make sure you have enabled the setting that `adds Python to the PATH environmental variable`.
+  <br> These should be the default settings, but make sure anyway.
 * Create a new virtual env:
-    - If you only have python 3.7.9<br/>
+    - If you only have python 3.7.9<br>
     `python -m venv .venv`
-    - IF you have multiple python versions installed (assumes you have `py` as well)<br/>
+    - IF you have multiple python versions installed (assumes you have `py` as well)<br>
     `py -3.7 -m venv .venv`
 * Activate the virtual env 
-  - Windows, Powershell:<br/>
-  `.\.venv\Scripts\activate.ps1`
-  - MacOS, terminal:<br/>
-  `.venv/Scripts/activate.sh`
-* Downgrade/Upgrade `pip`<br/>
-    - If you only have python 3.7.9<br/>
-    `python -m pip install --upgrade pip==22.0.4`
-    - IF you have multiple python versions installed (assumes you have `py` as well)<br/>
-    `py -3.7 -m pip install --upgrade pip==22.0.4`
-* Use Pip to get the python tools we need to install the plugin. These will only be applied to the venv you created earlier:<br/>
+  - Windows, Powershell:<br>
+  `.venv\Scripts\activate`
+  - MacOS, terminal:<br>
+  `.venv/Scripts/activate`
+* Use Pip to get the python tools we need to install the plugin.
+<br>These will only be applied to the `.venv` virtual environment you created earlier:<br>
   `pip install -r requirements/install.txt`
-* Install the plugin. It should work if you have deleted the original plugin, but will patch it if it is there.<br/>
+* Install the plugin. It should work if you have deleted the original plugin, but will patch it if it is there.<br>
   `inv install`
 
-### Installation (non-dev, Tl;Dr):
+### Installation (non-dev, TL;DR):
 
 <b>Windows (Powershell recommended)</b>
 ```
-echo I have installed python 3.7.9 (32 bit). If not, the rest of this won't work.
+@echo You must have installed python 3.7.9 (32 bit). If not, the rest of this won't work.
 py.exe -3.7 -m venv .venv
-echo if the previous command did not work, you do not have py installed or py is not in your PATH. If you only have python 3.7.9, run the next command. If it worked, skip the next command.
+@echo If the previous command did not work, you do not have py installed or py is not in your PATH.
+@echo If you only have python 3.7.9, run the next command.
+@echo If it worked, skip the next command.
 python.exe -m venv .venv
-echo virtual environment is installed. on to the next step.
-.\.venv\Scripts\activate.ps1
-echo i am downgrading pip.
-py.exe -m pip install --upgrade pip==22.0.4
-echo if the previous command did not work, you do not have py installed or py is not in your PATH. If you only have python 3.7.9, run the next command. If it worked, skip the next command.
-python.exe -m pip install --upgrade pip==22.0.4
+@echo virtual environment is installed. on to the next step.
+.venv\Scripts\activate
 pip install -r requirements/install.txt
 inv install
 ```
 
 <b>MacOS</b> (assumes your shell is bash, which is the default. if you are good enough to change that, you can figure out how to run these)
 ```
-echo I have installed python 3.7.9 (MacOS). If not, the rest of this won't work.
+echo You must have installed python 3.7.9 (MacOS). If not, the rest of this won't work.
 py -3.7 -m venv .venv
-echo if the previous command did not work, you do not have py installed or py is not in your PATH. If you only have python 3.7.9, run the next command. If it worked, skip the next command.
+echo If the previous command did not work, you do not have py installed or py is not in your PATH.
+echo If you only have python 3.7.9, run the next command.
+echo If it worked, skip the next command.
 python -m venv .venv
 echo virtual environment is installed. on to the next step.
-./.venv/Scripts/activate.sh
-echo i am downgrading pip.
-py -m pip install --upgrade pip==22.0.4
-echo if the previous command did not work, you do not have py installed or py is not in your PATH. If you only have python 3.7.9, run the next command. If it worked, skip the next command.
-python -m pip install --upgrade pip==22.0.4
+.venv/Scripts/activate
 pip install -r requirements/install.txt
 inv install
 ```
 
 ### Install Error fixes:
-If `inv install` throws a bunch of errors, make sure you have the proper python venv set up. It should complain about `getargspec`. If this happens, you created the wrong virtual environment. You can either delete .venv and reinstall it, or create a new virtual environment with a different name and use that. make sure you use `py -3.7` when creating your venv. If you don't have py, get it. You can specify the full path to python 3.7 instead if you want, but that's harder to do and harder to explain here. 
+If `inv install` throws a bunch of errors, make sure you have the proper python venv set up. It should complain about `getargspec`. If this happens, you created the wrong virtual environment. You can either delete the `.venv` folder and reinstall it, or create a new virtual environment with a different name and use that.
+
+Make sure you use `py -3.7` when creating your venv. If you don't have `py`, get it. You can specify the full path to python 3.7 instead if you want, but that's harder to do and harder to explain here. 
 
 ## Why this fork?
 
@@ -138,10 +134,10 @@ Well, without being too complicated, Steam changed how they do authentication. W
 ### Current Version:
 This is a fork of https://github.com/FriendsOfGalaxy/galaxy-integration-steam
 
-The new Authorization flow implementation is heavily influenced by SteamKit. https://github.com/SteamRE/SteamKit<br/>
+The new Authorization flow implementation is heavily influenced by SteamKit. https://github.com/SteamRE/SteamKit<br>
 While we have not utilized their source code, they have implemented the new authentication workflow before we did, and we used their knowledge of how to do so in order to implement it ourselves. If you are doing anything steam related in C#, you should check them out; their project has far more features than our own.
 
-Some work was influenced by ValvePython. https://github.com/ValvePython/steam<br/>
+Some work was influenced by ValvePython. https://github.com/ValvePython/steam<br>
 Our projects do the same thing, but use different methods (we use asyncio, they use gevent, for example). Both projects were working on the new Auth Flow simultaneously, with little collaboration between us. That said, their scope is much larger than our own and lets you do a lot more things. If you are looking for a python means of implementing a steam network authentication, you should use their work instead.
 
 ### The names of individual developers will appear here, soon(ish). Any thanks can be directed there
@@ -155,3 +151,6 @@ Original Plugin was based on work and research done by others:
 * https://github.com/summersb92/aeolipile
 * https://github.com/rcpoison/steam-scraper
 * https://github.com/chmccc/steam-scraper
+
+
+[Python379]: https://www.python.org/downloads/release/python-379/

pytest.ini

@@ -1,6 +1,6 @@
 [pytest]
 python_paths = src
-testpaths = src tests
+testpaths = tests
 addopts = --flakes --color=yes
 markers = integration
-python_files = test_*.py
+python_files = *.py

requirements/app.txt

@@ -6,4 +6,4 @@ vdf==3.2
 pyobjc-framework-CoreServices==5.1.2; sys_platform == 'darwin'
 websockets==8.1
 dataclasses-json==0.4.2
-rsa==4.9
+rsa==4.9

requirements/dev.txt

@@ -1,9 +1,10 @@
 -r app.txt
 -r install.txt
 
+pip-tools==5.1.2
+
 pytest==5.2.0
 pytest-asyncio==0.10.0
 pytest-mock==1.10.3
 pytest-flakes==4.0.0
 pytest-pythonpath==0.7.3
-pip-tools==5.1.2

requirements/install.txt

@@ -1,8 +1,11 @@
+#use specific pip version for dependencies to work nicely
+pip==22.0.4
+
 #protoc install.
 requests
 
 #install requirements. 
 invoke==1.2.0
 wheel
 
-galaxy.plugin.api==0.69
+galaxy.plugin.api==0.69

tasks.py

@@ -4,7 +4,7 @@
 import requests
 import tempfile
 import zipfile
-from shutil import rmtree, copy2
+from shutil import rmtree, copy2, which
 from distutils.dir_util import copy_tree
 from io import BytesIO
 
@@ -23,7 +23,11 @@
 if sys.platform == 'win32':
     DIST_DIR = os.environ['localappdata'] + '\\GOG.com\\Galaxy\\plugins\\installed'
     PLATFORM = "win32"
-    PYTHON_EXE = "python.exe"
+    
+    if which("py"):
+        PYTHON_EXE = "py -3.7"
+    else:
+        PYTHON_EXE = "python"
 
     PROTOC_EXE = os.path.join(PROTOC_DIR, "bin", "protoc.exe")
     PROTOC_INCLUDE_DIR = os.path.join(PROTOC_DIR, "include")
@@ -46,10 +50,10 @@ def build(c, output='output', ziparchive=None):
         rmtree(output)
 
     print('--> Fixing a pip issue, failing to import `BAR_TYPES` from `pip._internal.cli.progress_bars`')
-    c.run(PYTHON_EXE + ' -m pip install -U pip==22.0.4')
-    c.run('pip install -U pip==22.0.4 wheel pip-tools setuptools')
+    c.run(PYTHON_EXE + ' -m pip install --upgrade pip==22.0.4')
 
-    # Firstly dependencies needs to be "flatten" with pip-compile as pip requires --no-deps if --platform is used
+    # Firstly dependencies need to be "flattened" with pip-compile,
+    # as pip requires --no-deps if --platform is used.
     print('--> Flattening dependencies to temporary requirements file')
     with tempfile.NamedTemporaryFile(mode="w", delete=False) as tmp:
         c.run(f'pip-compile requirements/app.txt --output-file=-', out_stream=tmp)

tests/conftest.py

@@ -1,9 +1,15 @@
 import pathlib
-from unittest.mock import MagicMock, PropertyMock, Mock, sentinel
-
 import pytest
+
+from unittest.mock import MagicMock, PropertyMock, Mock, sentinel
 from galaxy.unittest.mock import AsyncMock, async_return_value
 
+from os import path
+BASE_DIR = path.abspath(path.curdir)
+
+import sys
+sys.path.append(path.join(BASE_DIR, "src"))
+
 from plugin import SteamPlugin, AUTH_SETUP_ON_VERSION__CACHE_KEY
 from backend_interface import BackendInterface
 from version import __version__