17 Commits

Author SHA1 Message Date
44afcec30f chage docker commentaire for todo
Some checks failed
Build Docker Image Front / run (pull_request) Successful in 26s
Build Docker Image Back / run (pull_request) Successful in 1m8s
JsDocs / coverage (pull_request) Successful in 37s
Test and coverage / coverage (pull_request) Failing after 1m29s
2024-05-15 00:13:07 +02:00
c8266560eb add som test 2024-05-15 00:12:36 +02:00
4d3a4fb2f5 rework OTM 2024-05-15 00:12:27 +02:00
7be7a61828 add radius route WIP 2024-05-15 00:11:55 +02:00
820ec397ea add rewire packet 2024-05-15 00:11:24 +02:00
69315cc445 add drink id test in bruno 2024-05-15 00:10:09 +02:00
4e5123b331 fix: env var for API test
All checks were successful
Build Docker Image Front / run (pull_request) Successful in 22s
Build Docker Image Back / run (pull_request) Successful in 20s
JsDocs / coverage (pull_request) Successful in 21s
Test and coverage / coverage (pull_request) Successful in 1m2s
2024-05-13 23:23:51 +02:00
9a4c0dbd4d sync subrepo
Some checks failed
Build Docker Image Front / run (pull_request) Successful in 21s
Build Docker Image Back / run (pull_request) Successful in 21s
JsDocs / coverage (pull_request) Successful in 21s
Test and coverage / coverage (pull_request) Failing after 1m29s
2024-05-13 23:15:54 +02:00
bab32023fb implement city route for OTM
Some checks failed
Build Docker Image Front / run (pull_request) Successful in 24s
Build Docker Image Back / run (pull_request) Successful in 1m3s
JsDocs / coverage (pull_request) Successful in 37s
Test and coverage / coverage (pull_request) Failing after 1m28s
2024-05-13 23:13:12 +02:00
6efb268394 add axio package 2024-05-13 23:11:02 +02:00
e5d6987b10 add some test 2024-05-13 23:10:24 +02:00
5a0ceadcc6 add some bruno test 2024-05-13 23:10:01 +02:00
2cc1eac201 fix: test timeout 2024-05-13 23:09:02 +02:00
5671735e54 feat/ add prod swagger api test
All checks were successful
Build Docker Image Front / run (pull_request) Successful in 1m56s
Build Docker Image Back / run (pull_request) Successful in 1m8s
JsDocs / coverage (pull_request) Successful in 33s
Test and coverage / coverage (pull_request) Successful in 1m3s
2024-05-13 20:30:14 +02:00
4315560cbc tempory rm healthcheck
All checks were successful
Build Docker Image Front / run (pull_request) Successful in 23s
Build Docker Image Back / run (pull_request) Successful in 41s
JsDocs / coverage (pull_request) Successful in 31s
Test and coverage / coverage (pull_request) Successful in 55s
2024-05-07 09:48:35 +02:00
e106ae92db add open trip maps file 2024-05-06 21:50:22 +02:00
1bbc7a2aa3 feat: init-express-backend (#6)
All checks were successful
Build Docker Image Front / run (push) Successful in 23s
Build Docker Image Back / run (push) Successful in 23s
Reviewed-on: #6
Co-authored-by: Clement <c.boesmier@aptatio.com>
Co-committed-by: Clement <c.boesmier@aptatio.com>
2024-05-06 21:20:29 +02:00
25 changed files with 1941 additions and 74 deletions

View File

@ -6,9 +6,9 @@ on: #declancheur
- '*'
tags:
- v*
# pull_request:
# branches:
# - master
pull_request:
branches:
- master
jobs:
run: #jobs ID (nom du jobs)
@ -32,8 +32,6 @@ jobs:
type=semver,pattern={{major}}.{{minor}}
type=semver,pattern={{major}}
type=semver,pattern=latest
labels: |
org.opencontainers.image.title=AstroFront
- name: Login to Gitea
uses: docker/login-action@v3

View File

@ -32,8 +32,6 @@ jobs:
type=semver,pattern={{major}}.{{minor}}
type=semver,pattern={{major}}
type=semver,pattern=latest
labels: |
org.opencontainers.image.title=AstroFront
- name: Login to Gitea
uses: docker/login-action@v3
@ -48,8 +46,8 @@ jobs:
- name: Build and push back
uses: docker/build-push-action@v5
with:
context: ./front
context: ./Express/barAndCafe
push: true
file: ./front/Dockerfile
file: ./Express/barAndCafe/Dockerfile
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}

