kobotoolbox / kpi / 12893591375

81%

master: 76%

Build Type

push

github

Committed by web-flow

Commit Message

feat(projectHistoryLogs): export project history logs TASK-1056 (#5430)

### 📣 Summary
Export project history logs to csv.


### 📖 Description
New endpoints for exporting project history logs. User can export logs
for a single project if they have the Manage Asset permission.
Superusers can export all project history logs.
Endpoint for exporting PH logs for a specific asset is
`/api/v2/assets/<uid>/history/export/`. Superuser-only endpoint for
exporting all PH logs is `/api/v2/project-history-logs/export`.


### 👷 Description for instance maintainers
One new migration to create the new type of export task. 


### 💭 Notes
Mostly a copy of the existing AccessLogExportTask, with some refactoring
to avoid too much repetition. New endpoints were added to existing views
rather than creating new views to avoid needing new entries in urls.py
and because the permissions were the same as the existing views.


### 👀 Preview steps

Feature/no-change template:
* Note: it's easiest to test this locally with kobo-compose, since that
will send all emails to the logs
* Note2: If testing locally, make sure to migrate kpi

1. ℹ️ have a superuser account and at least 2 projects
2. To make life easier, you should set `CELERY_TASK_ALWAYS_EAGER` to
True in base.py.
3. Create a few logs for each project by updating the form, deploying,
adding submissions, etc.
4. In the terminal, run `curl -X POST -H 'Authorization: Token <your
token>' /api/v2/assets/<uid1>/history/export/`
5. 🟢 It should return {"status":"created"}
6. In your kpi logs, you should see the text of an email, including a
link to a csv
7. 🟢 Copy the link into your browser. It should download a csv with just
the project history logs from the first project. The columns should be
user_url
user_uid
username
action
date_created
source
ip_address
asset_uid
other_details
4. In the terminal, run `curl -X POST -H 'Authorization: Token <your
token>' /api/v2/project-history-logs/export/`
5. 🟢 It should return {"status":"cr... (continued)

Run Details

5847 of 9356 branches covered (62.49%)

55 of 57 new or added lines in 3 files covered. (96.49%)

3 existing lines in 1 file now uncovered.

22322 of 27724 relevant lines covered (80.52%)

0.81 hits per line