doc: added test plan (#33)

ElixirCL · Feb 11, 2025 · e533477 · e533477
1 parent c8b5bce
commit e533477
Show file tree

Hide file tree

Showing 10 changed files with 44 additions and 0 deletions.
diff --git a/docs/modules/developer/images/delivery_form.png b/docs/modules/developer/images/delivery_form.png
diff --git a/docs/modules/developer/images/display_id.png b/docs/modules/developer/images/display_id.png
diff --git a/docs/modules/developer/images/done_command.png b/docs/modules/developer/images/done_command.png
diff --git a/docs/modules/developer/images/edit_delivery.png b/docs/modules/developer/images/edit_delivery.png
diff --git a/docs/modules/developer/images/live_location.png b/docs/modules/developer/images/live_location.png
diff --git a/docs/modules/developer/images/new_command.png b/docs/modules/developer/images/new_command.png
diff --git a/docs/modules/developer/images/update_user.png b/docs/modules/developer/images/update_user.png
diff --git a/docs/modules/developer/images/user_admin.png b/docs/modules/developer/images/user_admin.png
diff --git a/docs/modules/developer/nav.adoc b/docs/modules/developer/nav.adoc
@@ -1,3 +1,4 @@
 .Developer Docs
 * xref:dev_environment.adoc[]
 * xref:extensions.adoc[]
+* xref:test_plan.adoc[]
diff --git a/docs/modules/developer/pages/test_plan.adoc b/docs/modules/developer/pages/test_plan.adoc
@@ -0,0 +1,43 @@
+= 🔭 Test plan
+
+== Initialize a new delivery
+
+- Go to the following URL to open the create delivery form page:
+http://example.com/deliveries/new (The domain should be changed to the one where Tololo is hosted in)
+
+image::delivery_form.png[]
+
+- Fill the details of the delivery through the form.
+
+== Change the state from `Init` to `Ready to pickup`
+
+- Click on the "Edit" button.
+image::edit_delivery.png[]
+- Change state to "In preparation", then save.
+- Click on the "Edit" button again.
+- Change state to "Ready to pickup", then save.
+
+== Authenticate Telegram user
+
+- The delivery person should send a message to the Tololo Telegram bot. The content of the message can be anything.
+- An access request will be sent to Tololo, then an admin will have to approve the user through the admin dashboard. The admin dashboard is in the following page: http://example.com/admin 
+The default user is `admin`, and the default password is `test`.
+- In the dashboard, click the `Users` dropdown menu at the top of the page, then select `User`. Then, select `Read` to see a list of the users that the bot has interacted with.
+image::user_admin.png[]
+- Find the user you wish to approve, then click on the pencil button. In the following page, change the `status` field from `pending` to `allowed`.
+image::update_user.png[]
+- Click the `Save` button.
+
+== Pick delivery up through Telegram bot
+
+- Get the delivery display id. It will be shown in the delivery details page, after initializing the new delivery.
+image::display_id.png[]
+- Send the following command to the Telegram bot: `/new {display id}`.
+image::new_command.png[]
+- Share live location with bot.
+image::live_location.png[]
+
+== Mark delivery as done after delivering
+
+- Send the `/done` command, then select the option with the previous display id.
+image::done_command.png[]