46
.github/workflows/build_jsdoc_drink.yml vendored Normal file
View File

@ -0,0 +1,46 @@
name: JsDocs
on:
pull_request:
branches:
- '*'
jobs:
coverage:
runs-on: ubuntu-latest
steps:
- name: Checkout # rapatrie le depot
uses: actions/checkout@v3
- name: Docker meta
id: meta
uses: docker/metadata-action@v5
with:
images: |
git.lab-ouest.org/Epitech/ratrapage_T-WEB_drink_jsdocs
tags: |
type=edge
type=ref,event=pr
type=ref,event=branch
type=semver,pattern={{version}}
type=semver,pattern={{major}}.{{minor}}
type=semver,pattern={{major}}
type=semver,pattern=latest
- name: Login to Gitea
uses: docker/login-action@v3
with:
registry: git.lab-ouest.org
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_TOKEN }}
# - name: Set up Docker Buildx
# uses: docker/setup-buildx-action@v3
- name: Build and push docs
uses: docker/build-push-action@v5
with:
context: ./Express/barAndCafe
push: true
file: ./Express/barAndCafe/Dockerfile_docs
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}

View File

@ -16,4 +16,6 @@ jobs:
prnumber: ${{ steps.findPr.outputs.number }}
custom-title: Coverage report for backend
github-token: ${{ secrets.PR_TOCKEN}}
annotations: none #disable annotation
annotations: none #disable annotation
env:
OPEN_TRIP_MAPS_KEY: ${{ secrets.OPEN_TRIP_MAPS_KEY}}

View File

@ -1,5 +1,3 @@
# This Dockerfile allows you to run AstroJS in server mode
#########
# Build #
#########
@ -49,7 +47,8 @@ WORKDIR /home/node
EXPOSE 3000
# Add Healthcheck
HEALTHCHECK --interval=10s --timeout=10s --start-period=5s --retries=3 CMD wget --no-verbose --tries=1 --spider http://localhost:3000 || exit 1
# FIXME: remttre check avec un port
# HEALTHCHECK --interval=10s --timeout=10s --start-period=5s --retries=3 CMD wget --no-verbose --tries=1 --spider http://localhost:3000 || exit 1
# copy from build image
COPY --chown=node:node --from=BUILD_IMAGE /home/node/node_modules ./node_modules

View File

@ -0,0 +1,35 @@
#########
# Build #
#########
FROM docker.io/node:20-alpine as BUILD_IMAGE
# External deps (for node-gyp add: "python3 make g++")
RUN apk add --no-cache git
# run as non root user
USER node
# go to user repository
WORKDIR /home/node
# Add package json
ADD --chown=node:node package.json package-lock.json ./
# install dependencies from package lock
RUN npm ci
# Add project files
ADD --chown=node:node . .
# build
RUN npm run docs
# remove dev deps
RUN npm prune --omit=dev
##############
# Production #
##############
FROM httpd:alpine
COPY --from=BUILD_IMAGE /home/node/out/ /usr/local/apache2/htdocs/

View File

