Merge pull request #244 from Arquisoft/develop

Merge backend changes and deploy with https
Arquisoft · Apr 17, 2024 · 42a564f · 42a564f
2 parents 4e0d6ed + 8e56bf9
commit 42a564f
Show file tree

Hide file tree

Showing 57 changed files with 1,637 additions and 465 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,135 +1,151 @@
-name: Deploy on release
-
-on:
-  release:
-    types: [published]
-jobs:
-  unit-tests:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-      - uses: actions/checkout@v4
-      - run: npm --prefix webapp ci
-      - run: npm --prefix webapp test -- --coverage
-      - uses: actions/setup-java@v4
-        with:
-          distribution: 'temurin'
-          java-version: '17'
-      - run: mvn clean verify
-        working-directory: api
-        env:
-          DATABASE_USER: ${{ secrets.DATABASE_USER }}
-          DATABASE_PASSWORD: ${{ secrets.DATABASE_PASSWORD }}
-          JWT_SECRET: ${{ secrets.JWT_SECRET }}
-      - name: Analyze with SonarCloud
-        uses: sonarsource/sonarcloud-github-action@master
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-  e2e-tests:
-    needs: [ unit-tests ]
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-      - run: npm --prefix webapp install
-      - run: npm --prefix webapp run build
-      # - run: npm --prefix webapp run test:e2e
-  docker-push-api:
-    runs-on: ubuntu-latest
-    needs: [ e2e-tests ]
-    steps:
-      - uses: actions/checkout@v4
-      - name: Publish to Registry
-        uses: elgohr/Publish-Docker-Github-Action@v5
-        env:
-          DATABASE_USER: ${{ secrets.DATABASE_USER }}
-          DATABASE_PASSWORD: ${{ secrets.DATABASE_PASSWORD }}
-          JWT_SECRET: ${{ secrets.JWT_SECRET }}
-        with:
-          name: arquisoft/wiq_en2b/api
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-          registry: ghcr.io
-          workdir: api
-          buildargs: |
-            DATABASE_USER
-            DATABASE_PASSWORD
-            JWT_SECRET
-  docker-push-webapp:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
-    needs: [ e2e-tests ]
-    steps:
-
-      - uses: actions/checkout@v4
-
-      - name: Create .env file
-        run: echo "REACT_APP_API_ENDPOINT=http://${{ secrets.DEPLOY_HOST }}:8080" > webapp/.env
-
-      - name: Publish to Registry
-        uses: elgohr/Publish-Docker-Github-Action@v5
-        env:
-          REACT_APP_API_ENDPOINT: http://${{ secrets.DEPLOY_HOST }}:8080
-          teamname: wiq_en2b
-        with:
-          name: arquisoft/wiq_en2b/webapp
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-          registry: ghcr.io
-          workdir: webapp
-          buildargs: |
-            REACT_APP_API_ENDPOINT
-  docker-push-question-generator:
-    runs-on: ubuntu-latest
-    needs: [ e2e-tests ]
-    steps:
-      - uses: actions/checkout@v4
-      - name: Publish to Registry
-        uses: elgohr/Publish-Docker-Github-Action@v5
-        env:
-          DATABASE_USER: ${{ secrets.DATABASE_USER }}
-          DATABASE_PASSWORD: ${{ secrets.DATABASE_PASSWORD }}
-        with:
-          name: arquisoft/wiq_en2b/question-generator
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-          registry: ghcr.io
-          workdir: questiongenerator
-          buildargs: |
-            DATABASE_USER
-            DATABASE_PASSWORD
-  deploy:
-    name: Deploy over SSH
-    runs-on: ubuntu-latest
-    needs: [docker-push-api, docker-push-webapp, docker-push-question-generator]
-    steps:
-    - name: Deploy over SSH
-      uses: fifsky/ssh-action@master
-      env:
-        API_URI: ${{ secrets.DEPLOY_HOST }}
-        DATABASE_USER: ${{ secrets.DATABASE_USER }}
-        DATABASE_PASSWORD: ${{ secrets.DATABASE_PASSWORD }}
-        JWT_SECRET: ${{ secrets.JWT_SECRET }}
-      with:
-        host: ${{ secrets.DEPLOY_HOST }}
-        user: ${{ secrets.DEPLOY_USER }}
-        key: ${{ secrets.DEPLOY_KEY }}
-        command: |
-          wget https://raw.githubusercontent.com/arquisoft/wiq_en2b/master/docker-compose.yml -O docker-compose.yml
-          wget https://raw.githubusercontent.com/arquisoft/wiq_en2b/master/.env -O .env
-          echo "DATABASE_USER=${{ secrets.DATABASE_USER }}" >> .env
-          echo "DATABASE_PASSWORD=${{ secrets.DATABASE_PASSWORD }}" >> .env
-          echo "JWT_SECRET=${{ secrets.JWT_SECRET }}" >> .env
-          echo "API_URI=http://${{ secrets.DEPLOY_HOST }}:8080" >> .env
-          docker compose --profile prod down
-          docker compose --profile prod up -d --pull always
+name: Deploy on release
+
+on:
+  release:
+    types: [published]
+jobs:
+  unit-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - uses: actions/checkout@v4
+      - run: npm --prefix webapp ci
+      - run: npm --prefix webapp test -- --coverage
+      - uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+      - run: mvn clean verify
+        working-directory: api
+        env:
+          DATABASE_USER: ${{ secrets.DATABASE_USER }}
+          DATABASE_PASSWORD: ${{ secrets.DATABASE_PASSWORD }}
+          JWT_SECRET: ${{ secrets.JWT_SECRET }}
+      - name: Analyze with SonarCloud
+        uses: sonarsource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+  e2e-tests:
+    needs: [ unit-tests ]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: npm --prefix webapp install
+      - run: npm --prefix webapp run build
+      # - run: npm --prefix webapp run test:e2e
+  docker-push-api:
+    runs-on: ubuntu-latest
+    needs: [ e2e-tests ]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Publish to Registry
+        uses: elgohr/Publish-Docker-Github-Action@v5
+        env:
+          DATABASE_USER: ${{ secrets.DATABASE_USER }}
+          DATABASE_PASSWORD: ${{ secrets.DATABASE_PASSWORD }}
+          JWT_SECRET: ${{ secrets.JWT_SECRET }}
+          SSL_PASSWORD: ${{ secrets.SSL_PASSWORD }}
+        with:
+          name: arquisoft/wiq_en2b/api
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+          registry: ghcr.io
+          workdir: api
+          buildargs: |
+            DATABASE_USER
+            DATABASE_PASSWORD
+            JWT_SECRET
+            SSL_PASSWORD
+  docker-push-kiwiq:
+    runs-on: ubuntu-latest
+    needs: [ e2e-tests ]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Publish to Registry
+        uses: elgohr/Publish-Docker-Github-Action@v5
+        with:
+          name: arquisoft/wiq_en2b/kiwiq
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+          registry: ghcr.io
+          workdir: nginx_conf
+  docker-push-webapp:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    needs: [ e2e-tests ]
+    steps:
+
+      - uses: actions/checkout@v4
+
+      - name: Create .env file
+        run: echo "REACT_APP_API_ENDPOINT=https://${{ secrets.DEPLOY_HOST }}:8443" > webapp/.env
+
+      - name: Publish to Registry
+        uses: elgohr/Publish-Docker-Github-Action@v5
+        env:
+          REACT_APP_API_ENDPOINT: https://${{ secrets.DEPLOY_HOST }}:8443
+          teamname: wiq_en2b
+        with:
+          name: arquisoft/wiq_en2b/webapp
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+          registry: ghcr.io
+          workdir: webapp
+          buildargs: |
+            REACT_APP_API_ENDPOINT
+  docker-push-question-generator:
+    runs-on: ubuntu-latest
+    needs: [ e2e-tests ]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Publish to Registry
+        uses: elgohr/Publish-Docker-Github-Action@v5
+        env:
+          DATABASE_USER: ${{ secrets.DATABASE_USER }}
+          DATABASE_PASSWORD: ${{ secrets.DATABASE_PASSWORD }}
+        with:
+          name: arquisoft/wiq_en2b/question-generator
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+          registry: ghcr.io
+          workdir: questiongenerator
+          buildargs: |
+            DATABASE_USER
+            DATABASE_PASSWORD
+  deploy:
+    name: Deploy over SSH
+    runs-on: ubuntu-latest
+    needs: [docker-push-api, docker-push-webapp, docker-push-question-generator, docker-push-kiwiq]
+    steps:
+    - name: Deploy over SSH
+      uses: fifsky/ssh-action@master
+      env:
+        API_URI: ${{ secrets.DEPLOY_HOST }}
+        DATABASE_USER: ${{ secrets.DATABASE_USER }}
+        DATABASE_PASSWORD: ${{ secrets.DATABASE_PASSWORD }}
+        JWT_SECRET: ${{ secrets.JWT_SECRET }}
+      with:
+        host: ${{ secrets.DEPLOY_HOST }}
+        user: ${{ secrets.DEPLOY_USER }}
+        key: ${{ secrets.DEPLOY_KEY }}
+        command: |
+          wget https://raw.githubusercontent.com/arquisoft/wiq_en2b/master/docker-compose.yml -O docker-compose.yml
+          wget https://raw.githubusercontent.com/arquisoft/wiq_en2b/master/.env -O .env
+          echo "DATABASE_USER=${{ secrets.DATABASE_USER }}" >> .env
+          echo "DATABASE_PASSWORD=${{ secrets.DATABASE_PASSWORD }}" >> .env
+          echo "JWT_SECRET=${{ secrets.JWT_SECRET }}" >> .env
+          echo "API_URI=https://${{ secrets.DEPLOY_HOST }}:8443" >> .env
+          echo "SSL_PASSWORD=${{ secrets.SSL_PASSWORD }}" >> .env
+          docker compose --profile prod down
+          docker compose --profile prod up -d --pull always
diff --git a/.gitignore b/.gitignore
@@ -9,3 +9,8 @@ docs/build
 .idea
 .vscode
 .DS_Store
