API - refacto tests

move some tests in models tests (to simplify api tests)
 + doc fix

fittrackee/tests/workouts/test_workouts_model.py

@@ -1,15 +1,17 @@
-from uuid import UUID
+from datetime import timedelta
 
 from flask import Flask
 
 from fittrackee import db
 from fittrackee.users.models import User
 from fittrackee.workouts.models import Sport, Workout
-from fittrackee.workouts.utils.short_id import decode_short_id
+from fittrackee.workouts.utils.short_id import encode_uuid
+
+from ..utils import random_string
 
 
 class TestWorkoutModel:
-    def test_workout_model(
+    def test_sport_label_and_date_are_in_string_value(
         self,
         app: Flask,
         sport_1_cycling: Sport,
@@ -18,48 +20,109 @@ class TestWorkoutModel:
     ) -> None:
         workout_cycling_user_1.title = 'Test'
         db.session.commit()
-
-        assert 1 == workout_cycling_user_1.id
-        assert workout_cycling_user_1.uuid is not None
-        assert 1 == workout_cycling_user_1.user_id
-        assert 1 == workout_cycling_user_1.sport_id
-        assert '2018-01-01 00:00:00' == str(
-            workout_cycling_user_1.workout_date
-        )
-        assert 10.0 == float(workout_cycling_user_1.distance)
-        assert '1:00:00' == str(workout_cycling_user_1.duration)
-        assert 'Test' == workout_cycling_user_1.title
         assert '<Workout \'Cycling\' - 2018-01-01 00:00:00>' == str(
             workout_cycling_user_1
         )
 
-        serialized_workout = workout_cycling_user_1.serialize()
-        assert isinstance(decode_short_id(serialized_workout['id']), UUID)
-        assert 'test' == serialized_workout['user']
-        assert 1 == serialized_workout['sport_id']
-        assert serialized_workout['title'] == 'Test'
-        assert 'creation_date' in serialized_workout
-        assert serialized_workout['modification_date'] is not None
-        assert str(serialized_workout['workout_date']) == '2018-01-01 00:00:00'
-        assert serialized_workout['duration'] == '1:00:00'
-        assert serialized_workout['pauses'] is None
-        assert serialized_workout['moving'] == '1:00:00'
-        assert serialized_workout['distance'] == 10.0
-        assert serialized_workout['max_alt'] is None
-        assert serialized_workout['descent'] is None
+    def test_short_id_returns_encoded_workout_uuid(
+        self,
+        app: Flask,
+        sport_1_cycling: Sport,
+        user_1: User,
+        workout_cycling_user_1: Workout,
+    ) -> None:
+        assert workout_cycling_user_1.short_id == encode_uuid(
+            workout_cycling_user_1.uuid
+        )
+
+    def test_serialize_for_workout_without_gpx(
+        self,
+        app: Flask,
+        sport_1_cycling: Sport,
+        user_1: User,
+        workout_cycling_user_1: Workout,
+    ) -> None:
+        workout = workout_cycling_user_1
+
+        serialized_workout = workout.serialize()
         assert serialized_workout['ascent'] is None
-        assert serialized_workout['max_speed'] == 10.0
-        assert serialized_workout['ave_speed'] == 10.0
-        assert serialized_workout['with_gpx'] is False
+        assert serialized_workout['ave_speed'] == float(workout.ave_speed)
         assert serialized_workout['bounds'] == []
-        assert serialized_workout['previous_workout'] is None
-        assert serialized_workout['next_workout'] is None
-        assert serialized_workout['segments'] == []
-        assert serialized_workout['records'] != []
+        assert 'creation_date' in serialized_workout
+        assert serialized_workout['descent'] is None
+        assert serialized_workout['distance'] == float(workout.distance)
+        assert serialized_workout['duration'] == str(workout.duration)
+        assert serialized_workout['id'] == workout.short_id
         assert serialized_workout['map'] is None
-        assert serialized_workout['weather_start'] is None
-        assert serialized_workout['weather_end'] is None
+        assert serialized_workout['max_alt'] is None
+        assert serialized_workout['max_speed'] == float(workout.max_speed)
+        assert serialized_workout['min_alt'] is None
+        assert serialized_workout['modification_date'] is None
+        assert serialized_workout['moving'] == str(workout.moving)
+        assert serialized_workout['next_workout'] is None
         assert serialized_workout['notes'] is None
+        assert serialized_workout['pauses'] is None
+        assert serialized_workout['previous_workout'] is None
+        assert serialized_workout['records'] == [
+            record.serialize() for record in workout.records
+        ]
+        assert serialized_workout['segments'] == []
+        assert serialized_workout['sport_id'] == workout.sport_id
+        assert serialized_workout['title'] == workout.title
+        assert serialized_workout['user'] == workout.user.username
+        assert serialized_workout['weather_end'] is None
+        assert serialized_workout['weather_start'] is None
+        assert serialized_workout['with_gpx'] is False
+        assert str(serialized_workout['workout_date']) == '2018-01-01 00:00:00'
+
+    def test_serialize_for_workout_with_gpx(
+        self,
+        app: Flask,
+        sport_1_cycling: Sport,
+        user_1: User,
+        workout_cycling_user_1: Workout,
+        workout_cycling_user_1_segment: Workout,
+    ) -> None:
+        workout = workout_cycling_user_1
+        workout.bounds = [1, 2, 3, 4]
+        workout.gpx = random_string()
+        workout.map = random_string()
+        workout.pauses = timedelta(minutes=15)
+
+        serialized_workout = workout.serialize()
+        assert serialized_workout['ascent'] is None
+        assert serialized_workout['ave_speed'] == float(workout.ave_speed)
+        assert serialized_workout['bounds'] == [
+            float(bound) for bound in workout.bounds
+        ]
+        assert 'creation_date' in serialized_workout
+        assert serialized_workout['descent'] is None
+        assert serialized_workout['distance'] == float(workout.distance)
+        assert serialized_workout['duration'] == str(workout.duration)
+        assert serialized_workout['id'] == workout.short_id
+        assert serialized_workout['map'] is None
+        assert serialized_workout['max_alt'] is None
+        assert serialized_workout['max_speed'] == float(workout.max_speed)
+        assert serialized_workout['min_alt'] is None
+        assert serialized_workout['modification_date'] is not None
+        assert serialized_workout['moving'] == str(workout.moving)
+        assert serialized_workout['next_workout'] is None
+        assert serialized_workout['notes'] is None
+        assert serialized_workout['pauses'] == str(workout.pauses)
+        assert serialized_workout['previous_workout'] is None
+        assert serialized_workout['records'] == [
+            record.serialize() for record in workout.records
+        ]
+        assert serialized_workout['segments'] == [
+            segment.serialize() for segment in workout.segments
+        ]
+        assert serialized_workout['sport_id'] == workout.sport_id
+        assert serialized_workout['title'] == workout.title
+        assert serialized_workout['user'] == workout.user.username
+        assert serialized_workout['weather_end'] is None
+        assert serialized_workout['weather_start'] is None
+        assert serialized_workout['with_gpx'] is True
+        assert str(serialized_workout['workout_date']) == '2018-01-01 00:00:00'
 
     def test_workout_segment_model(
         self,
@@ -74,3 +137,35 @@ class TestWorkoutModel:
             f'for workout \'{workout_cycling_user_1.short_id}\'>'
             == str(workout_cycling_user_1_segment)
         )
+
+    def test_it_returns_previous_workout(
+        self,
+        app: Flask,
+        sport_1_cycling: Sport,
+        sport_2_running: Sport,
+        user_1: User,
+        workout_cycling_user_1: Workout,
+        workout_running_user_1: Workout,
+    ) -> None:
+        serialized_workout = workout_running_user_1.serialize()
+
+        assert (
+            serialized_workout['previous_workout']
+            == workout_cycling_user_1.short_id
+        )
+
+    def test_it_returns_next_workout(
+        self,
+        app: Flask,
+        sport_1_cycling: Sport,
+        sport_2_running: Sport,
+        user_1: User,
+        workout_cycling_user_1: Workout,
+        workout_running_user_1: Workout,
+    ) -> None:
+        serialized_workout = workout_cycling_user_1.serialize()
+
+        assert (
+            serialized_workout['next_workout']
+            == workout_running_user_1.short_id
+        )