Add `state` to `departments` table #981

michplunkett · 2023-07-21T21:03:27Z

Fixes issue

Partially addresses this: #797

Description of Changes

Add state column to the departments table and update all relevant tests and features. This is the first step to addressing the Department state searching feature.

While taking care of the .format in models/database.py for Department, I took care of the other ones as well.

Tests and linting

This branch is up-to-date with the develop branch.
pytest passes on my local development environment.
pre-commit passes on my local development environment.

DB Migration Output

$ flask db upgrade
[2023-07-26 15:52:20,432] INFO in __init__: OpenOversight startup
INFO  [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO  [alembic.runtime.migration] Will assume transactional DDL.
INFO  [alembic.runtime.migration] Running upgrade 1931b987ce0d -> 18f43ac4622f, add state column to departments
$ flask db downgrade
[2023-07-26 15:52:25,802] INFO in __init__: OpenOversight startup
INFO  [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO  [alembic.runtime.migration] Will assume transactional DDL.
INFO  [alembic.runtime.migration] Running downgrade 18f43ac4622f -> 1931b987ce0d, add state column to departments
$ flask db upgrade
[2023-07-26 15:52:30,441] INFO in __init__: OpenOversight startup
INFO  [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO  [alembic.runtime.migration] Will assume transactional DDL.
INFO  [alembic.runtime.migration] Running upgrade 1931b987ce0d -> 18f43ac4622f, add state column to departments
$

michplunkett · 2023-07-25T23:07:05Z

I need to update documentation and some a couple of tests cases (test wide faker and PoliceDepartment class), and I'll merge it tomorrow.

abandoned-prototype · 2023-07-26T04:40:45Z

OpenOversight/tests/test_utils.py

 upload_s3_patch = patch(
    "OpenOversight.app.utils.cloud.upload_obj_to_s3",
    MagicMock(return_value="https://s3-some-bucket/someaddress.jpg"),
 )


+class PoliceDepartment:


What will this be used for? It seems to be basically the same as the class in database.py - all the same attributes

It's used an easier and more standard alternative to code like this:

name = "Added Police Department" short_name = "APD" unique_internal_identifier = "30ad0au239eas939asdj"

It doesn't come with all of the baggage that the database.py object does and it exists the test_utils.py as it's just a testing utility.

OpenOversight/tests/test_utils.py

abandoned-prototype · 2023-07-26T04:49:53Z

OpenOversight/tests/conftest.py

@@ -300,13 +300,20 @@ def add_mockdata(session):
    department = Department(
        name=DEPARTMENT_NAME,
        short_name="SPD",
+        state=random.sample(US_STATE_ABBREVIATIONS, 1)[0],


Problem with random is that it can lead to flaky tests (sometimes passing, sometimes not) which are much worse to fix than a test that always fails

OpenOversight/app/models/database.py

michplunkett · 2023-07-26T05:53:38Z

OpenOversight/app/commands.py

+@click.argument(
+    "department-state",
+    type=click.Choice([state.abbr for state in us.STATES]),
+)


In the next PR, once we can create and edit Departments from the front-end, we can make this required.

michplunkett · 2023-07-26T16:38:28Z

OpenOversight/app/models/database.py

    short_name = db.Column(db.String(100), unique=False, nullable=False)
+    state = db.Column(db.String(2), server_default="", nullable=False)


It's been set to db.Column(db.String(2), server_default="", nullable=False), @abandoned-prototype.

Partially addresses this: lucyparsons#797 Add `state` column to the `departments` table and update all relevant tests and features. This is the first step to addressing the Department state searching feature. While taking care of the `.format` in `models/database.py` for `Department`, I took care of the other ones as well. - [x] This branch is up-to-date with the `develop` branch. - [x] `pytest` passes on my local development environment. - [x] `pre-commit` passes on my local development environment. <details><summary>DB Migration Output</summary> ```console $ flask db upgrade [2023-07-26 15:52:20,432] INFO in __init__: OpenOversight startup INFO [alembic.runtime.migration] Context impl PostgresqlImpl. INFO [alembic.runtime.migration] Will assume transactional DDL. INFO [alembic.runtime.migration] Running upgrade 1931b987ce0d -> 18f43ac4622f, add state column to departments $ flask db downgrade [2023-07-26 15:52:25,802] INFO in __init__: OpenOversight startup INFO [alembic.runtime.migration] Context impl PostgresqlImpl. INFO [alembic.runtime.migration] Will assume transactional DDL. INFO [alembic.runtime.migration] Running downgrade 18f43ac4622f -> 1931b987ce0d, add state column to departments $ flask db upgrade [2023-07-26 15:52:30,441] INFO in __init__: OpenOversight startup INFO [alembic.runtime.migration] Context impl PostgresqlImpl. INFO [alembic.runtime.migration] Will assume transactional DDL. INFO [alembic.runtime.migration] Running upgrade 1931b987ce0d -> 18f43ac4622f, add state column to departments $ ``` </details>

michplunkett added 30 commits July 18, 2023 11:39

Update database.py

1913b2e

Create 2023-07-18-1616_33521389a38d_rename_star_date.py

f4b47f2

Update alembic.ini

a87425a

Update env.py

189c2a5

Delete 2023-07-18-1616_33521389a38d_rename_star_date.py

c6b0c9a

Create 2023-07-18-1717_9ce70d7ebd56_rename_star_date.py

65c7327

Update 2023-07-18-1717_9ce70d7ebd56_rename_star_date.py

80b2094

Update conftest.py

15c837c

Update bulk_upload.rst

8dce36a

Update downloads.py

bd994ff

Update forms.py

e7b0de0

Update officer_assignment_history.html

b0edeab

Update forms.py

a99e4d9

Update test_commands.py

bc4a323

Update commands.py

7fc0486

Update test_officer_and_department.py

b035d47

Update edit_assignment.html

f7210a3

Update csv_imports.py

4abffbd

Update database.py

c2704df

Update database_imports.py

86636a0

Update database.py

7507f55

Create 2023-07-18-1921_eb0266dc8588_rename_descrip_to_description.py

9aecce6

Update 2023-07-18-1921_eb0266dc8588_rename_descrip_to_description.py

1e3c0f2

Update test_utils.py

e217271

Update test_models.py

08fc13a

Update test_functional.py

358e512

Update test_officer_and_department.py

a5d3d9e

Update conftest.py

94aa26f

Update officer_assignment_history.html

9ff47ce

Update add_unit.html

86680d6

michplunkett added 6 commits July 25, 2023 17:34

Update conftest.py

3d2403b

Update csv_imports.py

430899c

Update test_commands.py

cf734f0

Update test_commands.py

5d6f10e

Update test_commands.py

99b1c53

PoliceDepartment class

7213477

michplunkett added 4 commits July 25, 2023 22:33

Update test_utils.py

3219610

Update test_commands.py

1c93ee4

Update commands.py

5a907b7

Update test_commands.py

3c2065f

abandoned-prototype reviewed Jul 26, 2023

View reviewed changes

michplunkett added 2 commits July 26, 2023 00:35

Update test_utils.py

ecfe526

Update database.py

704fbf5

michplunkett commented Jul 26, 2023

View reviewed changes

michplunkett added 8 commits July 26, 2023 10:32

Update test_models.py

0f87cbb

Use fixture instance of faker

93af8a7

Delete 2023-07-25-2122_bce7c55b6d90_add_state_column_to_departments.py

22dc467

Update database.py

9a4cdef

Create 2023-07-26-1551_18f43ac4622f_add_state_column_to_departments.py

9a32f0f

Update 2023-07-26-1551_18f43ac4622f_add_state_column_to_departments.py

1e53471

Update commands.py

9117aa4

Update advanced_csv_import.rst

b5a120c

michplunkett commented Jul 26, 2023

View reviewed changes

michplunkett merged commit 0e989eb into develop Jul 26, 2023
2 checks passed

michplunkett deleted the add_state_filtering branch July 26, 2023 16:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `state` to `departments` table #981

Add `state` to `departments` table #981

michplunkett commented Jul 21, 2023 •

edited

Loading

michplunkett commented Jul 25, 2023 •

edited

Loading

abandoned-prototype Jul 26, 2023

michplunkett Jul 26, 2023 •

edited

Loading

abandoned-prototype Jul 26, 2023

michplunkett Jul 26, 2023

michplunkett Jul 26, 2023

		short_name = db.Column(db.String(100), unique=False, nullable=False)
		state = db.Column(db.String(2), server_default="", nullable=False)

Add state to departments table #981

Add state to departments table #981

Conversation

michplunkett commented Jul 21, 2023 • edited Loading

Fixes issue

Description of Changes

Tests and linting

michplunkett commented Jul 25, 2023 • edited Loading

abandoned-prototype Jul 26, 2023

Choose a reason for hiding this comment

michplunkett Jul 26, 2023 • edited Loading

Choose a reason for hiding this comment

abandoned-prototype Jul 26, 2023

Choose a reason for hiding this comment

michplunkett Jul 26, 2023

Choose a reason for hiding this comment

michplunkett Jul 26, 2023

Choose a reason for hiding this comment

Add `state` to `departments` table #981

Add `state` to `departments` table #981

michplunkett commented Jul 21, 2023 •

edited

Loading

michplunkett commented Jul 25, 2023 •

edited

Loading

michplunkett Jul 26, 2023 •

edited

Loading