8535197168

Committed 03 Apr 2024 07:58AM CUT coverage: 90.342% (-2.2%) from 92.496%

Build # 8535197168

Build Type

Pull #6881

github

Committed by

web-flow

Commit Message

Merge a1722af93 into 6be2ede5e

Pull Request Pull Request #6881: [PUI] Add coverage testing

Run Details

227 of 631 branches covered (35.97%)

Branch coverage included in aggregate %.

0 of 1 new or added line in 1 file covered. (0.0%)

1 existing line in 1 file now uncovered.

31971 of 35009 relevant lines covered (91.32%)

1.12 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

10.42

/src/backend/InvenTree/common/forms.py

"""Django forms for interacting with common objects."""

from django import forms
from django.utils.translation import gettext as _

from .files import FileManager


class UploadFileForm(forms.Form):
    """Step 1 of FileManagementFormView."""

    file = forms.FileField(label=_('File'), help_text=_('Select file to upload'))

    def __init__(self, *args, **kwargs):
        """Update label and help_text."""
        # Get file name
        name = None
        if 'name' in kwargs:
            name = kwargs.pop('name')

        super().__init__(*args, **kwargs)

        if name:
            # Update label and help_text with file name
            self.fields['file'].label = _(f'{name.title()} File')
            self.fields['file'].help_text = _(f'Select {name} file to upload')

    def clean_file(self):
        """Run tabular file validation.

        If anything is wrong with the file, it will raise ValidationError
        """
        file = self.cleaned_data['file']

        # Validate file using FileManager class - will perform initial data validation
        # (and raise a ValidationError if there is something wrong with the file)
        FileManager.validate(file)

        return file


class MatchFieldForm(forms.Form):
    """Step 2 of FileManagementFormView."""

    def __init__(self, *args, **kwargs):
        """Setup filemanager and check columns."""
        # Get FileManager
        file_manager = None
        if 'file_manager' in kwargs:
            file_manager = kwargs.pop('file_manager')

        super().__init__(*args, **kwargs)

        # Setup FileManager
        file_manager.setup()
        # Get columns
        columns = file_manager.columns()
        # Get headers choices
        headers_choices = [(header, header) for header in file_manager.HEADERS]

        # Create column fields
        for col in columns:
            field_name = col['name']
            self.fields[field_name] = forms.ChoiceField(
                choices=[('', '-' * 10)] + headers_choices,
                required=False,
                widget=forms.Select(attrs={'class': 'select fieldselect'}),
            )
            if col['guess']:
                self.fields[field_name].initial = col['guess']


class MatchItemForm(forms.Form):
    """Step 3 of FileManagementFormView."""

    def __init__(self, *args, **kwargs):
        """Setup filemanager and create fields."""
        # Get FileManager
        file_manager = None
        if 'file_manager' in kwargs:
            file_manager = kwargs.pop('file_manager')

        if 'row_data' in kwargs:
            row_data = kwargs.pop('row_data')
        else:
            row_data = None

        super().__init__(*args, **kwargs)

        # Setup FileManager
        file_manager.setup()

        # Create fields
        if row_data:
            # Navigate row data
            for row in row_data:
                # Navigate column data
                for col in row['data']:
                    # Get column matching
                    col_guess = col['column'].get('guess', None)
                    # Set field name
                    field_name = col_guess.lower() + '-' + str(row['index'])

                    # check if field def was overridden
                    overriden_field = self.get_special_field(
                        col_guess, row, file_manager
                    )
                    if overriden_field:
                        self.fields[field_name] = overriden_field

                    # Create input for required headers
                    elif col_guess in file_manager.REQUIRED_HEADERS:
                        # Get value
                        value = row.get(col_guess.lower(), '')
                        # Set field input box
                        self.fields[field_name] = forms.CharField(
                            required=True, initial=value
                        )

                    # Create item selection box
                    elif col_guess in file_manager.OPTIONAL_MATCH_HEADERS:
                        # Get item options
                        item_options = [
                            (option.id, option)
                            for option in row['match_options_' + col_guess]
                        ]
                        # Get item match
                        item_match = row['match_' + col_guess]
                        # Set field select box
                        self.fields[field_name] = forms.ChoiceField(
                            choices=[('', '-' * 10)] + item_options,
                            required=False,
                            widget=forms.Select(attrs={'class': 'select bomselect'}),
                        )
                        # Update select box when match was found
                        if item_match:
                            self.fields[field_name].initial = item_match.id

                    # Create item selection box
                    elif col_guess in file_manager.ITEM_MATCH_HEADERS:
                        # Get item options
                        item_options = [
                            (option.id, option) for option in row['item_options']
                        ]
                        # Get item match
                        item_match = row['item_match']
                        # Set field name
                        field_name = 'item_select-' + str(row['index'])
                        # Set field select box
                        self.fields[field_name] = forms.ChoiceField(
                            choices=[('', '-' * 10)] + item_options,
                            required=False,
                            widget=forms.Select(attrs={'class': 'select bomselect'}),
                        )
                        # Update select box when match was found
                        if item_match:
                            # Make it a required field: does not validate if
                            # removed using JS function
                            # self.fields[field_name].required = True
                            # Update initial value
                            self.fields[field_name].initial = item_match.id

                    # Optional entries
                    elif col_guess in file_manager.OPTIONAL_HEADERS:
                        # Get value
                        value = row.get(col_guess.lower(), '')
                        # Set field input box
                        self.fields[field_name] = forms.CharField(
                            required=False, initial=value
                        )

    def get_special_field(self, col_guess, row, file_manager):
        """Function to be overridden in inherited forms to add specific form settings."""
        return None

