Scripts fixes - Githubissues

hackforla / peopledepot

A project to setup a datastore for people and projects at HackforLA. The link below takes you to the code documentation

https://hackforla.github.io/peopledepot/

GNU General Public License v2.0

5 stars 24 forks source link

Scripts fixes #194

Closed fyliu closed 8 months ago

fyliu commented 10 months ago

Fixes #221

What changes did you make?

fixed various script issues
added ProgramArea tests (to satisfy coverage and provide an example of a GET list test)

Why did you make the changes (we will use this info to test)?

the scripts were missing some needed functionality
some test coverage was missing

Screenshots of Proposed Changes Of The Website (if any, please do not screen shot code changes)

Visuals before changes are applied

![image](Paste_Your_Image_Link_Here_After_Attaching_Files)

Visuals after changes are applied

![image](Paste_Your_Image_Link_Here_After_Attaching_Files)

fyliu commented 10 months ago

Suggestions to exercise the changes:

call the createsuperuser.sh script. It should create a super user according the env vars in .env.dev . If those vars don't exist, you will need to copy the vars from the sample file and set their values.
call migrate.sh core 0010 to roll back to a previous database version. Call migrate.sh core to update to the latest version. Core is the core app where we have all our code.
call test.sh -k program_area to run only the program_area tests. The server may have to be running in the background for this to work.
remove test_program_area test from test_model.py and then run tests.sh to see the coverage report. It should show the code lines that's not covered by tests. All the tests should pass.
~~add extra blank lines to a source code file and run lint.sh to auto-format it..~~ already done as part of a different PR

alexlaw528 commented 8 months ago

Can you verify that there will be discrepancies between the coverage % between running a filtered test and the main test.shscript?

I'm getting 78% coverage on the filtered test and 99% on the main one.

Results from running test.sh -k program_area Screenshot 2023-10-28 at 12 38 16 PM

Results from running tests.sh Screenshot 2023-10-28 at 12 58 07 PM

fyliu commented 8 months ago

@alexlaw528 yes, selecting a subset of tests to run will affect the coverage number to be lower than running all the tests.

I updated the documentation to describe some of the fixes. For the -k option, I added the recommendation to also use the --no-cov option to disable the coverage report, since it's not useful in that case.