v1.0.0 #28

Merged
bizcochito merged 147 commits from develop into main 2024-01-14 19:49:34 +00:00
9 changed files with 239 additions and 81 deletions
Showing only changes of commit 9e064fc56e - Show all commits

View File

@ -27,6 +27,7 @@ services:
MONGODB_URI: "mongodb://mongodb:27017/bot"
MONGODB_USER: "root"
MONGODB_PASS: "password"
JWTSECRET: "cooljwtsecret"
volumes:
- ./:/usr/src/app:ro

View File

@ -1,24 +1,30 @@
db.createUser({
user: 'root',
pwd: 'password',
roles: [
{
role: 'readWrite',
db: 'admin',
},
{
role: 'readWrite',
db: 'bot',
},
],
user: "root",
pwd: "password",
roles: [
{
role: "readWrite",
db: "admin",
},
{
role: "readWrite",
db: "bot",
},
],
});
db = new Mongo().getDB("bot");
db.images.createIndex({ "status": 1 });
db.images.createIndex({ "url": 1 }, { "unique": true });
db.images.createIndex({ status: 1 });
db.images.createIndex({ url: 1 }, { unique: true });
db.images.insert({
url: "https://example.com",
status: "consumed",
tags: ["2girls", "sleeping"]
});
url: "https://example.com",
status: "consumed",
tags: ["2girls", "sleeping"],
});
db.authorizations.createIndex({ app: 1 });
db.authorizations.insert({
app: "tester",
secret: "test",
});

View File

@ -22,9 +22,11 @@
"dependencies": {
"@types/express": "^4.17.21",
"@types/express-list-endpoints": "^6.0.3",
"@types/jsonwebtoken": "^9.0.5",
"@types/mongoose": "^5.11.97",
"express": "^4.18.2",
"express-list-endpoints": "^6.0.0",
"jsonwebtoken": "^9.0.2",
"mongoose": "^8.0.3"
}
}

View File

@ -0,0 +1,49 @@
import jwt from "jsonwebtoken";
import AuthService from "../services/AuthService";
import { Request, Response, NextFunction } from "express";
const authTokenSecret = process.env.JWTSECRET || "badsecret";
class AuthControler {
async login(req: Request, res: Response) {
// Read app and secret from request body
const { app, secret } = req.body;
// Filter app from the apps by app and secret
const authenticated = await AuthService.find(app, secret);
if (authenticated) {
console.log("Authenticated app ", authenticated.app);
// Generate an access token
const accessToken = jwt.sign(
{ app: authenticated.app },
authTokenSecret,
{ expiresIn: "1h" }
);
res.json({
token: accessToken,
});
} else {
res.status(403).send("Credentials incorrect");
}
}
authorize(req: Request, res: Response, next: NextFunction) {
const authHeader = req.headers.authorization;
if (authHeader) {
const token = authHeader.split(" ")[1];
jwt.verify(token, authTokenSecret, (err, app) => {
if (err) {
return res.status(403).json("Invalid token provided");
}
next();
});
} else {
res.status(401).json("No Authorization header provided");
}
}
}
export default new AuthControler();

View File

@ -2,6 +2,7 @@ import express from "express";
import mongoose from "mongoose";
import listEndpoints from "express-list-endpoints";
import imageController from "./controllers/ImageController";
import authControler from "./controllers/AuthControler";
export const app = express();
@ -13,7 +14,8 @@ app.get("/", (_, res) => {
});
app.get("/images", imageController.getAllImages);
app.post("/images", imageController.addImage);
app.post("/images", authControler.authorize, imageController.addImage);
app.post("/login", authControler.login)
// Set the default port to 8080, or use the PORT environment variable

19
src/models/AuthModel.ts Normal file
View File

@ -0,0 +1,19 @@
import mongoose, { Document } from "mongoose";
export interface Auth extends Document {
app: String,
secret: String
}
const AuthSchema = new mongoose.Schema({
app: {
type: String,
required: true,
},
secret: {
type: String,
required: true,
},
});
export default mongoose.model("authorizations", AuthSchema);

View File

@ -0,0 +1,10 @@
import AuthModel, { Auth } from "../models/AuthModel";
class AuthService {
async find(app: String, secret: String): Promise<Auth | null> {
const auth = await AuthModel.findOne({ app: app, secret: secret }).exec();
return auth;
}
}
export default new AuthService();

View File

