update e2e tests

Author: leo-aa88

.gitignore

@@ -13,3 +13,5 @@
 
 # Dependency directories (remove the comment below to include it)
 # vendor/
+__pycache__
+.pytest_cache

README.md

@@ -143,6 +143,78 @@ curl -H "Authorization: Bearer <YOUR_TOKEN>" http://localhost:8001/api/v1/books
 
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
 
-## TODOs
+## End-to-End (E2E) Tests
 
-- Unit tests
+This project contains end-to-end (E2E) tests to verify the functionality of the API. The tests are written in Python using the `pytest` framework.
+
+### Prerequisites
+
+Before running the tests, ensure you have the following:
+
+- Python 3.x installed
+- `pip` (Python package manager)
+- The API service running locally or on a staging server
+- API key available
+
+### Setup
+
+#### 1. Create a virtual environment (optional but recommended):
+
+```bash
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+```
+
+#### 2. Install dependencies:
+
+```bash
+pip install -r requirements.txt
+```
+
+The main dependency is `requests`, but you may need to include it in your `requirements.txt` file if it's not already listed.
+
+##@# 3. Set up the environment variables:
+
+You need to set the `BASE_URL` and `API_KEY` as environment variables before running the tests.
+
+For a **local** API service:
+
+```bash
+export BASE_URL=http://localhost:8001/api/v1
+export API_KEY=your-api-key-here
+```
+
+For a **staging** server:
+
+```bash
+export BASE_URL=https://staging-server-url.com/api/v1
+export API_KEY=your-api-key-here
+```
+
+On **Windows**, you can use:
+
+```bash
+set BASE_URL=http://localhost:8001/api/v1
+set API_KEY=your-api-key-here
+```
+
+#### 4. Run the tests:
+
+Once the environment variables are set, you can run the tests using `pytest`:
+
+```bash
+pytest test_e2e.py
+```
+
+### Test Structure
+
+The tests will perform the following actions:
+
+1. Register a new user and obtain a JWT token.
+2. Create a new book in the system.
+3. Retrieve all books and verify the created book is present.
+4. Retrieve a specific book by its ID.
+5. Update the book's details.
+6. Delete the book and verify it is no longer accessible.
+
+Each test includes assertions to ensure that the API behaves as expected.

pkg/api/user.go

@@ -94,7 +94,7 @@ func (r *userRepository) LoginHandler(c *gin.Context) {
 // @Accept  json
 // @Produce  json
 // @Param   user     body    models.LoginUser     true        "User registration object"
-// @Success 200 {string} string	"Successfully registered"
+// @Success 201 {string} string	"Successfully registered"
 // @Failure 400 {string} string "Bad Request"
 // @Failure 500 {string} string "Internal Server Error"
 // @Router /register [post]
@@ -122,5 +122,5 @@ func (r *userRepository) RegisterHandler(c *gin.Context) {
 		return
 	}
 
-	c.JSON(http.StatusOK, gin.H{"message": "Registration successful"})
+	c.JSON(http.StatusCreated, gin.H{"message": "Registration successful"})
 }

tests/e2e.py

@@ -1,5 +1,6 @@
 import requests
 import json
+import pytest
 
 # Define the base URL
 BASE_URL = "http://localhost:8001/api/v1"
@@ -11,72 +12,102 @@
 def get_jwt_token():
     # User registration (assuming it doesn't need authentication)
     register_url = f"{BASE_URL}/register"
-    register_data = json.dumps({"username": "testuser", "password": "securepassword"})
+    register_data = json.dumps({"username": "user1", "password": "securepassword"})
     register_response = requests.post(register_url, headers=headers, data=register_data)
-    print("Register User:", register_response.status_code, register_response.json())
+    
+    assert register_response.status_code in [200, 201], f"User registration failed: {register_response.status_code}"
 
     # User login
     login_url = f"{BASE_URL}/login"
-    login_data = json.dumps({"username": "testuser", "password": "securepassword"})
+    login_data = json.dumps({"username": "user1", "password": "securepassword"})
     login_response = requests.post(login_url, headers=headers, data=login_data)
-    print("Login User:", login_response.status_code, login_response.json())
+    
+    assert login_response.status_code == 200, f"User login failed: {login_response.status_code}"
 
     # Extracting JWT token from login response
-    jwt_token = login_response.json().get('token')
+    jwt_token = login_response.json().get('token')  
+    assert jwt_token is not None, "JWT token not found in login response"
+    
     return jwt_token
 
 # Create a new book
