inventree/InvenTree
2
0
Fork 0
mirror of https://github.com/inventree/InvenTree.git synced 2025-07-02 03:30:54 +00:00
Code Activity

Docstring checks in QC checks (#3089)

Browse Source 
* Add pre-commit to the stack

* exclude static

* Add locales to excludes

* fix style errors

* rename pipeline steps

* also wait on precommit

* make template matching simpler

* Use the same code for python setup everywhere

* use step and cache for python setup

* move regular settings up into general envs

* just use full update

* Use invoke instead of static references

* make setup actions more similar

* use python3

* refactor names to be similar

* fix runner version

* fix references

* remove incidential change

* use matrix for os

* Github can't do this right now

* ignore docstyle errors

* Add seperate docstring test

* update flake call

* do not fail on docstring

* refactor setup into workflow

* update reference

* switch to action

* resturcture

* add bash statements

* remove os from cache

* update input checks

* make code cleaner

* fix boolean

* no relative paths

* install wheel by python

* switch to install

* revert back to simple wheel

* refactor import export tests

* move setup keys back to not disturbe tests

* remove docstyle till that is fixed

* update references

* continue on error

* add docstring test

* use relativ action references

* Change step / job docstrings

* update to merge

* reformat comments 1

* fix docstrings 2

* fix docstrings 3

* fix docstrings 4

* fix docstrings 5

* fix docstrings 6

* fix docstrings 7

* fix docstrings 8

* fix docstirns 9

* fix docstrings 10

* docstring adjustments

* update the remaining docstrings

* small docstring changes

* fix function name

* update support files for docstrings

* Add missing args to docstrings

* Remove outdated function

* Add docstrings for the 'build' app

* Make API code cleaner

* add more docstrings for plugin app

* Remove dead code for plugin settings
No idea what that was even intended for

* ignore __init__ files for docstrings

* More docstrings

* Update docstrings for the 'part' directory

* Fixes for related_part functionality

* Fix removed stuff from merge 99676ee

* make more consistent

* Show statistics for docstrings

* add more docstrings

* move specific register statements to make them clearer to understant

* More docstrings for common

* and more docstrings

* and more

* simpler call

* docstrings for notifications

* docstrings for common/tests

* Add docs for common/models

* Revert "move specific register statements to make them clearer to understant"

This reverts commit ca96654622.

* use typing here

* Revert "Make API code cleaner"

This reverts commit 24fb68bd3e.

* docstring updates for the 'users' app

* Add generic Meta info to simple Meta classes

* remove unneeded unique_together statements

* More simple metas

* Remove unnecessary format specifier

* Remove extra json format specifiers

* Add docstrings for the 'plugin' app

* Docstrings for the 'label' app

* Add missing docstrings for the 'report' app

* Fix build test regression

* Fix top-level files

* docstrings for InvenTree/InvenTree

* reduce unneeded code

* add docstrings

* and more docstrings

* more docstrings

* more docstrings for stock

* more docstrings

* docstrings for order/views

* Docstrings for various files in the 'order' app

* Docstrings for order/test_api.py

* Docstrings for order/serializers.py

* Docstrings for order/admin.py

* More docstrings for the order app

* Add docstrings for the 'company' app

* Add unit tests for rebuilding the reference fields

* Prune out some more dead code

* remove more dead code

Co-authored-by: Oliver Walters <oliver.henry.walters@gmail.com>
This commit is contained in:
Matthias Mair
2022-06-01 17:37:39 +02:00
committed by GitHub
parent 66a6915213
commit 0c97a50e47
223 changed files with 4416 additions and 6980 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
InvenTree/report/tests.py
View File

@ -1,3 +1,4 @@
"""Unit testing for the various report models"""
import os
import shutil
@ -14,7 +15,7 @@ from stock.models import StockItem
class ReportTest(InvenTreeAPITestCase):
"""Base class for unit testing reporting models"""
fixtures = [
'category',
'part',
@ -32,14 +33,8 @@ class ReportTest(InvenTreeAPITestCase):
detail_url = None
print_url = None
def setUp(self):
super().setUp()
def copyReportTemplate(self, filename, description):
"""
Copy the provided report template into the required media directory
"""
"""Copy the provided report template into the required media directory."""
src_dir = os.path.join(
os.path.dirname(os.path.realpath(__file__)),
'templates',
@ -81,10 +76,7 @@ class ReportTest(InvenTreeAPITestCase):
)
def test_list_endpoint(self):
"""
Test that the LIST endpoint works for each report
"""
"""Test that the LIST endpoint works for each report."""
if not self.list_url:
return
@ -121,7 +113,7 @@ class ReportTest(InvenTreeAPITestCase):
class TestReportTest(ReportTest):
"""Unit testing class for the stock item TestReport model"""
model = report_models.TestReport
list_url = 'api-stockitem-testreport-list'
@ -129,16 +121,13 @@ class TestReportTest(ReportTest):
print_url = 'api-stockitem-testreport-print'
def setUp(self):
"""Setup function for the stock item TestReport"""
self.copyReportTemplate('inventree_test_report.html', 'stock item test report')
return super().setUp()
def test_print(self):
"""
Printing tests for the TestReport
"""
"""Printing tests for the TestReport."""
report = self.model.objects.first()
url = reverse(self.print_url, kwargs={'pk': report.pk})
@ -163,7 +152,7 @@ class TestReportTest(ReportTest):
class BuildReportTest(ReportTest):
"""Unit test class for the BuildReport model"""
model = report_models.BuildReport
list_url = 'api-build-report-list'
@ -171,16 +160,13 @@ class BuildReportTest(ReportTest):
print_url = 'api-build-report-print'
def setUp(self):
"""Setup unit testing functions"""
self.copyReportTemplate('inventree_build_order.html', 'build order template')
return super().setUp()
def test_print(self):
"""
Printing tests for the BuildReport
"""
"""Printing tests for the BuildReport."""
report = self.model.objects.first()
url = reverse(self.print_url, kwargs={'pk': report.pk})
@ -216,7 +202,7 @@ class BuildReportTest(ReportTest):
class BOMReportTest(ReportTest):
"""Unit test class fot the BillOfMaterialsReport model"""
model = report_models.BillOfMaterialsReport
list_url = 'api-bom-report-list'
@ -225,7 +211,7 @@ class BOMReportTest(ReportTest):
class PurchaseOrderReportTest(ReportTest):
"""Unit test class fort he PurchaseOrderReport model"""
model = report_models.PurchaseOrderReport
list_url = 'api-po-report-list'
@ -234,7 +220,7 @@ class PurchaseOrderReportTest(ReportTest):
class SalesOrderReportTest(ReportTest):
"""Unit test class for the SalesOrderReport model"""
model = report_models.SalesOrderReport
list_url = 'api-so-report-list'