Unable to Run Invoke Build to Run Tests

[jvanderaa]

Environment

• Python version: 3.7 (Container)
• netutils version: PR 35

Expected Behavior

I expected invoke build and invoke tests to be able to be run without having to do any intervention

Observed Behavior

First invoke build mentioned to do a poetry install to get TOML.

❯ poetry install
Installing dependencies from lock file

No dependencies to install or update

Installing the current project: netutils (0.2.1)
❯ inv build
Please make sure to `pip install toml` or enable the Poetry shell and run `poetry install`.

Still getting the error unable to execute.

Steps to Reproduce

1. Clone repo
2. Checkout to a particular PR to checkout from a testing perspective
3. Executed invoke build and got errors above

[jeffkala]

@jvanderaa
There are 2 dependencies in the tasks.py.

1. toml - used to load pyproject.toml since invoke doesn't natively support reading in toml configuration files.
2. requests - Used for a PyPi check invoke command.

Steps that should be taken to solve the problem.

▶ python3 -m venv ~/.virtualenvs/test-netutils

▶ source ~/.virtualenvs/test-netutils/bin/activate

▶ pip freeze
(test-netutils) 
▶ 
(test-netutils) 
▶ pip install toml requests invoke
Collecting toml
  Using cached toml-0.10.2-py2.py3-none-any.whl (16 kB)
Collecting requests
  Using cached requests-2.26.0-py2.py3-none-any.whl (62 kB)
Collecting invoke
  Using cached invoke-1.6.0-py3-none-any.whl (212 kB)
Collecting charset-normalizer~=2.0.0
  Using cached charset_normalizer-2.0.4-py3-none-any.whl (36 kB)
Collecting urllib3<1.27,>=1.21.1
  Using cached urllib3-1.26.6-py2.py3-none-any.whl (138 kB)
Collecting certifi>=2017.4.17
  Using cached certifi-2021.5.30-py2.py3-none-any.whl (145 kB)
Collecting idna<4,>=2.5
  Using cached idna-3.2-py3-none-any.whl (59 kB)
Installing collected packages: urllib3, idna, charset-normalizer, certifi, toml, requests, invoke
Successfully installed certifi-2021.5.30 charset-normalizer-2.0.4 idna-3.2 invoke-1.6.0 requests-2.26.0 toml-0.10.2 urllib3-1.26.6
WARNING: You are using pip version 21.0.1; however, version 21.2.3 is available.
You should consider upgrading via the '/Users/jeffkala/.virtualenvs/test-netutils/bin/python3.9 -m pip install --upgrade pip' command.
(test-netutils) 
▶ invoke --list
Available tasks:

  bandit               Run bandit to validate basic static code security analysis.
  black                Run black to check that Python files adherence to black standards.
  build                Build a Docker image.

[jvanderaa]

We should remove the need for requests even though it is a common library.

On the TOML load part, should we look at removing the loading part and just set it statically?

[jeffkala]

For the requests part probably need to add @ubajze to the conversation, looks like that is related to a task he added.

Going to play around with options to see if we can statically assign, PROJECT_NAME and PROJECT_VERSION which appear to be the only two peices of info we're grabbing from the toml load of the pyproject.toml.

[jeffkala]

@jvanderaa after testing this I found the snag. If we move this to statically defined parameters for the 2 toml parameters it works great until you change the version of your project. Now it will require the maintainer to keep up with yet another place to update the version (in the tasks.py) instead of loading it via toml and pulling the current version from pyproject.toml.

[ubajze]

@jeffkala @jvanderaa I agree, the requests package is not needed. It was added as an early experiment to do some checks before a new version is published...

I have created the PR: #38

[jeffkala]

@jvanderaa not sure there is any way around the toml requirement. What are you're thoughts. See my previous comment #36 (comment)

[jvanderaa]

You are right that shouldn't be a problem. Do we know what is causing the import error even though the poetry environment has toml?

[jeffkala]

You are right that shouldn't be a problem. Do we know what is causing the import error even though the poetry environment has toml?

@jvanderaa are you still getting the error? I just tested and everything seems fine if I pip install toml and invoke.

▶ git clone https://github.com/networktocode/netutils.git
Cloning into 'netutils'...
remote: Enumerating objects: 474, done.
remote: Counting objects: 100% (474/474), done.
remote: Compressing objects: 100% (339/339), done.
remote: Total 474 (delta 160), reused 396 (delta 106), pack-reused 0
Receiving objects: 100% (474/474), 180.93 KiB | 2.38 MiB/s, done.
Resolving deltas: 100% (160/160), done.

▶ cd netutils
                                                                                                 
▶ python3 -m venv ~/.virtualenv/netutils-test
                                                                                        
▶ source ~/.virtualenv/netutils-test/bin/activate
(netutils-test)
~/random-test/netutils  develop ✔                                                                                                      
▶ pip freeze
(netutils-test)
~/random-test/netutils  develop ✔                                                                                                      
▶ pip install invoke
Collecting invoke
  Using cached invoke-1.6.0-py3-none-any.whl (212 kB)
Installing collected packages: invoke
Successfully installed invoke-1.6.0
WARNING: You are using pip version 21.0.1; however, version 21.2.4 is available.
You should consider upgrading via the '/Users/jeffkala/.virtualenv/netutils-test/bin/python3.9 -m pip install --upgrade pip' command.

(netutils-test)
▶ pip install toml
Collecting toml
  Using cached toml-0.10.2-py2.py3-none-any.whl (16 kB)
Installing collected packages: toml
Successfully installed toml-0.10.2
WARNING: You are using pip version 21.0.1; however, version 21.2.4 is available.
You should consider upgrading via the '/Users/jeffkala/.virtualenv/netutils-test/bin/python3.9 -m pip install --upgrade pip' command.
(netutils-test)
▶ invoke tests
DOCKER - Running command: black --check --diff . container: netutils:0.2.1-py3.7
All done! ✨ 🍰 ✨
71 files would be left unchanged.
DOCKER - Running command: flake8 . container: netutils:0.2.1-py3.7
^C... stopped
(netutils-test)

[jvanderaa]

Maybe it was something on the tcpport branch only. Same here now. Let's close this out.

[jeffkala]

Did get rid of the extra requests library that is no longer needed. toml and invoke are the necessities to run the invoke and properly load the pyproject.toml.