-def test_create_book(jwt_token):
+def create_book(jwt_token):
     url = f"{BASE_URL}/books"
     auth_headers = {**headers, "Authorization": f"Bearer {jwt_token}"}
     data = json.dumps({"author": "Jane Doe", "title": "New Book Title"})
     response = requests.post(url, headers=auth_headers, data=data)
-    print("Create Book:", response.status_code, response.json())
+    
+    assert response.status_code == 201, f"Failed to create book: {response.status_code}"
     return response.json()
 
 # Get all books
-def test_get_books(jwt_token):
+def get_books(jwt_token):
     url = f"{BASE_URL}/books"
     auth_headers = {**headers, "Authorization": f"Bearer {jwt_token}"}
     response = requests.get(url, headers=auth_headers)
-    print("Get Books:", response.status_code, response.json())
+    
+    assert response.status_code == 200, f"Failed to get books: {response.status_code}"
+    return response.json()
 
 # Get a specific book by ID
-def test_get_book(book_id, jwt_token):
+def get_book(book_id, jwt_token):
     url = f"{BASE_URL}/books/{book_id}"
     auth_headers = {**headers, "Authorization": f"Bearer {jwt_token}"}
     response = requests.get(url, headers=auth_headers)
-    print("Get Book:", response.status_code, response.json())
+    
+    assert response.status_code == 200, f"Failed to get book: {response.status_code}"
+    return response.json()
 
 # Update a book
-def test_update_book(book_id, jwt_token):
+def update_book(book_id, jwt_token):
     url = f"{BASE_URL}/books/{book_id}"
     auth_headers = {**headers, "Authorization": f"Bearer {jwt_token}"}
     data = json.dumps({"author": "John Smith", "title": "Updated Book Title"})
     response = requests.put(url, headers=auth_headers, data=data)
-    print("Update Book:", response.status_code, response.json())
+    
+    assert response.status_code == 200, f"Failed to update book: {response.status_code}"
+    return response.json()
 
 # Delete a book
-def test_delete_book(book_id, jwt_token):
+def delete_book(book_id, jwt_token):
     url = f"{BASE_URL}/books/{book_id}"
     auth_headers = {**headers, "Authorization": f"Bearer {jwt_token}"}
     response = requests.delete(url, headers=auth_headers)
-    print("Delete Book:", response.status_code)
+    
+    assert response.status_code == 204, f"Failed to delete book: {response.status_code}"
+
+# Tests using pytest
+@pytest.fixture(scope="module")
+def jwt_token():
+    return get_jwt_token()
+
+def test_create_book(jwt_token):
+    book = create_book(jwt_token)
+    assert book['data']['author'] == "Jane Doe"
+    assert book['data']['title'] == "New Book Title"
+    return book
+
+def test_get_books(jwt_token):
+    books = get_books(jwt_token)
+    assert isinstance(books, dict), "Books response is not a dictionary"
+    assert 'data' in books, "Books data not found in response"
 
-# Run tests
-def run_tests():
-    # Authenticate and obtain JWT
-    jwt_token = get_jwt_token()
-    if jwt_token:
-        # Create a book and use its ID for further tests
-        book = test_create_book(jwt_token)
-        book_id = book['data']['id']
+def test_get_book(jwt_token):
+    book = create_book(jwt_token)
+    book_id = book['data']['id']
+    fetched_book = get_book(book_id, jwt_token)
+    assert fetched_book['data']['id'] == book_id, "Fetched book ID does not match created book ID"
 
-        # Perform operations
-        test_get_books(jwt_token)
-        test_get_book(book_id, jwt_token)
-        test_update_book(book_id, jwt_token)
-        test_delete_book(book_id, jwt_token)
+def test_update_book(jwt_token):
+    book = create_book(jwt_token)
+    book_id = book['data']['id']
+    updated_book = update_book(book_id, jwt_token)
+    assert updated_book['data']['author'] == "John Smith", "Book author not updated"
+    assert updated_book['data']['title'] == "Updated Book Title", "Book title not updated"
 
-if __name__ == "__main__":
-    run_tests()
+def test_delete_book(jwt_token):
+    book = create_book(jwt_token)
+    book_id = book['data']['id']
+    delete_book(book_id, jwt_token)
+    with pytest.raises(AssertionError):
+        get_book(book_id, jwt_token)  # This should raise an error since the book is deleted