1	"""Django forms for interacting with common objects."""
2
3	from django import forms
4	from django.utils.translation import gettext as _
5
6	from .files import FileManager
7
8
9	class UploadFileForm(forms.Form):
10	"""Step 1 of FileManagementFormView."""
11
12	file = forms.FileField(label=_('File'), help_text=_('Select file to upload'))	1✔
13
14	def __init__(self, args, *kwargs):	1✔
15	"""Update label and help_text."""
16	# Get file name
17	name = None
18	if 'name' in kwargs:
19	name = kwargs.pop('name')
20
21	super().__init__(args, *kwargs)
22
23	if name:
24	# Update label and help_text with file name
25	self.fields['file'].label = _(f'{name.title()} File')
26	self.fields['file'].help_text = _(f'Select {name} file to upload')
27
28	def clean_file(self):
29	"""Run tabular file validation.
30
31	If anything is wrong with the file, it will raise ValidationError
32	"""
33	file = self.cleaned_data['file']	×
34
35	# Validate file using FileManager class - will perform initial data validation
36	# (and raise a ValidationError if there is something wrong with the file)
37	FileManager.validate(file)	×
38
39	return file	×
40
41
42	class MatchFieldForm(forms.Form):	1✔
43	"""Step 2 of FileManagementFormView."""
44
45	def __init__(self, args, *kwargs):
46	"""Setup filemanager and check columns."""
47	# Get FileManager
48	file_manager = None	×
49	if 'file_manager' in kwargs:	×
50	file_manager = kwargs.pop('file_manager')	×
51
52	super().__init__(args, *kwargs)	×
53
54	# Setup FileManager
55	file_manager.setup()	×
56	# Get columns
57	columns = file_manager.columns()	×
58	# Get headers choices
59	headers_choices = [(header, header) for header in file_manager.HEADERS]	×
60
61	# Create column fields
62	for col in columns:	×
63	field_name = col['name']	×
64	self.fields[field_name] = forms.ChoiceField(
65	choices=[('', '-' * 10)] + headers_choices,
66	required=False,
67	widget=forms.Select(attrs={'class': 'select fieldselect'}),
68	)
69	if col['guess']:	×
70	self.fields[field_name].initial = col['guess']	×
71
72
73	class MatchItemForm(forms.Form):	1✔
74	"""Step 3 of FileManagementFormView."""
75
76	def __init__(self, args, *kwargs):
77	"""Setup filemanager and create fields."""
78	# Get FileManager
79	file_manager = None	×
80	if 'file_manager' in kwargs:	×
81	file_manager = kwargs.pop('file_manager')	×
82
83	if 'row_data' in kwargs:	×
84	row_data = kwargs.pop('row_data')	×
85	else:	×
86	row_data = None	×
87
88	super().__init__(args, *kwargs)	×
89
90	# Setup FileManager
91	file_manager.setup()	×
92
93	# Create fields
94	if row_data:	×
95	# Navigate row data
96	for row in row_data:	×
97	# Navigate column data
98	for col in row['data']:	×
99	# Get column matching
100	col_guess = col['column'].get('guess', None)	×
101	# Set field name
102	field_name = col_guess.lower() + '-' + str(row['index'])	×
103
104	# check if field def was overridden
105	overriden_field = self.get_special_field(
106	col_guess, row, file_manager
107	)
108	if overriden_field:	×
109	self.fields[field_name] = overriden_field	×
110
111	# Create input for required headers
112	elif col_guess in file_manager.REQUIRED_HEADERS:	×
113	# Get value
114	value = row.get(col_guess.lower(), '')	×
115	# Set field input box
116	self.fields[field_name] = forms.CharField(
117	required=True, initial=value
118	)
119
120	# Create item selection box
121	elif col_guess in file_manager.OPTIONAL_MATCH_HEADERS:	×
122	# Get item options
123	item_options = [
124	(option.id, option)
125	for option in row['match_options_' + col_guess]
126	]
127	# Get item match
128	item_match = row['match_' + col_guess]	×
129	# Set field select box
130	self.fields[field_name] = forms.ChoiceField(
131	choices=[('', '-' * 10)] + item_options,
132	required=False,
133	widget=forms.Select(attrs={'class': 'select bomselect'}),
134	)
135	# Update select box when match was found
136	if item_match:	×
137	self.fields[field_name].initial = item_match.id	×
138
139	# Create item selection box
140	elif col_guess in file_manager.ITEM_MATCH_HEADERS:	×
141	# Get item options
142	item_options = [
143	(option.id, option) for option in row['item_options']
144	]
145	# Get item match
146	item_match = row['item_match']	×
147	# Set field name
148	field_name = 'item_select-' + str(row['index'])	×
149	# Set field select box
150	self.fields[field_name] = forms.ChoiceField(
151	choices=[('', '-' * 10)] + item_options,
152	required=False,
153	widget=forms.Select(attrs={'class': 'select bomselect'}),
154	)
155	# Update select box when match was found
156	if item_match:	×
157	# Make it a required field: does not validate if
158	# removed using JS function
159	# self.fields[field_name].required = True
160	# Update initial value
161	self.fields[field_name].initial = item_match.id	×
162
163	# Optional entries
164	elif col_guess in file_manager.OPTIONAL_HEADERS:	×
165	# Get value
166	value = row.get(col_guess.lower(), '')	×
167	# Set field input box
168	self.fields[field_name] = forms.CharField(
169	required=False, initial=value
170	)
171
172	def get_special_field(self, col_guess, row, file_manager):	1✔
173	"""Function to be overridden in inherited forms to add specific form settings."""
174	return None

inventree / InvenTree / 8535197168

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous