Fixture generation utilities #9652

abdelrahman725 · 2022-08-23T15:28:52Z

GSoC Work Summary

created 3 python scripts for generating all relevant data for the following apps models

content
kolibriauth
lessons
exams
logger

Goal

before

Kolibri was lacking authentic testing data which should represent real usage scenarios, existing data generation utilities are run during unit test runtime making them not so efficient

after

new scripts that can generate authentic data ( for models of apps specefied above ) that are representable of real Kolibri data taking in account most use cases and scenarios with the ability of being deterministic i.e. developers can choose and specify what exact data to produce (e.g. range/number of data, what fields to include) depending on the current testing scenario requirements, ability to dump these generated data into fixtures .json files to be used directly in unit testing

Features

to do ..

Usage

run kolibri manage (script_name) with or without arguments

where script_name can be :

`generate_content_data` for content app

--channels number of channels trees default 1
--levels number of channel tree levels default 2
--children how many children for each parent node ( of kind topic ) default 3
--resources_kind kind of resources default random

`generate_auth_data` for kolibriauth, lessons and exams apps

--facilities number of facilities default 1
--not_assigned_users number of facility users that are not assigned to any collection default 5
--admins number of facility admins default 1
--coaches number of facility coaches default 1
--classes number of classes default 2
--class_coaches number of class coaches default 1
--class_learners number of class learners default 20
--class_lessons number of class lessons default 3
--class_exams number of class default 3
--groups number of groups per class default 1
--group_members number of group members default 5
--adhoc_lessons number of lessons assigned for specific learners default 0
--adhoc_lesson_learners number of adhoc_lesson learners default 0
--adhoc_exams number of exams assigned for specific learners default 0
--adhoc_exams_learners number of adhoc_exam learners default 0

`generate_interactions` for logger app

--users number of authenticated users default 20
--visitors number of anonymous users default 5
--start_time Minimum start_timstamp for all logs default 2022-01-01
--end_time Maximum end_timstamp for all logs default current run time
--session kolibri user session duration (in mins >=15 ) default 15
--n_sessions number of user sessions in kolibri (not used yet)
--n_resources how many resources should each user interact with (not used yet)

shared arguments

--mode generated data destination ( json file as fixtures or saved in local db) default default_db
--seed random seed value, so all operations can be randomized predictably default 1
--fixtures_path fixtures file path

Testing checklist

Contributor has fully tested the PR manually
If there are any front-end changes, before/after screenshots are included
Critical user journeys are covered by Gherkin stories
Critical and brittle code paths are covered by unit tests

PR process