@ -1,88 +1,135 @@
import { afterEach, describe, expect, it, mock } from "bun:test";
import { afterEach, beforeAll, describe, expect, it, mock } from "bun:test";
import request from "supertest";
import { app } from "../src";
import imageService from "../src/services/ImageService";
const imageServiceOriginal = imageService;
const tok = await request(app)
.post("/login")
.send({ app: "tester", secret: "test" });
const token = tok.body.token;
afterEach(() => {
mock.restore();
mock.module("../src/services/ImageService", () => ({ default: imageServiceOriginal }));
})
mock.restore();
mock.module("../src/services/ImageService", () => ({
default: imageServiceOriginal,
}));
});
describe("GET / shows all of the endpoints", async () => {
const res = await request(app).get("/");
const res = await request(app).get("/");
it("should be", async () => {
expect(res.body).toHaveProperty("endpoints");
});
it("should be", async () => {
expect(res.body).toHaveProperty("endpoints");
});
it("should be an array", () => {
expect(Array.isArray(res.body.endpoints)).toBeTrue();
})
})
it("should be an array", () => {
expect(Array.isArray(res.body.endpoints)).toBeTrue();
});
});
describe("GET /images works properly", async () => {
const res = await request(app).get("/images");
const res = await request(app).get("/images");
it("should be an array", () => {
expect(Array.isArray(res.body.images)).toBeTrue();
});
it("should be an array", () => {
expect(Array.isArray(res.body.images)).toBeTrue();
});
it("should return a 200", async () => {
expect(res.statusCode).toBe(200);
});
it("should return a 200", async () => {
expect(res.statusCode).toBe(200);
});
});
describe("POST /images works properly", () => {
it("should return 201 for new image", async () => {
const res = await request(app).post("/images").send({
url: "https://test.url.com/1",
it("should return 401 for unauthenticated requests", async () => {
const res = await request(app)
.post("/images")
.send({
url: "https://test.url.com/0",
status: "available",
tags: ["2girls", "touhou"]
});
expect(res.status).toSatisfy(status => [201].includes(status));
});
tags: ["2girls", "touhou"],
});
expect(res.status).toBe(401);
});
it("should return 409 for a repeated images", async () => {
await request(app).post("/images").send({
url: "https://test.url.com/2",
it("should return 403 for invalid tokens", async () => {
const res = await request(app)
.post("/images")
.set("authorization", `Bearer token`)
.send({
url: "https://test.url.com/0",
status: "available",
tags: ["2girls", "touhou"]
});
tags: ["2girls", "touhou"],
});
expect(res.status).toBe(403);
});
const res = await request(app).post("/images").send({
url: "https://test.url.com/2",
status: "available",
tags: ["2girls", "touhou"]
});
it("should return 201 for new image", async () => {
const res = await request(app)
.post("/images")
.set("authorization", `Bearer ${token}`)
.send({
url: "https://test.url.com/1",
status: "available",
tags: ["2girls", "touhou"],
});
expect(res.status).toBe(201);
});
expect(res.status).toBe(409);
});
it("should return 409 for a repeated images", async () => {
await request(app)
.post("/images")
.set("authorization", `Bearer ${token}`)
.send({
url: "https://test.url.com/2",
status: "available",
tags: ["2girls", "touhou"],
});
it("should return 500 for an error on the service", async () => {
mock.module("../src/services/ImageService", () => ({
default: {
add: () => { throw new Error("This is an expected testing error"); }
}
}));
const res = await request(app)
.post("/images")
.set("authorization", `Bearer ${token}`)
.send({
url: "https://test.url.com/2",
status: "available",
tags: ["2girls", "touhou"],
});
const res = await request(app).post("/images").send({
url: "https://test.url.com/3",
status: "available",
tags: ["2girls", "touhou"]
});
expect(res.status).toBe(500);
});
expect(res.status).toBe(409);
});
it("should return 400 for malformed requests", async () => {
mock.restore();
const res = await request(app).post("/images").send({
url: "https://test.url.com/4",
status: "wrong",
tags: ["2girls", "touhou"]
});
expect(res.status).toBe(400);
});
});
it("should return 500 for an error on the service", async () => {
mock.module("../src/services/ImageService", () => ({
default: {
add: () => {
throw new Error("This is an expected testing error");
},
},
}));
const res = await request(app)
.post("/images")
.set("authorization", `Bearer ${token}`)
.send({
url: "https://test.url.com/3",
status: "available",
tags: ["2girls", "touhou"],
});
expect(res.status).toBe(500);
});
it("should return 400 for malformed requests", async () => {
mock.restore();
const res = await request(app)
.post("/images")
.set("authorization", `Bearer ${token}`)
.send({
url: "https://test.url.com/4",
status: "wrong",
tags: ["2girls", "touhou"],
});
expect(res.status).toBe(400);
});
});

22
tests/auth.test.ts Normal file
View File

@ -0,0 +1,22 @@
import { describe, expect, it, mock } from "bun:test";
import request from "supertest";
import { app } from "../src";
describe("/login", async () => {
const correctRespose = await request(app).post("/login").send({
app: "tester",
secret: "test",
});
it("should return 200 for correct login", () => {
expect(correctRespose.status).toBe(200);
});
it("should contain a token", () => {
expect(correctRespose.body).toHaveProperty("token");
});
it("should return 403 for invalid credentials", async () => {
const res = await request(app).post("/login").send({});
expect(res.status).toBe(403);
});
});