Skip to content

Package field update method #222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JonoYang merged 8 commits into from
Nov 22, 2023
Merged

Package field update method #222

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d50cf71
Create methods to update package fields
JonoYang Nov 13, 2023
1a00a3b
Add tests
JonoYang Nov 14, 2023
23b75fa
Refactor update_fields and related methods
JonoYang Nov 17, 2023
695913f
Add test for update_fields special cases
JonoYang Nov 17, 2023
71c3e4a
Handle related models in update_fields
JonoYang Nov 21, 2023
60c5996
Test updating related models using update_fields
JonoYang Nov 21, 2023
db75be0
Update the logic around updated_fields
JonoYang Nov 22, 2023
bd1adf4
Test exceptions
JonoYang Nov 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update the logic around updated_fields 
Signed-off-by: Jono Yang <jyang@nexb.com>
  • Loading branch information
@JonoYang
JonoYang committed Nov 22, 2023
commit db75be0cbc4648689e73e729b2f678f3099ea12a
12 changes: 7 additions & 5 deletions packagedb/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -755,7 +755,7 @@ def update_fields(self, save=False, **values_by_fields):

msg = f"Replaced {model_count} existing entries of field '{field}' with {created_models_count} new entries."
self.append_to_history(msg)
replaced_fields.append(field)
replaced_fields.extend([field, 'history'])
else:
# Ensure the incoming value is of the correct type
if field == 'qualifiers' and isinstance(value, dict):
Expand Down Expand Up @@ -788,21 +788,23 @@ def update_fields(self, save=False, **values_by_fields):
history_entries.append(entry)
updated_fields.append(field)

if updated_fields:
updated_fields.append('history')
# Deduplicate field names
updated_fields = list(set(updated_fields))
if updated_fields and history_entries:
data = {
'updated_fields': history_entries,
}
self.append_to_history(
'Package field values have been updated.',
data=data,
)
updated_fields.append('history')

if replaced_fields:
updated_fields.extend(replaced_fields)

if updated_fields:
# Deduplicate field names
updated_fields = list(set(updated_fields))

if save:
self.save()

Expand Down
36 changes: 30 additions & 6 deletions packagedb/tests/test_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,11 @@ def test_packagedb_package_model_update_fields_related_models(self):
p1 = Package.objects.create(download_url='http://a.a', name='name', version='1.0')
path = 'asdf'
resources = [Resource(package=p1, path=path)]
p1.update_fields(resources=resources)
_, updated_fields = p1.update_fields(resources=resources)
self.assertEquals(
sorted(['resources', 'history']),
sorted(updated_fields)
)
expected_message = "Replaced 0 existing entries of field 'resources' with 1 new entries."
self.assertEqual(1, len(p1.history))
history_message = p1.history[0]['message']
Expand Down Expand Up @@ -334,7 +338,11 @@ def test_packagedb_package_model_update_fields_related_models(self):
"extra_data": {}
}
]
p2.update_fields(resources=resources)
_, updated_fields = p2.update_fields(resources=resources)
self.assertEquals(
sorted(['resources', 'history']),
sorted(updated_fields)
)
expected_message = "Replaced 0 existing entries of field 'resources' with 1 new entries."
self.assertEqual(1, len(p2.history))
history_message = p2.history[0]['message']
Expand All @@ -350,7 +358,11 @@ def test_packagedb_package_model_update_fields_related_models(self):
url='foo.com',
)
]
p3.update_fields(parties=parties)
_, updated_fields = p3.update_fields(parties=parties)
self.assertEquals(
sorted(['parties', 'history']),
sorted(updated_fields)
)
expected_message = "Replaced 0 existing entries of field 'parties' with 1 new entries."
self.assertEqual(1, len(p3.history))
history_message = p3.history[0]['message']
Expand All @@ -367,7 +379,11 @@ def test_packagedb_package_model_update_fields_related_models(self):
url='foo.com',
)
]
p4.update_fields(parties=parties)
_, updated_fields = p4.update_fields(parties=parties)
self.assertEquals(
sorted(['parties', 'history']),
sorted(updated_fields)
)
expected_message = "Replaced 0 existing entries of field 'parties' with 1 new entries."
self.assertEqual(1, len(p4.history))
history_message = p4.history[0]['message']
Expand All @@ -384,7 +400,11 @@ def test_packagedb_package_model_update_fields_related_models(self):
is_resolved=True,
)
]
p5.update_fields(dependencies=dependencies)
_, updated_fields = p5.update_fields(dependencies=dependencies)
self.assertEquals(
sorted(['dependencies', 'history']),
sorted(updated_fields)
)
expected_message = "Replaced 0 existing entries of field 'dependencies' with 1 new entries."
self.assertEqual(1, len(p5.history))
history_message = p5.history[0]['message']
Expand All @@ -402,7 +422,11 @@ def test_packagedb_package_model_update_fields_related_models(self):
is_resolved=True,
)
]
p6.update_fields(dependencies=dependencies)
_, updated_fields = p6.update_fields(dependencies=dependencies)
self.assertEquals(
sorted(['dependencies', 'history']),
sorted(updated_fields)
)
expected_message = "Replaced 0 existing entries of field 'dependencies' with 1 new entries."
self.assertEqual(1, len(p6.history))
history_message = p6.history[0]['message']
Expand Down