mirror of
https://github.com/inventree/InvenTree.git
synced 2025-07-13 08:21:26 +00:00
Docstring checks in QC checks (#3089)
* 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 merge99676ee* 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 commitca96654622. * use typing here * Revert "Make API code cleaner" This reverts commit24fb68bd3e. * 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
GitHub
@ -1,3 +1,5 @@
|
||||
"""Unit testing for the company app API functions"""
|
||||
|
||||
from django.urls import reverse
|
||||
|
||||
from rest_framework import status
|
||||
@ -8,9 +10,7 @@ from .models import Company
|
||||
|
||||
|
||||
class CompanyTest(InvenTreeAPITestCase):
|
||||
"""
|
||||
Series of tests for the Company DRF API
|
||||
"""
|
||||
"""Series of tests for the Company DRF API."""
|
||||
|
||||
roles = [
|
||||
'purchase_order.add',
|
||||
@ -18,7 +18,7 @@ class CompanyTest(InvenTreeAPITestCase):
|
||||
]
|
||||
|
||||
def setUp(self):
|
||||
|
||||
"""Perform initialization for the unit test class"""
|
||||
super().setUp()
|
||||
|
||||
self.acme = Company.objects.create(name='ACME', description='Supplier', is_customer=False, is_supplier=True)
|
||||
@ -26,6 +26,7 @@ class CompanyTest(InvenTreeAPITestCase):
|
||||
Company.objects.create(name='Sippy Cup Emporium', description='Another supplier')
|
||||
|
||||
def test_company_list(self):
|
||||
"""Test the list API endpoint for the Company model"""
|
||||
url = reverse('api-company-list')
|
||||
|
||||
# There should be three companies
|
||||
@ -45,10 +46,7 @@ class CompanyTest(InvenTreeAPITestCase):
|
||||
self.assertEqual(len(response.data), 2)
|
||||
|
||||
def test_company_detail(self):
|
||||
"""
|
||||
Tests for the Company detail endpoint
|
||||
"""
|
||||
|
||||
"""Tests for the Company detail endpoint."""
|
||||
url = reverse('api-company-detail', kwargs={'pk': self.acme.pk})
|
||||
response = self.get(url)
|
||||
|
||||
@ -71,20 +69,14 @@ class CompanyTest(InvenTreeAPITestCase):
|
||||
self.assertEqual(response.data['currency'], 'NZD')
|
||||
|
||||
def test_company_search(self):
|
||||
"""
|
||||
Test search functionality in company list
|
||||
"""
|
||||
|
||||
"""Test search functionality in company list."""
|
||||
url = reverse('api-company-list')
|
||||
data = {'search': 'cup'}
|
||||
response = self.get(url, data)
|
||||
self.assertEqual(len(response.data), 2)
|
||||
|
||||
def test_company_create(self):
|
||||
"""
|
||||
Test that we can create a company via the API!
|
||||
"""
|
||||
|
||||
"""Test that we can create a company via the API!"""
|
||||
url = reverse('api-company-list')
|
||||
|
||||
# Name is required
|
||||
@ -146,9 +138,7 @@ class CompanyTest(InvenTreeAPITestCase):
|
||||
|
||||
|
||||
class ManufacturerTest(InvenTreeAPITestCase):
|
||||
"""
|
||||
Series of tests for the Manufacturer DRF API
|
||||
"""
|
||||
"""Series of tests for the Manufacturer DRF API."""
|
||||
|
||||
fixtures = [
|
||||
'category',
|
||||
@ -164,6 +154,7 @@ class ManufacturerTest(InvenTreeAPITestCase):
|
||||
]
|
||||
|
||||
def test_manufacturer_part_list(self):
|
||||
"""Test the ManufacturerPart API list functionality"""
|
||||
url = reverse('api-manufacturer-part-list')
|
||||
|
||||
# There should be three manufacturer parts
|
||||
@ -191,9 +182,7 @@ class ManufacturerTest(InvenTreeAPITestCase):
|
||||
self.assertEqual(len(response.data), 2)
|
||||
|
||||
def test_manufacturer_part_detail(self):
|
||||
"""
|
||||
Tests for the ManufacturerPart detail endpoint
|
||||
"""
|
||||
"""Tests for the ManufacturerPart detail endpoint."""
|
||||
url = reverse('api-manufacturer-part-detail', kwargs={'pk': 1})
|
||||
|
||||
response = self.get(url)
|
||||
@ -210,13 +199,14 @@ class ManufacturerTest(InvenTreeAPITestCase):
|
||||
self.assertEqual(response.data['MPN'], 'MPN-TEST-123')
|
||||
|
||||
def test_manufacturer_part_search(self):
|
||||
# Test search functionality in manufacturer list
|
||||
"""Test search functionality in manufacturer list"""
|
||||
url = reverse('api-manufacturer-part-list')
|
||||
data = {'search': 'MPN'}
|
||||
response = self.get(url, data)
|
||||
self.assertEqual(len(response.data), 3)
|
||||
|
||||
def test_supplier_part_create(self):
|
||||
"""Test a SupplierPart can be created via the API"""
|
||||
url = reverse('api-supplier-part-list')
|
||||
|
||||
# Create a manufacturer part
|
||||
|
||||
Reference in New Issue
Block a user