PR has the correct target branch and milestone
PR has 'needs review' or 'work-in-progress' label
If PR is ready for review, a reviewer has been added. (Don't use 'Assignees')
If this is an important user-facing change, PR or related issue has a 'changelog' label
If this includes an internal dependency change, a link to the diff is provided

Reviewer checklist

Automated test coverage is satisfactory
PR is fully functional
PR has been tested for accessibility regressions
External dependency files were updated if necessary (yarn and pip)
Documentation is updated
Contributor is in AUTHORS.md

…sons and exams

github-actions · 2022-08-23T15:51:43Z

Build Artifacts

Asset type	Download link
PEX file	kolibri-0.16.0.dev0_git.20220923154252.pex
Unsigned Windows installer	kolibri-0.16.0.dev0+git.20220923154252-unsigned.exe
Debian Package	kolibri_0.16.0.dev0+git.20220923154252-0ubuntu1_all.deb
Mac Installer (DMG)	kolibri-0.16.0.dev0+git.20220923154252-0.3.0.dmg
Source Tarball	kolibri-0.16.0.dev0+git.20220923154252.tar.gz
WHL file	kolibri-0.16.0.dev0+git.20220923154252-py2.py3-none-any.whl

…auth,lessons and exams apps

jredrejo

I've left some comments inline in the code. After testing the command I've seen these issues too:

In generate_auth_data lessons and exams are always assigned to one single classroom , even if there are multiple
kolibri manage generate_auth_data --mode=default_db --groups=5 --class_exams=3 --class_lessons=5 --classes=4 creates 2 classes instead of 4
In generate_content_data level=3 produces 400 topics and 2401 nodes, can you explain this number? because kolibri manage generate_content_data --mode=default_db --levels=5 seems to be an infinite loop
In generate_content_data only video and topics are created, no other kinds
One test is failing in generate_auth_data.py, line 332, because you're trying to unpack one list inside a list with the * operator, that only works with functions
Creating the fixtures does not work because it looks for an unexisting directory:

 start dumping fixtures for content app 

CommandError: Unable to serialize database: [Errno 2] No such file or directory: 'fixtures/all_content_data.json'

Two separate comments:

you've created the PR using your develop branch. It's better if you create a different branch in your repository and create the PR from it, doing that way is much easier for you to do rebase if needed, and work on several issues at the same time.
when filling a PR is good to follow the provided template , in particular the "reviewing guidance" is helpful when reviewing code that can be complex. Beware that many PR are reviewed by QA people who don't need to be developers. It's good to provide instructions on how to test and what to test.

kolibri/core/auth/management/commands/generate_auth_data.py

kolibri/core/content/management/commands/generate_content_data.py

abdelrahman725 · 2022-08-25T16:25:41Z

In generate_auth_data lessons and exams are always assigned to one single classroom , even if there are multiple

i tested 2 classes and 5 lessons for each it it was working!

…h, lessons and exams apps

…ee of only that resource_kidn

jredrejo

Hello @abdelrahman725 ,
code for the two first commands look good and seem to work properly.
But generate_interactions.py does not, just executing it without any args, it fails with

  File "/datos/le/mio/kolibri/kolibri/core/logger/management/commands/generate_interactions.py", line 369, in generate_interactions
    generate_visitor_content_session_logs(
  File "/datos/le/mio/kolibri/kolibri/core/logger/management/commands/generate_interactions.py", line 280, in generate_visitor_content_session_logs
    generate_content_session_log(
  File "/datos/le/mio/kolibri/kolibri/core/logger/management/commands/generate_interactions.py", line 200, in generate_content_session_log
    return ContentSessionLog.objects.create(
  File "/datos/le/mio/kolibri/venv/lib/python3.10/site-packages/django/db/models/manager.py", line 85, in manager_method
    return getattr(self.get_queryset(), name)(*args, **kwargs)
  File "/datos/le/mio/kolibri/venv/lib/python3.10/site-packages/django/db/models/query.py", line 394, in create
    obj.save(force_insert=True, using=self.db)
  File "/datos/le/mio/kolibri/kolibri/core/logger/models.py", line 131, in save
    super(ContentSessionLog, self).save(*args, **kwargs)
  File "/datos/le/mio/kolibri/kolibri/core/auth/models.py", line 287, in save
    self.pre_save()
  File "/datos/le/mio/kolibri/kolibri/core/auth/models.py", line 282, in pre_save
    self.ensure_dataset()
  File "/datos/le/mio/kolibri/kolibri/core/auth/models.py", line 296, in ensure_dataset
    inferred_dataset_id = self.infer_dataset(*args, **kwargs)
  File "/datos/le/mio/kolibri/kolibri/core/logger/models.py", line 93, in infer_dataset
    raise AssertionError("Before you can save logs, you must have a facility")
AssertionError: Before you can save logs, you must have a facility

This has been tested after running the other two commands, so the db has both content and facilities and user, but you forgot to create a device settings, so logs can not find the default faciity of the system when adding a visitor that has not facility associated.
So, in generate_auth_data.py https://github.com/learningequality/kolibri/blob/develop/kolibri/core/device/utils.py#L93 needs to be executed

OTOH, as this PR is going to be converted into documentation for these commands, it would be good to add the default values for each of the different params the commands have. This is not a blocker anyway.

jredrejo · 2022-09-16T17:00:43Z

@abdelrahman725 I can confirm that using
kolibri manage generate_interactions --visitors=0
code seems to work as expected, so the only pending issue is ensuring that generate_auth_data provisions a device doing a call to the provision_device function.
i.e. something like

from kolibri.core.device.utils import device_provisioned
from kolibri.core.device.utils import provision_device
...
...
        # if device has not been provisioned, set it up
        if not device_provisioned():
            provision_device()

at the end of the start_generating function would do it.

rtibbles · 2024-12-19T20:18:08Z

Superseded by #11859

abdelrahman725 added 2 commits August 23, 2022 17:14

1st version of bedo scripts, fixtures generation for auth,content,les…

3d41fb0

…sons and exams

Merge branch 'develop' of github.com:abdelrahman725/kolibri into develop

7418b62

2nd version of bedo scripts (fixtures generation) for content,kolibri…

aff830a

…auth,lessons and exams apps

jredrejo requested changes Aug 25, 2022

View reviewed changes

abdelrahman725 added 7 commits August 30, 2022 21:51

3rd version of fixtures/default_db generation for content, kolibriaut…

2df1525

…h, lessons and exams apps

4th version of fixtures/default_db generation for content, kolibriaut…

e562e82

…h, lessons and exams apps

default to random if no resource_kind is specefied else generate a tr…

41f192c

…ee of only that resource_kidn

avoidance of hardcoding strings

10399cd

adding forgotten updates

58f4bff

minimum number of assessments, updated some parameters

1f9ddc0

Loggs generation v1

8b82fe7

jredrejo requested a review from rtibbles September 12, 2022 15:17

jredrejo added the TODO: needs review Waiting for review label Sep 12, 2022

jredrejo added this to the 0.16.0 milestone Sep 12, 2022

jredrejo requested changes Sep 16, 2022

View reviewed changes

rtibbles changed the title ~~Scripts 1st version (Fixtures generation for Testing)~~ Fixture generation utilities Sep 16, 2022

create device settings if not exist

9fe264c

rtibbles modified the milestones: Kolibri 0.16 Release: Existing Projects/General/Maintenance, Kolibri 0.17 Apr 15, 2023

marcellamaki modified the milestones: Kolibri 0.17, upcoming major Jul 25, 2023

rtibbles mentioned this pull request May 15, 2024

build(deps): bump eslint-plugin-vue from 7.3.0 to 9.26.0 #12173

Closed

rtibbles closed this Dec 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixture generation utilities #9652

Fixture generation utilities #9652

abdelrahman725 commented Aug 23, 2022 •

edited

Loading

github-actions bot commented Aug 23, 2022 •

edited

Loading

jredrejo left a comment •

edited

Loading

abdelrahman725 commented Aug 25, 2022

jredrejo left a comment •

edited

Loading

jredrejo commented Sep 16, 2022

rtibbles commented Dec 19, 2024

Fixture generation utilities #9652

Fixture generation utilities #9652

Conversation

abdelrahman725 commented Aug 23, 2022 • edited Loading

GSoC Work Summary

Goal

before

after

Features

Usage

generate_content_data for content app

generate_auth_data for kolibriauth, lessons and exams apps

generate_interactions for logger app

shared arguments

Testing checklist

PR process

Reviewer checklist

github-actions bot commented Aug 23, 2022 • edited Loading

Build Artifacts

jredrejo left a comment • edited Loading

Choose a reason for hiding this comment

abdelrahman725 commented Aug 25, 2022

jredrejo left a comment • edited Loading

Choose a reason for hiding this comment

jredrejo commented Sep 16, 2022

rtibbles commented Dec 19, 2024

abdelrahman725 commented Aug 23, 2022 •

edited

Loading

`generate_content_data` for content app

`generate_auth_data` for kolibriauth, lessons and exams apps

`generate_interactions` for logger app

github-actions bot commented Aug 23, 2022 •

edited

Loading

jredrejo left a comment •

edited

Loading

jredrejo left a comment •

edited

Loading