Merge pull request 'put-images' (#18) from put-images into develop

Reviewed-on: #18
This commit is contained in:
bizcochito 2024-01-06 12:45:36 +00:00
commit 478487d402
5 changed files with 152 additions and 7 deletions

View File

@ -15,6 +15,7 @@ app.get("/", (_, res) => {
app.get("/images", imageController.getAllImages); app.get("/images", imageController.getAllImages);
app.get("/images/:id", imageController.getImageById); app.get("/images/:id", imageController.getImageById);
app.put("/images/:id", authControler.authorize, imageController.editImage);
app.post("/images", authControler.authorize, imageController.addImage); app.post("/images", authControler.authorize, imageController.addImage);
app.post("/login", authControler.login); app.post("/login", authControler.login);
@ -30,6 +31,7 @@ export const startApp = async () => {
user: mongo_user, user: mongo_user,
pass: mongo_pass, pass: mongo_pass,
}); });
mongoose.set("runValidators", true);
app.listen(port, () => app.listen(port, () =>
console.log(`Express server listening on port ${port}`) console.log(`Express server listening on port ${port}`)
); );

View File

@ -1,8 +1,37 @@
import { Request, Response } from "express"; import { Request, Response } from "express";
import imageService from "../services/ImageService"; import imageService from "../services/ImageService";
import mongoose, { mongo } from "mongoose"; import mongoose, { mongo } from "mongoose";
import { Image } from "../models/ImageModel";
class ImageController { class ImageController {
async editImage(req: Request, res: Response) {
try {
const change: Image = req.body;
const result = await imageService.replaceOne(req.params.id, change);
if (result.matchedCount > 0) {
res.status(204).json();
} else {
res.status(404).json({ error: "Image not found" });
}
} catch (error: any) {
if (error instanceof mongoose.Error.CastError) {
res.status(400).json({ error: "Invalid Id" });
} else if (error instanceof mongoose.Error.ValidationError) {
// Should return 400 Bad request for invalid requests
res.status(400).json({ error: error.message });
} else if (
error instanceof mongo.MongoServerError &&
error.code === 11000
) {
// Should return 409 Conflict for existing urls
res.status(409).json({
error: `the image with URL ${error.keyValue.url} already exists`,
});
} else {
res.status(500).json({ error: "Internal Server Error" });
}
}
}
async getImageById(req: Request, res: Response) { async getImageById(req: Request, res: Response) {
try { try {
const image = await imageService.findById(req.params.id); const image = await imageService.findById(req.params.id);

View File

@ -6,7 +6,7 @@ await startApp();
// This try carch is to prevent hot reload from making the process die due to coliding entries // This try carch is to prevent hot reload from making the process die due to coliding entries
try { try {
// Not insert test data into production // Not insert test data into production
if (process.env.NODE_ENV != "production"){ if (process.env.NODE_ENV != "production") {
await populateDatabase(); await populateDatabase();
} }
} catch {} } catch {}

View File

@ -1,6 +1,10 @@
import imageModel, { Image } from "../models/ImageModel"; import imageModel, { Image } from "../models/ImageModel";
class ImageService { class ImageService {
async replaceOne(id: string, newimage: Image) {
const result = await imageModel.updateOne({ _id: id }, newimage);
return result;
}
async findById(id: string) { async findById(id: string) {
const image = await imageModel.findOne({ _id: id }); const image = await imageModel.findOne({ _id: id });
return image; return image;

View File

@ -3,6 +3,7 @@ import request, { Response } from "supertest";
import app, { startApp } from "../src/app"; import app, { startApp } from "../src/app";
import imageService from "../src/services/ImageService"; import imageService from "../src/services/ImageService";
import populateDatabase from "./populateDatabase"; import populateDatabase from "./populateDatabase";
import { Image } from "../src/models/ImageModel";
const imageServiceOriginal = imageService; const imageServiceOriginal = imageService;
@ -165,7 +166,6 @@ describe("POST /images works properly", () => {
}); });
it("should return 400 for malformed requests", async () => { it("should return 400 for malformed requests", async () => {
mock.restore();
const res = await request(app) const res = await request(app)
.post("/images") .post("/images")
.set("authorization", `Bearer ${token}`) .set("authorization", `Bearer ${token}`)
@ -178,18 +178,23 @@ describe("POST /images works properly", () => {
}); });
}); });
describe("/images/:id works properly", () => { describe("GET /images/<id> works properly", () => {
let id: string;
let list: Image[];
beforeAll(async () => {
const res = await request(app).get("/images");
list = res.body.images;
id = list[0]._id;
});
it("should return 200 for existing ids", async () => { it("should return 200 for existing ids", async () => {
const list = await request(app).get("/images");
const id = list.body.images[0]._id;
const res = await request(app).get(`/images/${id}`); const res = await request(app).get(`/images/${id}`);
expect(res.status).toBe(200); expect(res.status).toBe(200);
}); });
it("should return 404 for non-existing ids", async () => { it("should return 404 for non-existing ids", async () => {
const list = await request(app).get("/images");
const id = "000000000000000000000000"; // this was the least posible to exist ID const id = "000000000000000000000000"; // this was the least posible to exist ID
if (!(id in list.body.images)) { if (!(id in list)) {
const res = await request(app).get(`/images/${id}`); const res = await request(app).get(`/images/${id}`);
expect(res.status).toBe(404); expect(res.status).toBe(404);
} }
@ -200,3 +205,108 @@ describe("/images/:id works properly", () => {
expect(res.status).toBe(400); expect(res.status).toBe(400);
}); });
}); });
describe("PUT /images/<id> works properly", () => {
let id: string;
let list: Image[];
beforeAll(async () => {
const res = await request(app).get("/images");
list = res.body.images;
id = list[0]._id;
});
it("should return 204 for valid modifications", async () => {
const res = await request(app)
.put(`/images/${id}`)
.set("authorization", `Bearer ${token}`)
.send({ status: "available" });
expect(res.status).toBe(204);
});
it("should return 404 for non-existing ids", async () => {
const id = "000000000000000000000000"; // this was the least posible to exist ID
if (!(id in list)) {
const res = await request(app)
.put(`/images/${id}`)
.set("authorization", `Bearer ${token}`)
.send({ status: "available" });
expect(res.status).toBe(404);
}
});
it("should return 400 for malformed ids", async () => {
const res = await request(app)
.put("/images/98439384")
.set("authorization", `Bearer ${token}`)
.send({ status: "available" });
expect(res.status).toBe(400);
expect(res.body).toEqual({ error: "Invalid Id" });
});
it("should return 400 for malformed requests", async () => {
const res = await request(app)
.put(`/images/${id}`)
.set("authorization", `Bearer ${token}`)
.send({ status: "wrong" });
expect(res.status).toBe(400);
});
it("should return 409 if we try to modify the url into an existing one", async () => {
const res = await request(app)
.put(`/images/${id}`)
.set("authorization", `Bearer ${token}`)
.send({ url: "https://test.url.com/2" });
expect(res.status).toBe(409);
});
it("should return 500 for an error on the service", async () => {
mock.module("../src/services/ImageService", () => ({
default: {
replaceOne: () => {
throw new Error("This is an expected testing error");
},
},
}));
const res = await request(app)
.put(`/images/${id}`)
.set("authorization", `Bearer ${token}`)
.send({ status: "available" });
expect(res.status).toBe(500);
});
it("should return 401 for unauthenticated requests", async () => {
const res = await request(app)
.put(`/images/${id}`)
.send({ status: "available" });
expect(res.status).toBe(401);
});
it("should return 403 for invalid tokens", async () => {
const res = await request(app)
.put(`/images/${id}`)
.set("authorization", `Bearer token`)
.send({ status: "available" });
expect(res.status).toBe(403);
});
it("should have its changes be reflected onto the DB", async () => {
const image = await request(app)
.post("/images")
.set("authorization", `Bearer ${token}`)
.send({
url: "https://test.url.com/5",
status: "available",
tags: ["2girls", "touhou"],
});
const id = image.body.image._id;
await request(app)
.put(`/images/${id}`)
.set("authorization", `Bearer ${token}`)
.send({ status: "consumed" });
const res = await request(app).get(`/images/${id}`);
expect(res.body.image).toHaveProperty("status", "consumed");
})
});