Skip to content

Commit

Permalink
Add 410 status codes for v2 endpoints
Browse files Browse the repository at this point in the history
  • Loading branch information
@gadhagod
gadhagod committed Sep 30, 2024
1 parent 6aab1cb commit 58e678d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 283 deletions.
4 changes: 3 additions & 1 deletion server.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,6 @@ def redirectToDocs(): return flask.redirect('https://gadhagod.github.io/Hyrule-C
if __name__ == '__main__': # dev server
app.run(debug=True)
else: # prod server
pass
# precondition: "v2-src" branch cloned into "v2" dir
from v2.server import v2_blueprint
app.register_blueprint(v2_blueprint)
292 changes: 10 additions & 282 deletions tests/test/v2.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,316 +39,44 @@ describe("v2", () => {

describe("Server HTTP codes", () => {
describe("`/entry/<>` endpoint", () => {
it("should have 200 code", (done) => {
it("should have 410 code", (done) => {
makeReq("/entry/1", (_err, res) => {
assert.equal(res.statusCode, 200, `Entry 1 responded with code ${res.statusCode}`)
assert.equal(res.statusCode, 410, `Entry 1 responded with code ${res.statusCode}`)
done()
})
});
});
describe("`/master_mode/entry/<>` endpoint", () => {
it("should have 200 code", (done) => {
it("should have 410 code", (done) => {
makeReq("/master_mode/entry/97", (_err, res) => {
assert.equal(res.statusCode, 200, `DLC Entry 97 responded with code ${res.statusCode}`)
assert.equal(res.statusCode, 410, `DLC Entry 97 responded with code ${res.statusCode}`)
done()
})
});
});
describe("`/category/<>` endpoint", () => {
it("should have 200 code", (done) => {
it("should have 410 code", (done) => {
makeReq("/category/monsters", (_err, res) => {
assert.equal(res.statusCode, 200, `Responded with code ${res.statusCode}`)
assert.equal(res.statusCode, 410, `Responded with code ${res.statusCode}`)
done()
})
});
});
describe("`/master_mode` endpoint", () => {
it("should have 200 code", (done) => {
it("should have 410 code", (done) => {
makeReq("/master_mode", (_err, res) => {
assert.equal(res.statusCode, 200, `DLC Entry 97 responded with code ${res.statusCode}`)
assert.equal(res.statusCode, 410, `DLC Entry 97 responded with code ${res.statusCode}`)
done()
})
});
});
describe("`/` endpoint", () => {
it("should have 200 code", (done) => {
it("should have 410 code", (done) => {
makeReq("", (_err, res) => {
assert.equal(res.statusCode, 200, `Responded with code ${res.statusCode}`)
assert.equal(res.statusCode, 410, `Responded with code ${res.statusCode}`)
done()
})
});
});
});

describe("API response contents", () => {
describe("Entries", () => {
describe("Creature entry", () => {
let entry = "thunderwing butterfly"
it("should have expected fields", (done) => {
makeReq(`/entry/${entry}`, (_err, res) => {
assert.deepEqual(
Object.keys(
JSON.parse(res.body).data
),
["category", "common_locations", "cooking_effect", "description", "hearts_recovered", "id", "image", "name"],
`Responded with incorrect fields.`
)
done()
})
});
it("should have working image", (done) => {
makeReq(`/entry/${entry}/image`, () => {
const buffer = readChunk.sync(`out/${entry}.png`, 0, 26);
assert.equal(imageType(buffer).mime, "image/png");
done()
}, { filename: `out/${entry}.png` })
});
});
describe("Equipment entry", () => {
let entry = "golden claymore"
it("should have expected fields", (done) => {
makeReq(`/entry/${entry}`, (_err, res) => {
assert.deepEqual(
Object.keys(
JSON.parse(res.body).data
),
["attack", "category", "common_locations", "defense", "description", "id", "image", "name"],
`Responded with incorrect fields.`
)
done()
})
});
it("should have working image", (done) => {
makeReq(`/entry/${entry}/image`, () => {
const buffer = readChunk.sync(`out/${entry}.png`, 0, 26);
assert.equal(imageType(buffer).mime, "image/png")
done()
}, { filename: `out/${entry}.png` })
});
});
describe("Material entry", () => {
let entry = "palm fruit"
it("should have expected fields", (done) => {
makeReq(`/entry/${entry}`, (_err, res) => {
assert.deepEqual(
Object.keys(
JSON.parse(res.body).data
),
["category", "common_locations", "cooking_effect", "description", "hearts_recovered", "id", "image", "name"],
`Responded with incorrect fields.`
)
done()
})
});
it("should have working image", (done) => {
makeReq(`/entry/${entry}/image`, () => {
const buffer = readChunk.sync(`out/${entry}.png`, 0, 12);
assert.equal(imageType(buffer).mime, "image/png");
done()
}, { filename: `out/${entry}.png` })
});
});
describe("Monster entry", () => {
let entry = "molduga"
it("should have expected fields", (done) => {
makeReq(`/entry/${entry}`, (_err, res) => {
assert.deepEqual(
Object.keys(
JSON.parse(res.body).data
),
["category", "common_locations", "description", "drops", "id", "image", "name"],
`Responded with incorrect fields.`
)
done()
})
});
it("should have working image", (done) => {
makeReq(`/entry/${entry}/image`, () => {
const buffer = readChunk.sync(`out/${entry}.png`, 0, 12);
assert.equal(imageType(buffer).mime, "image/png");
done()
}, { filename: `out/${entry}.png` })
});
});
describe("Treasure entry", () => {
let entry = "molduga"
it("should have expected fields", (done) => {
makeReq(`/entry/${entry}`, (_err, res) => {
assert.deepEqual(
Object.keys(
JSON.parse(res.body).data
),
["category", "common_locations", "description", "drops", "id", "image", "name"],
`Responded with incorrect fields.`
)
done()
})
});
it("should have working image", (done) => {
makeReq(`/entry/${entry}/image`, () => {
const buffer = readChunk.sync(`out/${entry}.png`, 0, 12);
assert.equal(imageType(buffer).mime, "image/png");
done()
}, { filename: `out/${entry}.png` })
});
});
describe("Master Mode entry", () => {
let entry = "golden lynel"
it("should have expected fields", (done) => {
makeReq(`/master_mode/entry/${entry}`, (_err, res) => {
assert.deepEqual(
Object.keys(
JSON.parse(res.body).data
),
["category", "common_locations", "description", "drops", "id", "image", "name"],
`Responded with incorrect fields.`
)
done()
})
});
it("should have working image", (done) => {
makeReq(`/master_mode/entry/${entry}/image`, () => {
const buffer = readChunk.sync(`out/${entry}.png`, 0, 12);
assert.equal(imageType(buffer).mime, "image/png");
done()
}, { filename: `out/${entry}.png` })
});
});

describe("Categories", () => {
describe("Creature category", () => {
it("should have correct of # sub-categories", (done) => {
makeReq("/category/creatures", (_err, res) => {
assert.equal(
Object.keys(JSON.parse(res.body).data).length,
2
)
done()
})
});
it("should have correct of # entries", (done) => {
makeReq("/category/creatures", (_err, res) => {
assert.equal(
Object.keys(JSON.parse(res.body).data.non_food).length + Object.keys(JSON.parse(res.body).data.food).length,
83
)
done()
})
});
it("entries should be of category", (done) => {
makeReq("/category/creatures", (_err, res) => {
try {
var entries = Object.assign(JSON.parse(res.body).data.food, JSON.parse(res.body).data.non_food)
} catch (err) {
if (err.name == "SyntaxError") {
assert.fail("Subcategories non-existant")
} else {
throw err
}
}
entries.forEach((e: Entry) => assert.equal(e.category, "creatures"))
done()
})
});
});
describe("Equipment category", () => {
it("should have correct of # entries", (done) => {
makeReq("/category/equipment", (_err, res) => {
var entries = JSON.parse(res.body).data
assert.equal(
Object.keys(entries).length,
185
)
done()
})
});
it("entries should be of category", (done) => {
makeReq("/category/equipment", (_err, res) => {
var entries = JSON.parse(res.body).data
entries.forEach((e: Entry) => assert.equal(e.category, "equipment"))
done()
})
});
});
describe("Materials category", () => {
it("should have correct of # entries", (done) => {
makeReq("/category/materials", (_err, res) => {
var entries = JSON.parse(res.body).data
assert.equal(
Object.keys(entries).length,
36
)
done()
})
});
it("entries should be of category", (done) => {
makeReq("/category/materials", (_err, res) => {
var entries = JSON.parse(res.body).data
entries.forEach((e: Entry) => assert.equal(e.category, "materials"))
done()
})
});
});
describe("Monsters category", () => {
it("should have correct of # entries", (done) => {
makeReq("/category/monsters", (_err, res) => {
var entries = JSON.parse(res.body).data
assert.equal(
Object.keys(entries).length,
81
)
done()
})
});
it("entries should be of category", (done) => {
makeReq("/category/monsters", (_err, res) => {
var entries = JSON.parse(res.body).data
entries.forEach((e: Entry) => assert.equal(e.category, "monsters"))
done()
})
});
});
describe("Treasure category", () => {
it("should have correct of # entries", (done) => {
makeReq("/category/treasure", (_err, res) => {
var entries = JSON.parse(res.body).data
assert.equal(
Object.keys(entries).length,
4
)
done()
})
});
it("entries should be of category", (done) => {
makeReq("/category/treasure", (_err, res) => {
var entries = JSON.parse(res.body).data
entries.forEach((e: Entry) => assert.equal(e.category, "treasure"))
done()
})
});
});
});
describe("All data", () => {
it("should have correct of # entries", (done) => {
makeReq("", (_err, res) => {
let data = JSON.parse(res.body).data
assert.equal(
data.creatures.food.length + data.creatures.non_food.length + data.equipment.length + data.materials.length + data.monsters.length + data.treasure.length,
389
)
done()
})
});
it("should have correct of # categories", (done) => {
makeReq("", (_err, res) => {
assert.equal(
Object.keys(JSON.parse(res.body).data).length,
5
)
done()
})
});
});
});
});
});

0 comments on commit 58e678d

Please sign in to comment.