+
+*.crt
+*.key
+*.pem
+.env
diff --git a/api/src/main/java/lab/en2b/quizapi/commons/user/UserController.java b/api/src/main/java/lab/en2b/quizapi/commons/user/UserController.java
@@ -0,0 +1,31 @@
+package lab.en2b.quizapi.commons.user;
+
+import lab.en2b.quizapi.commons.user.dtos.UserResponseDto;
+import lombok.RequiredArgsConstructor;
+import org.springframework.http.ResponseEntity;
+import org.springframework.security.core.Authentication;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/users")
+@RequiredArgsConstructor
+public class UserController {
+
+    private final UserService userService;
+
+    /**
+     * Gets the user details for the given authentication
+     * Returns 200 if the user details are successfully retrieved
+     * Returns 403 if the user is not logged in
+     * @param authentication the authentication object
+     * @return the response dto for the user details
+     */
+    @GetMapping("/details")
+    public ResponseEntity<UserResponseDto> getUserDetails(Authentication authentication) {
+        return ResponseEntity.ok(userService.getUserDetailsByAuthentication(authentication));
+    }
+
+}
diff --git a/api/src/main/java/lab/en2b/quizapi/commons/user/UserService.java b/api/src/main/java/lab/en2b/quizapi/commons/user/UserService.java
@@ -3,6 +3,8 @@
 import lab.en2b.quizapi.auth.config.UserDetailsImpl;
 import lab.en2b.quizapi.auth.dtos.RegisterDto;
 import lab.en2b.quizapi.commons.exceptions.InvalidAuthenticationException;