@ -1,5 +1,6 @@
/** @type {import('ts-jest').JestConfigWithTsJest} */
module.exports = {
testTimeout: 10000,
preset: 'ts-jest',
testEnvironment: 'node',
collectCoverage: true,
@ -10,6 +11,7 @@ module.exports = {
'!/jest.config.js/',
'!/coverage/',
'!**/server.ts',
'!**/swaggerDef.ts'
],
coverageThreshold: {
global: {

View File

@ -3,7 +3,7 @@
"template": "node_modules/better-docs"
},
"tags": {
"allowUnknownTags": ["optional"]
"allowUnknownTags": true
},
"plugins": [
"node_modules/better-docs/typescript"

File diff suppressed because it is too large Load Diff

View File

@ -2,21 +2,27 @@
"main": "dist/server.js",
"scripts": {
"build": "rimraf dist && npx tsc",
"start": "node dist/index.js",
"start": "node dist/src/server.js",
"predev": "npm run build",
"dev": "npx tsc -w & nodemon dist/server.js",
"dev": "npx tsc -w & nodemon dist/src/server.js",
"predocs": "npm run build",
"docs": "jsdoc -c jsdoc.json",
"test": "jest"
"pretest": "npm run build",
"test": "ts-node -O '{\"module\":\"commonjs\"}' node_modules/jest/bin/jest.js"
},
"dependencies": {
"@types/express": "^4.17.21",
"@types/node": "^20.12.7",
"axios": "^1.6.8",
"dotenv": "^16.4.5",
"express": "^4.19.2",
"rimraf": "^5.0.5"
"rimraf": "^5.0.5",
"swagger-jsdoc": "^6.2.8",
"swagger-ui-express": "^5.0.0"
},
"devDependencies": {
"@types/jest": "^29.5.12",
"@types/rewire": "^2.5.30",
"@types/supertest": "^6.0.2",
"babel-cli": "^6.26.0",
"babel-preset-env": "^1.7.0",
@ -24,9 +30,11 @@
"jest": "^29.7.0",
"jsdoc": "^4.0.3",
"nodemon": "^3.1.0",
"rewire": "^7.0.0",
"superagent": "^9.0.2",
"supertest": "^7.0.0",
"ts-jest": "^29.1.2",
"ts-node": "^10.9.2",
"typedoc": "^0.25.13",
"typescript": "^5.4.5"
}

View File

@ -1,22 +1,61 @@
import express from "express";
import { getCity, getRadius } from "./openTripMaps"
import express from "express"
/**
* Initialize Express application instance.
* @returns An initialized Express application object.
*/
const app = express();
const app = express()
/**
* Handle GET request for homepage route ('/').
* Send back a simple text response.
* Handle GET request for homepage route ('/welcome').
* Send back a simple json response.
* @param {express.Request} req - HTTP Request object.
* @param {express.Response} res - HTTP Response object.
*/
function getRoot(req: express.Request, res: express.Response) {
res.send("hello world from dev");
function getWelcome(req: express.Request, res: express.Response) {
const out = {hello:"world"}
res.send(out)
}
app.get("/", getRoot);
/**
* @openapi
* /welcome:
* get:
* summary: retun just hello
* description: Welcome to swagger-jsdoc!
* responses:
* 200:
* description: Returns a welcome json.
*/
app.get("/welcome", getWelcome)
export default app;
/**
* @openapi
* /otm/city:
* get:
* summary: return the drinks in a city
* description: return the drinks in a defined perimeter in a city
* parameters:
* - name: name
* in: query
* required: true
* description: the name of the city
* schema:
* type: string
* responses:
* 200:
* description: Return a list of bars and coffee in city in geoJSON format
* 400:
* description: Missing Argument Error
* 401:
* description: Missing OTM tocken
*/
app.get("/otm/city", getCity)
//XXX: faire la doc SWAGGER
app.get("/otm/radius", getRadius)
export default app

View File

@ -0,0 +1,93 @@
import axios from 'axios';
import express from "express"
import * as dotenv from "dotenv";
dotenv.config({path: '../../.env'})
const key = process.env.OPEN_TRIP_MAPS_KEY
async function callRadius(lon: string, lat: string, radius = '1000') {
const optionsDrink = {
method: 'GET',
url: 'https://api.opentripmap.com/0.1/en/places/radius',
params: {
radius: radius,
lon: lon,
lat: lat,
apikey: key,
kinds: 'bars,cafes,pubs,biergartens'
},
headers: {'Content-Type': 'application/json'}
}
try {
const { data } = await axios.request(optionsDrink);
return data
} catch (error) {
console.error(error);
}
}
async function callCity(name:string) {
const optionsCity = {
method: 'GET',
url: 'https://api.opentripmap.com/0.1/en/places/geoname',
params: {
name: name,
apikey: key
},
headers: {'Content-Type': 'application/json'}
};
try {
const { data } = await axios.request(optionsCity);
return data
} catch (error) {
console.error(error);
}
}
/**
* Handle GET request for city search route ('/otm/city').
* @param {express.Request} req - HTTP Request object.
* @param {express.Response} res - HTTP Response object.
*/
export async function getCity(req: express.Request, res: express.Response) {
const cityName = req.query["name"]
let radius = req.query["radius"]
if(!cityName){
res.status(400).send("Missing Argument name")
return
}
if(!radius){
radius = "1000"
}
const cityPose = await callCity(cityName as string)
res.send( await callRadius(cityPose.lon,cityPose.lat, radius as string))
}
/**
* Handle GET request for city search route ('/otm/radius').
* @param {express.Request} req - HTTP Request object.
* @param {express.Response} res - HTTP Response object.
*/
export async function getRadius(req:express.Request, res: express.Response) {
const lon = req.query["lon"] as string
const lat = req.query["lat"] as string
let radius = req.query["radius"]
if(!lon || !lat){
res.status(400).send("Missing Argument name")
return
}
if(!radius){
radius = "1000"
}
res.send(callRadius(lon,lat,radius as string))
}
//TODO: fair une route ou l'on donne l'id un établicement pour avoir des détailles
//TODO: fair une route ou l'on donne 2 coordonée

View File

@ -1,10 +1,16 @@
import * as dotenv from "dotenv";
import app from "./app";
import options from "./swaggerDef";
const swaggerJsdoc = require("swagger-jsdoc"),
swaggerUi = require("swagger-ui-express");
dotenv.config({path: '../../.env'})
const port = parseInt(process.env.BAR_PORT || '3000')
const specs = swaggerJsdoc(options)
app.use("/api-docs", swaggerUi.serve, swaggerUi.setup(specs))
app.listen(port, () =>{
console.log(`serveur running in ${port}`)
})

View File

@ -0,0 +1,29 @@
import * as dotenv from "dotenv";
dotenv.config({path: '../../.env'})
const port = parseInt(process.env.BAR_PORT || '3000')
const options = {
definition: {
openapi: "3.1.0",
info: {
title: "LogRocket Express API with Swagger",
version: "0.1.0",
description:
"This is a simple CRUD API application made with Express and documented with Swagger",
},
servers: [
{
url: "http://localhost:"+port.toString(),
},
{
url: "https://drink-tweb.cb85.fr"
}
],
},
apis: ['./src/*.ts'],
explorer: true
}
export default options

View File

@ -1,37 +1,30 @@
import request from "supertest";
import app from "../src/app";
import { Server, IncomingMessage, ServerResponse } from "http";
import * as dotenv from "dotenv";
const port = 3000;
dotenv.config({path: '../../.env'})
const port = parseInt(process.env.BAR_PORT || '3000')
let serveur : Server<typeof IncomingMessage, typeof ServerResponse>
describe("Test the root path", () => {
describe("Test the welcome path", () => {
beforeEach(() => {
serveur = app.listen(port, () =>{
console.log(`serveur running in ${port}`)
})
})
afterEach((done) => {
serveur.close(done)
})
test("It should response the GET method", done => {
test("It should response the 200 code for GET method", done => {
request(app)
.get("/")
.get("/welcome")
.then(response => {
expect(response.statusCode).toBe(200);
done();
});
});
test("It should response the GET method", done => {
test("It should response the GET method with content", done => {
const out = {hello:"world"};
request(app)
.get("/")
.get("/welcome")
.then(response => {
expect(response.text).toEqual("hello world from dev")
expect(response.text).toEqual(JSON.stringify(out))
done();
});
});

View File

@ -0,0 +1,154 @@
import request from "supertest";
import app from "../src/app";
import { Server, IncomingMessage, ServerResponse } from "http";
import * as dotenv from "dotenv";
import rewire from 'rewire';
dotenv.config({path: '../../.env'})
const port = parseInt(process.env.BAR_PORT || '3000')
let serveur : Server<typeof IncomingMessage, typeof ServerResponse>
describe("Test the otm city path", () => {
const opentripmapModule = rewire("../src/openTripMaps")
const callCity = opentripmapModule.__get__("callCity")
const callRadius = opentripmapModule.__get__("callRadius")
test("Get city from OTM", async () => {
const res = {
"name": "Paris",
"country": "FR",
"lat": 48.85341,
"lon": 2.3488,
"population": 2138551,
"timezone": "Europe/Paris",
"status": "OK"
}
expect(await callCity("Paris")).toEqual(res)
})
test("Get bar in radius from OTM", async () => {
const res = {
"type": "FeatureCollection",
"features": [{
"type": "Feature",
"id": "562635",
"geometry": {
"type": "Point",
"coordinates": [
-1.4344594,
46.6686478
]
},
"properties": {
"xid": "N4032296324",
"name": "Le 27 point carré",
"dist": 0.17652159,
"rate": 1,
"osm": "node/4032296324",
"kinds": "foods,bars,tourist_facilities"
}
}]
}
expect(await callRadius("-1.4344594", "46.6686478", "10")).toEqual(res)
})
test("It should response the 200 code for GET method", done => {
request(app)
.get("/otm/city")
.query({'name':'La roche sur yon'})
.then(response => {
expect(response.statusCode).toBe(200);
done();
});
});
test("It should response the GET method with content", done => {
const out = {
"type": "FeatureCollection",
"features": [{
"type": "Feature",
"id": "562635",
"geometry": {
"type": "Point",
"coordinates": [
-1.4344594,
46.6686478
]
},
"properties": {
"xid": "N4032296324",
"name": "Le 27 point carré",
"dist": 236.40360026,
"rate": 1,
"osm": "node/4032296324",
"kinds": "foods,bars,tourist_facilities"
}
}]
}
request(app)
.get("/otm/city")
.query({'name':'La roche sur yon', "radius": 240})
.then(response => {
console.log(response.text)
expect(response.text).toEqual(JSON.stringify(out))
done();
});
});
test("It should response the 400 code for GET method", done => {
request(app)
.get("/otm/city")
.then(response => {
console.log(response.text)
expect(response.statusCode).toBe(400);
done();
});
});
test("It should response the 200 code for GET method", done => {
request(app)
.get("/otm/radius")
.query({'lon':'-1.4344594', 'lat' : '46.6686478', 'radius': '10'})
.then(response => {
expect(response.statusCode).toBe(200);
done();
});
});
//TODO faire les test pour les cas d'erreur
test("Get bar in radius from API", done => {
const res = {
"type": "FeatureCollection",
"features": [{
"type": "Feature",
"id": "562635",
"geometry": {
"type": "Point",
"coordinates": [
-1.4344594,
46.6686478
]
},
"properties": {
"xid": "N4032296324",
"name": "Le 27 point carré",
"dist": 0.17652159,
"rate": 1,
"osm": "node/4032296324",
"kinds": "foods,bars,tourist_facilities"
}
}]
}
request(app)
.get("/otm/radius")
.query({'lon':'-1.4344594', 'lat' : '46.6686478', 'radius': '10'})
.then(response => {
expect(response.text).toEqual(JSON.stringify(res));
done();
});
})
});

View File

@ -1,3 +1,7 @@
vars {
TRIPMAP_URL: https://api.opentripmap.com/0.1
}
vars:secret [
app_key
app_key,
OTM_KEY
]

View File

@ -1,7 +1,7 @@
meta {
name: express test
name: express Drink OTM
type: http
seq: 3
seq: 4
}
get {

View File

@ -0,0 +1,19 @@
meta {
name: otm_drink
type: http
seq: 6
}
get {
url: {{TRIPMAP_URL}}/en/places/radius?radius=1000&lon=-1.43333&lat=46.66667&apikey={{OTM_KEY}}&kinds=bars,cafes,pubs,biergartens
body: none
auth: none
}
query {
radius: 1000
lon: -1.43333
lat: 46.66667
apikey: {{OTM_KEY}}
kinds: bars,cafes,pubs,biergartens
}

View File

@ -0,0 +1,15 @@
meta {
name: otm_drink_id
type: http
seq: 7
}
get {
url: https://api.opentripmap.com/0.1/en/places/xid/562635?apikey={{OTM_KEY}}
body: none
auth: none
}
query {
apikey: {{OTM_KEY}}
}

View File

@ -0,0 +1,16 @@
meta {
name: otm_ex_city
type: http
seq: 8
}
get {
url: http://localhost:3001/otm/city?name=La roche sur yon&radius=300
body: none
auth: none
}
query {
name: La roche sur yon
radius: 300
}

View File

@ -0,0 +1,16 @@
meta {
name: otm_location
type: http
seq: 5
}
get {
url: {{TRIPMAP_URL}}/en/places/geoname?name=Paris&apikey={{OTM_KEY}}
body: none
auth: none
}
query {
name: Paris
apikey: {{OTM_KEY}}
}

View File

@ -0,0 +1,22 @@
meta {
name: test graphQL
type: graphql
seq: 3
}
post {
url: https://datatour-tweb.cb85.fr
body: graphql
auth: none
}
body:graphql {
{
poi {
total
results {
_uri
}
}
}
}

View File

@ -1,12 +1,14 @@
version: "3.8"
services:
pocketbase:
image: ghcr.io/coollabsio/pocketbase:latest
environment:
- SERVICE_FQDN_POCKETBASE_8080
volumes:
- ./.pb/pocketbase-data:/app/pb_data
- ./.pb/pocketbase-hooks:/app/pb_hooks
- ./pb/pocketbase-data:/app/pb_data
- ./pb/pocketbase-hooks:/app/pb_hooks
labels:
- traefik.enable=true
- traefik.http.routers.poketBaseTweb.rule=Host(`${POCKET_BASE_URL}`)
@ -14,9 +16,10 @@ services:
- traefik.http.routers.poketBaseTweb.tls.certresolver=le
networks:
- public
front:
image: git.lab-ouest.org/epitech/ratrapage_t-web_front:pr-7-head
depends_on:
image: git.lab-ouest.org/epitech/ratrapage_t-web_front:pr-1-head
depends_on:
- pocketbase
labels:
- traefik.enable=true
@ -25,10 +28,66 @@ services:
- traefik.http.routers.astroTweb.tls.certresolver=le
networks:
- public
back_drink:
image: git.lab-ouest.org/epitech/ratrapage_t-web_back:pr-6-head
labels:
- traefik.enable=true
- traefik.http.routers.expressDrinkTweb.rule=Host(`${DRINK_URL}`)
- traefik.http.services.expressDrinkTweb.loadbalancer.server.port=${BACK_BASE_PORT}
- traefik.http.routers.expressDrinkTweb.tls.certresolver=le
networks:
- public
docs_drink:
image: git.lab-ouest.org/epitech/ratrapage_t-web_drink_jsdocs:pr-6-head
labels:
- traefik.enable=true
- traefik.http.routers.docsDrinkTweb.rule=Host(`${DOCS_DRINK_URL}`)
- traefik.http.services.docsDrinkTweb.loadbalancer.server.port=${DOCS_BACK_BASE_PORT}
- traefik.http.routers.docsDrinkTweb.tls.certresolver=le
networks:
- public
blazegraph:
image: conjecto/blazegraph:2.1.5
# ports:
# - 9999:9999
environment:
JAVA_OPTS: -Xms6G -Xmx6G
volumes:
- ./datatourisme/dataset:/docker-entrypoint-initdb.d
ulimits:
nofile:
soft: 65536
hard: 65536
networks:
- graphQL
restart: unless-stopped
datatourisme:
image: git.lab-ouest.org/epitech/fork-open-data-tourism:master
depends_on:
- blazegraph
networks:
- graphQL
- public
restart: unless-stopped
labels:
- traefik.enable=true
- traefik.http.routers.dataTourisme.rule=Host(`${DATA_TOURISME_URL}`)
- traefik.http.services.dataTourisme.loadbalancer.server.port=${DATA_TOURISME_BASE_PORT}
- traefik.http.routers.dataTourisme.tls.certresolver=le
networks:
graphQL: {}
public:
external: true
x-dockge:
urls:
- https://${POCKET_BASE_URL}/
- https://${FRONT_URL}/
- https://${DOCS_DRINK_URL}/
- https://${DRINK_URL}/
- https://${DATA_TOURISME_URL}/