zoisite/Valerie&Tigist by tigistlina · Pull Request #12 · Ada-C19/solar-system-api

tigistlina · 2023-04-24T21:55:50Z

No description provided.

yangashley · 2023-04-26T21:04:26Z

+    results =[]
+    for planet in planets:
+        results.append(planet.create_dict())


This would be a good candidate for list comprehension, something like:

results = [planet.create_dict() for planet in planets]

yangashley · 2023-04-26T21:05:30Z

+@planets_bp.route("/<planet_id>", methods=["GET"])
+def get_planet(planet_id):
+        planet = validate_planet(planet_id)
+        return planet.create_dict()


I think lines 51 and 52 are indented two levels, but only needs to be indented once.

yangashley · 2023-04-26T21:06:08Z

@tigistlina @valerie-valentine Great work on waves 1 and 2 for Solar System, team! It looks like you've got a handle on creating a blueprint, registering it with your Flask app and writing routes. Nice job refactoring your code so that the routes can stay short and sweet!

yangashley

Nice job on Part 2 of Solar System! Left some comments about how to beef up the tests and adding error handling to your PUT request. Let me know if you have questions!

yangashley · 2023-05-08T21:51:51Z


 def create_app(test_config=None):
    app = Flask(__name__)
+    app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False


yangashley · 2023-05-08T21:52:15Z

@@ -0,0 +1,35 @@
+from app import db


Nicely done 🪐

yangashley · 2023-05-08T21:52:52Z

+        message = f"Planet {new_planet.name} successfully created"
+        return make_response(jsonify(message), 201)
+
+    except KeyError as e:


Nice job using try/except to add in error handling for a request that relies on (possibly incorrect) client data.

yangashley · 2023-05-08T21:53:05Z

+    if name_query:
+        planets = Planet.query.filter_by(name = name_query)
+
+    if nickname_query:
+        planets = Planet.query.filter_by(nickname = nickname_query)


yangashley · 2023-05-08T21:54:13Z

+
+    planet_to_update.name = planet_data["name"]
+    planet_to_update.description = planet_data["description"]
+    planet_to_update.size= planet_data["size"]
+    planet_to_update.moon_of_planet = planet_data["moon_of_planet"]
+    planet_to_update.habitable = planet_data["habitable"]
+    planet_to_update.gravity = planet_data["gravity"]
+    planet_to_update.nickname = planet_data["nickname"]
+
+    db.session.commit()
+
+    return make_response(jsonify(f"Planet { planet_to_update.name} updated"), 200)


Just like your POST request had error handling, your PUT request also needs it too. If a client sends a PUT req, but the request body had "planet_size" instead of "size", line 64 will throw an error (500 status code), but what we want our route to do is respond with an error message that gives the client feedback about what went wrong.

yangashley · 2023-05-08T21:58:57Z

+    assert response_body == {
+        "description": "A dusty, cold, desert world with a very thin atmosphere",
+        "gravity": "3.721 m/s²",
+        "habitable": False,
+        "id": 1,
+        "moon_of_planet": "Phobos & Deimos",
+        "name": "Mars",
+        "nickname": "Red Planet",
+        "size": "6,792 km"
+    }


Per my comment above in the multiple_planets fixture, if that fixture returned a list of your 3 saved planets then you could check the response_body against your fixture (where you saved the planets when this test first runs)!

saved_planet_1 = multiple_planets[0] assert response_body["id"] == saved_planet_1.id assert response_body["description"] == saved_planet_1.description # continue writing the rest of the assertions for all the attributes in saved_planet_1

yangashley · 2023-05-08T22:02:22Z

+    assert response_body == [{
+        "description": "A dusty, cold, desert world with a very thin atmosphere",
+        "gravity": "3.721 m/s²",
+        "habitable": False,
+        "id": 1,
+        "moon_of_planet": "Phobos & Deimos",
+        "name": "Mars",
+        "nickname": "Red Planet",
+        "size": "6,792 km"
+    }, {
+        "name": "Saturn",
+        "description": "The second-largest planet in solar system.",
+        "size": "36,183.7 miles",
+        "moon_of_planet": "Iapetus, Rhea, Dione, and Tethys",
+        "habitable": False,
+        "id": 2,
+        "gravity": "10.44 m/s²",
+        "nickname": "Ringed Planet"
+    }, {
+        "name": "Neptune",
+        "description": "Dark, cold, and whipped by supersonic winds, ice giant.",
+        "size": "24,622 km",
+        "moon_of_planet": "Triton",
+        "habitable": False,
+        "id": 3,
+        "gravity": "11.15 m/s²",
+        "nickname": "Ice Giant"
+    }]