+import lab.en2b.quizapi.commons.user.dtos.UserResponseDto;
+import lab.en2b.quizapi.commons.user.mappers.UserResponseDtoMapper;
 import lombok.RequiredArgsConstructor;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.security.core.Authentication;
@@ -22,6 +24,7 @@ public class UserService implements UserDetailsService {
     private final UserRepository userRepository;
     @Value("${REFRESH_TOKEN_DURATION_MS}")
     private long refreshTokenDurationMs;
+    private final UserResponseDtoMapper userResponseDtoMapper;
     @Override
     public UserDetails loadUserByUsername(String email) throws UsernameNotFoundException {
         return UserDetailsImpl.build(userRepository.findByEmail(email).orElseThrow(() -> new InvalidAuthenticationException("Invalid email or password provided!")));
@@ -64,4 +67,8 @@ public User getUserByAuthentication(Authentication authentication) {
             UserDetailsImpl userDetails = (UserDetailsImpl) authentication.getPrincipal();
             return userRepository.findByEmail(userDetails.getEmail()).orElseThrow();
     }
+
+    public UserResponseDto getUserDetailsByAuthentication(Authentication authentication) {
+        return userResponseDtoMapper.apply(getUserByAuthentication(authentication));
+    }
 }
diff --git a/...quizapi/commons/user/UserResponseDto.java → ...pi/commons/user/dtos/UserResponseDto.java b/...quizapi/commons/user/UserResponseDto.java → ...pi/commons/user/dtos/UserResponseDto.java
@@ -1,4 +1,4 @@
-package lab.en2b.quizapi.commons.user;
+package lab.en2b.quizapi.commons.user.dtos;
 
 import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.*;

diff --git a/api/src/main/java/lab/en2b/quizapi/commons/user/mappers/UserResponseDtoMapper.java b/api/src/main/java/lab/en2b/quizapi/commons/user/mappers/UserResponseDtoMapper.java
@@ -1,7 +1,7 @@
 package lab.en2b.quizapi.commons.user.mappers;
 
 import lab.en2b.quizapi.commons.user.User;
-import lab.en2b.quizapi.commons.user.UserResponseDto;
+import lab.en2b.quizapi.commons.user.dtos.UserResponseDto;
 import org.springframework.stereotype.Service;
 
 import java.util.function.Function;
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,3 +9,8 @@ docs/build @@
     .idea
     .vscode
     .DS_Store
+    *.crt
+    *.key
+    *.pem
+    .env