Fix: code coverage percent for gatorgrade files

[hannahb09]

Code Coverage

Description

This is a fix so that gatorgrade when running the code coverage gets the right files which is gatorgrade files and leaves out empty files that have no code in the over all percentage. These are the code commands that should work. poetry run task coverage I got on linux



for poetry run task test I got

Type of Change

• Feature
• [X ] Bug fix
• Documentation

[PCain02]

Based on the conversations from class today it looks like uploading the coverage.json is not a viable option and our coverage badge should be generated in actions and based on that. I was able to the coverage command to run however so that is good. I think we need to have more discussions about what to do about the .json file.

[hannahb09]

today in lab professor said we are not gonna have it committed anymore so I updated and deleted it.

[gkapfham]

Hello @hannahb09 there is at least one revision that has been requested, can you please investigate this further?

[PCain02]

So what is the plan going forward with coverage? Does it still work but no json is made or is it getting ignored in the .gitignore now? Because we will continue to run into problems with people commiting large json files on accident if it is not ignored and that adds to the size of our repo. Please keep me updated on the plan going forward! I'll take the changes requested off once I know this coverage process is resolved. Also is the same issue in execexam?

[boulais01]

Hi @hannahb09, you've requested review but you haven't addressed the comments/questions here. Please do so.

[hannahb09]

So what is the plan going forward with coverage? Does it still work but no json is made or is it getting ignored in the .gitignore now? Because we will continue to run into problems with people commiting large json files on accident if it is not ignored and that adds to the size of our repo. Please keep me updated on the plan going forward! I'll take the changes requested off once I know this coverage process is resolved. Also is the same issue in execexam?

We are ignoring the coverage.json file now on it has been added to the gitignore file and Kapfhammer has said we will not commit it from now on.

[PCain02]

I got an error when trying to run poetry run task coverage on Windows 10

C:\Users\Palla\AppData\Local\pypoetry\Cache\virtualenvs\gatorgrade-QO4nVhz5-py3.12\Lib\site-packages\_pytest\config\__init__.py:331: PluggyTeardownRaisedWarning: A plugin raised an exception during an old-style hookwrapper teardown.
Plugin: helpconfig, Hook: pytest_cmdline_parse
UsageError: usage: pytest [options] [file_or_dir] [file_or_dir] [...]
pytest: error: argument --cov-report: invalid choice: "json" (choose from "['term', 'term-missing', 'annotate', 'html', 'xml']")
For more information see https://pluggy.readthedocs.io/en/stable/api_reference.html#pluggy.PluggyTeardownRaisedWarning
  config = pluginmanager.hook.pytest_cmdline_parse(
ERROR: usage: pytest [options] [file_or_dir] [file_or_dir] [...]
pytest: error: argument --cov-report: invalid choice: "json" (choose from "['term', 'term-missing', 'annotate', 'html', 'xml']")

[PCain02]

I also noticed the coverage commands in the pyproject.toml file should be updated unless these are the correct commands and they just aren't working.

coverage-test-command = "pytest -s --cov-context=test --cov-fail-under=50 --cov-config .coveragerc --cov-report term-missing --cov-report json --cov --cov-branch"
coverage-test-command-silent = "pytest -x --show-capture=no --cov-config .coveragerc --cov-report term-missing --cov-report json --cov --cov-branch"

[PCain02]

I got an error when trying to run poetry run task coverage on Windows 10

C:\Users\Palla\AppData\Local\pypoetry\Cache\virtualenvs\gatorgrade-QO4nVhz5-py3.12\Lib\site-packages\_pytest\config\__init__.py:331: PluggyTeardownRaisedWarning: A plugin raised an exception during an old-style hookwrapper teardown.
Plugin: helpconfig, Hook: pytest_cmdline_parse
UsageError: usage: pytest [options] [file_or_dir] [file_or_dir] [...]
pytest: error: argument --cov-report: invalid choice: "json" (choose from "['term', 'term-missing', 'annotate', 'html', 'xml']")
For more information see https://pluggy.readthedocs.io/en/stable/api_reference.html#pluggy.PluggyTeardownRaisedWarning
  config = pluginmanager.hook.pytest_cmdline_parse(
ERROR: usage: pytest [options] [file_or_dir] [file_or_dir] [...]
pytest: error: argument --cov-report: invalid choice: "json" (choose from "['term', 'term-missing', 'annotate', 'html', 'xml']")

I think part of it is json isn't a valid option for a coverage report in this case. I was able to generate a coverage.xml by changing a couple things but I figure that messes with the pipeline by changing file types so that is not a good fix.

[hannahb09]

I got an error when trying to run poetry run task coverage on Windows 10

C:\Users\Palla\AppData\Local\pypoetry\Cache\virtualenvs\gatorgrade-QO4nVhz5-py3.12\Lib\site-packages\_pytest\config\__init__.py:331: PluggyTeardownRaisedWarning: A plugin raised an exception during an old-style hookwrapper teardown.
Plugin: helpconfig, Hook: pytest_cmdline_parse
UsageError: usage: pytest [options] [file_or_dir] [file_or_dir] [...]
pytest: error: argument --cov-report: invalid choice: "json" (choose from "['term', 'term-missing', 'annotate', 'html', 'xml']")
For more information see https://pluggy.readthedocs.io/en/stable/api_reference.html#pluggy.PluggyTeardownRaisedWarning
  config = pluginmanager.hook.pytest_cmdline_parse(
ERROR: usage: pytest [options] [file_or_dir] [file_or_dir] [...]
pytest: error: argument --cov-report: invalid choice: "json" (choose from "['term', 'term-missing', 'annotate', 'html', 'xml']")

I think part of it is json isn't a valid option for a coverage report in this case. I was able to generate a coverage.xml by changing a couple things but I figure that messes with the pipeline by changing file types so that is not a good fix.

I do not understand what is going wrong what you suggested is what is already in the pyproject.toml file. It be important to see if this works on Mac or the error still happens

[PCain02]

I got an error when trying to run poetry run task coverage on Windows 10

C:\Users\Palla\AppData\Local\pypoetry\Cache\virtualenvs\gatorgrade-QO4nVhz5-py3.12\Lib\site-packages\_pytest\config\__init__.py:331: PluggyTeardownRaisedWarning: A plugin raised an exception during an old-style hookwrapper teardown.
Plugin: helpconfig, Hook: pytest_cmdline_parse
UsageError: usage: pytest [options] [file_or_dir] [file_or_dir] [...]
pytest: error: argument --cov-report: invalid choice: "json" (choose from "['term', 'term-missing', 'annotate', 'html', 'xml']")
For more information see https://pluggy.readthedocs.io/en/stable/api_reference.html#pluggy.PluggyTeardownRaisedWarning
  config = pluginmanager.hook.pytest_cmdline_parse(
ERROR: usage: pytest [options] [file_or_dir] [file_or_dir] [...]
pytest: error: argument --cov-report: invalid choice: "json" (choose from "['term', 'term-missing', 'annotate', 'html', 'xml']")

I think part of it is json isn't a valid option for a coverage report in this case. I was able to generate a coverage.xml by changing a couple things but I figure that messes with the pipeline by changing file types so that is not a good fix.

I do not understand what is going wrong what you suggested is what is already in the pyproject.toml file. It be important to see if this works on Mac or the error still happens

Yeah I am not convinced the toml file is set up properly.

[hemanialaparthi]

tested this on a mac and had the same issue where i tried to run the command poetry run task coverage and this was my output:

but here is the other command: poetry run task test, which looks like it works as intended:

[hannahb09]

tested this on a mac and had the same issue where i tried to run the command poetry run task coverage and this was my output:

but here is the other command: poetry run task test, which looks like it works as intended:

I updated it so now it show work poetry run task coverage. Some of the pytest in pyproject.toml needed the numbers to be upped so it could run properly. There should be no json error now.

[CalebKendra]

LGTM, poetry run task coverage and poetry run task coverage-silent work well on Ubuntu

[PCain02]

There issues with the test cases. This is not your bug but still needs fixed. What is happening is that there is a test that wants gatorgrade to fail a check but it is displaying all this output! That is not good because it looks like things are failing! Please fix the toml file to update the commands.

[hannahb09]

There issues with the test cases. This is not your bug but still needs fixed. What is happening is that there is a test that wants gatorgrade to fail a check but it is displaying all this output! That is not good because it looks like things are failing! Please fix the toml file to update the commands.

poetry run task test-silent makes the command work where the test just tells you how many passes.