Similar to my comment above for test_get_one_planet_by_id, if the fixture multiple_planets returned a list of saved planets, you can check the response_body against the saved planets.

# incomplete assertions, but some examples for what you can write so that the test is more robust assert response_body[0]["id"] == multiple_planets[0].id assert response_body[0]["name"] == multiple_planets[0].name assert response_body[0]["description"] == multiple_planets[0].description assert response_body[0]["habitable"] == multiple_planets[0].habitable assert response_body[1]["id"] == multiple_planets[1].id assert response_body[1]["name"] == multiple_planets[1].name assert response_body[1]["description"] == multiple_planets[1].description assert response_body[1]["habitable"] == multiple_planets[1].habitable # finish the rest of the assertions for the 3rd planet

yangashley · 2023-05-08T22:02:42Z

+
+def test_creates_one_planet(client):
+    #Arrange
+    Expected_planet = {


constant variable should be named in all caps like EXPECTED_PLANET

yangashley · 2023-05-08T22:04:07Z

+    assert response.status_code == 201
+    assert response_body == "Planet Venus successfully created"


A way to make this test more robust would to check the response_body against the request body that you create for the post request.

actual_planet = Planet.query.get(1) assert actual_planet.name == EXPECTED_PLANET["name"] assert actual_planet.description == EXPECTED_PLANET["description"] assert actual_planet.size == EXPECTED_PLANET["size"] # write assertions for all the attributes on a planet

yangashley · 2023-05-08T22:04:30Z

+    response_body = response.get_json()
+    assert response.status_code == 200
+    assert response_body == "Planet Earth updated"
+    assert actual_planet.name == replaced_planet["name"]


To make this test more robust, be sure to write assertions for all the attributes on a planet.

tigistlina and others added 9 commits April 21, 2023 20:12

wave-01 complete

871339d

[WIP] - Wave 1

70d78c0

Merge branch 'main' of https://github.com/tigistlina/solar-system-api

25ecd77

RESOLVED MERGE CONFLICT

789c169

Wave 02 - Refactoring

69c7a10

Finished Wave 2

3918b02

refactor wave 2

70352de

Finished wave 1 & Wave 2

f7c4666

Merge branch 'main' of https://github.com/tigistlina/solar-system-api

1dad0e8

yangashley reviewed Apr 26, 2023

View reviewed changes

tigistlina and others added 18 commits April 28, 2023 12:59

adds more attributes

9dccaaa

create Planet model table

130caac

Finished handle planet endpoint

ef68c3d

resolves conflict

8ec0f0d

Changed planet table column datatypes

5533430

removed white space

a6810cf

Merge branch 'main' of https://github.com/tigistlina/solar-system-api

a0f5a97

Finished Wave 3 Complete

3a93d5d

solves merge conflict

d2572b5

Merge branch 'main' of https://github.com/tigistlina/solar-system-api

981e916

changed parent_planet column to mmon_of_planet

51ff409

creates validate_planet and get_one_planet end point

e7663b4

defines update_planet end point

6112ac7

Finished Wave 4

00e54c5

Create env file and setup databases

8f6c798

WIP creating test checks empty db returns empty list

a252622

Finished wave 6 - implemented tests

1c20053

setup .env file

adecf6d

tigistlina and others added 3 commits May 3, 2023 21:50

Merge branch 'main' of https://github.com/tigistlina/solar-system-api

5df9359

refactors code, creates helper function

847f3ef

Finished refactoring project

0e57c3c

yangashley reviewed May 8, 2023

View reviewed changes

		assert response.status_code == 201
		assert response_body == "Planet Venus successfully created"

Conversation

tigistlina commented Apr 24, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yangashley commented Apr 26, 2023

Uh oh!

yangashley left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants