Develop

.env

@@ -0,0 +1,4 @@
+MYSQL_HOST=db
+KEYSTORE_PATH=./testCert.p12
+KEYSTORE_PASSWORD=123456
+WIQ_IMAGE=pelayori/wiq_es04b

.github/workflows/release.yml

@@ -43,7 +43,8 @@ jobs:
           username: ${{ secrets.DEPLOY_USER }}
           key: ${{ secrets.DEPLOY_KEY }}
           script: |
-            wget https://raw.githubusercontent.com/${{ github.repository }}/${{ github.ref_name }}/docker-compose.yml -O docker-compose.yml
             docker-compose down
+            wget https://raw.githubusercontent.com/${{ github.repository }}/${{ github.ref_name }}/docker-compose.yml -O docker-compose.yml
+            wget https://raw.githubusercontent.com/${{ github.repository }}/${{ github.ref_name }}/prometheus.yml -O prometheus.yml
             docker compose pull
             docker-compose up -d

.github/workflows/unit-tests-push.yml

@@ -74,4 +74,4 @@ jobs:
             kill $(cat spring-boot-app.pid)
       - name: Collect Jacoco report and send to Sonar
         run: |
-            ./mvnw org.jacoco:jacoco-maven-plugin:report sonar:sonar -Dsonar.projectKey=Arquisoft_wiq_es04b -Dsonar.organization=arquisoft -Dsonar.branch.name=${{ github.head_ref || github.ref_name }}  -Dsonar.host.url=https://sonarcloud.io -Dsonar.login=${{ secrets.SONAR_TOKEN }} -Dspring.profiles.active=test
+            ./mvnw org.jacoco:jacoco-maven-plugin:report sonar:sonar -Dsonar.projectKey=Arquisoft_wiq_es04b -Dsonar.organization=arquisoft -Dsonar.branch.name=${{ github.head_ref || github.ref_name }} -Dsonar.host.url=https://sonarcloud.io -Dsonar.login=${{ secrets.SONAR_TOKEN }} -Dspring.profiles.active=test

Dockerfile

@@ -1,13 +1,13 @@
 # Build stage with Maven and JDK 17
 FROM maven:3.8.4-openjdk-17-slim as build
-WORKDIR /app
+WORKDIR ./app
 COPY pom.xml .
 COPY src src/
 # Use Maven directly instead of the Maven Wrapper
 RUN mvn clean package -DskipTests
 
 # Run stage with JDK 17
 FROM openjdk:17-slim
-COPY --from=build /app/target/*.jar app.jar
+COPY --from=build ./app/target/*.jar app.jar
 ENTRYPOINT ["java","-Djava.security.egd=file:/dev/./urandom","-Dspring.profiles.active=prod","-jar","/app.jar"]
 EXPOSE 443

docker-compose.yml

@@ -18,13 +18,13 @@ services:
     restart: always
 
   wiq_es04b:
-    image: ghcr.io/arquisoft/wiq_es04b:latest
+    image: ${WIQ_IMAGE:-ghcr.io/arquisoft/wiq_es04b:latest}
     environment:
       MYSQL_HOST: ${MYSQL_HOST}
-      MYSQL_PORT: ${MYSQL_PORT}
-      MYSQL_DATABASE: ${MYSQL_DATABASE}
-      MYSQL_USER: ${MYSQL_USER}
-      MYSQL_PASSWORD: ${MYSQL_PASSWORD}
+      MYSQL_DATABASE: ${MYSQL_DATABASE:-wiq_es04b}
+      MYSQL_USER: ${MYSQL_USER:-wiq_es04b}
+      MYSQL_PASSWORD: ${MYSQL_PASSWORD:-wiq_es04b}
+      MYSQL_PORT: ${MYSQL_PORT:-3306}
       KEYSTORE_PATH: ${KEYSTORE_PATH}
       KEYSTORE_PASSWORD: ${KEYSTORE_PASSWORD}
     ports:
@@ -38,9 +38,40 @@ services:
     volumes:
       - ${KEYSTORE_PATH}:/certs/keystore.p12
 
+  prometheus:
+    image: prom/prometheus:latest
+    volumes:
+      - prometheus_data:/prometheus
+      - ./prometheus.yml:/etc/prometheus/prometheus.yml
+    ports:
+      - "9090:9090"
+    networks:
+      - mynetwork
+    depends_on:
+      - wiq_es04b
+    restart: always
+
+  grafana:
+    image: grafana/grafana:latest
+    volumes:
+      - grafana_data:/var/lib/grafana
+    environment:
+      GF_AUTH_DISABLE_LOGIN_FORM: 1
+      GF_AUTH_ANONYMOUS_ENABLED: true
+      GF_AUTH_ANONYMOUS_ORG_ROLE: Admin
+    ports:
+      - "3000:3000"
+    networks:
+      - mynetwork
+    depends_on:
+      - prometheus
+    restart: always
+
 volumes:
   db_data:
+  prometheus_data:
+  grafana_data:
 
 networks:
   mynetwork:
-    driver: bridge
+    driver: bridge

docs/index.adoc

@@ -101,4 +101,12 @@ include::src/11_technical_risks.adoc[]
 // 12. Glossary
 include::src/12_glossary.adoc[]
 
+<<<<
+// 13. Question Generation Strategy
+include::src/13_question_generation_strategy.adoc[]
+
+<<<<
+// 14. Testing
+include::src/14_testing.adoc[]
+
 

docs/src/05_building_block_view.adoc

@@ -18,10 +18,10 @@ This section provides an overview of the main components of the system and their
 actor User
 actor "External Developers" as Dev
 component "[WIQ QuestionGame]" as WIQ {
-  component "[Game Logic]" as Logic
-  component "[User Account\nManagement]" as UserMgmt
-  component "[Question\nManagement]" as QuestMgmt
-  component "[API\nManagement]" as APIMgmt
+  component "[GameSession\nService]" as Logic
+  component "[PlayerService]" as UserMgmt
+  component "[QuestionService]" as QuestMgmt
+  component "[RestApi\nService]" as APIMgmt
 }
 database "Database" as DB
 [WikiData] as WikiData
@@ -64,13 +64,13 @@ The decomposition provides a clear, high-level overview of how the WIQ system in
 
 For Level 2 of the Building Block View, the WIQ (QuestionGame) system is further decomposed into four primary components that define its operational structure. Each component is designed to fulfill specific roles within the architecture, ensuring the system's functionality and responsiveness to user interactions.
 
-* *Game Logic:* This component acts as the core of the QuestionGame, orchestrating the flow of games, managing question selection, enforcing game rules, and tracking scores. It ensures that gameplay proceeds smoothly and according to the predefined logic, offering a seamless experience for the user.
+* *GameService:* This component acts as the core of the QuestionGame, orchestrating the flow of games, managing question selection, enforcing game rules, and tracking scores. It ensures that gameplay proceeds smoothly and according to the predefined logic, offering a seamless experience for the user.
 
-* *User Account Management:* Responsible for handling user accounts, this component manages registration, authentication, and profile management. It safeguards user data while providing a personalized experience through game history tracking and preference settings.
+* *PlayerService:* Responsible for handling user accounts, this component manages registration, authentication, and profile management. It safeguards user data while providing a personalized experience through game history tracking and preference settings.
 
-* *Question Management:* This component interacts directly with the Wikidata service to fetch data for question generation. It processes and curates content to produce relevant, challenging questions for the game, thereby ensuring a varied and educational experience.
+* *QuestionService:* This component interacts directly with the Wikidata service to fetch data for question generation. It processes and curates content to produce relevant, challenging questions for the game, thereby ensuring a varied and educational experience.
 
-* *API Management:* Serving as the gateway for external developers, this component exposes a set of RESTful APIs that allow access to player information and question data. It handles request processing, authentication, and data delivery, facilitating third-party integrations and extensions of the WIQ platform.
+* *RestApiService:* Serving as the gateway for external developers, this component exposes a set of RESTful APIs that allow access to player information and question data. It handles request processing, authentication, and data delivery, facilitating third-party integrations and extensions of the WIQ platform.
 
 
 [plantuml,"level2",png]
@@ -79,10 +79,10 @@ For Level 2 of the Building Block View, the WIQ (QuestionGame) system is further
 !theme plain
 
 package "WIQ QuestionGame" {
-  component "[Game Logic]" as Logic
-  component "[User Account\nManagement]" as UserMgmt
-  component "[Question\nManagement]" as QuestMgmt
-  component "[API\nManagement]" as APIMgmt
+  component "[GameSession\nService]" as Logic
+  component "[PlayerService]" as UserMgmt
+  component "[QuestionService]" as QuestMgmt
+  component "[RestApi\nService]" as APIMgmt
 
   UserMgmt -[hidden]-> Logic : <<uses>>
   QuestMgmt -[hidden]-> Logic : <<uses>>

docs/src/13_question_generation_strategy.adoc

@@ -0,0 +1,137 @@
+ifndef::imagesdir[:imagesdir: ../images]
+
+[[section-question-generation-strategy]]
+== Question Generation Strategy
+
+The generation of questions in our application is handled through a combination of classes and interfaces, primarily QuestionGeneratorV2 and QuestionGeneratorService.
+
+=== Question templates
+
+The two classes mentioned before use a JSON file that stores the question templates. These templates are used to generalize the question generation process. The JSON file is structured as follows:
+
+==== JSON Structure
+
+The JSON has the following structure:
+
+- `language_placeholder`, `question_placeholder`, and `answer_placeholder` are strings used as placeholders for the language, question, and answer, respectively.
+
+- `categories` is an array containing objects representing different categories of questions.
+
+Each category object has two properties:
+
+- `name`: The name of the category.
+- `questions`: An array of objects representing questions within that category.
+
+Each question object has the following properties:
+
+- `type`: The type of question.
+- `statements`: An array of objects representing statements in different languages for the question. Each object has two properties: `language` and `statement`.
+- `question`: The property queried to generate the question.
+- `answer`: The property queried to obtain the answer.
+- `sparqlQuery`: The SPARQL query used to retrieve data for generating the question and answer.
+
+==== Compact Example of JSON Hierarchy
+
+[source,json]
+----
+{
+  "language_placeholder": "[LANGUAGE]",
+  "question_placeholder": "[QUESTION]",
+  "answer_placeholder": "[ANSWER]",
+  "categories": [
+    {
+      "name": "Geography",
+      "questions": [
+        {
+          "type": "capital",
+          "statements": [
+            {
+              "language": "es",
+              "statement": "¿Cuál es la capital de [QUESTION]?"
+            },
+            {
+              "language": "en",
+              "statement": "What is the capital of [QUESTION]?"
+            },
+            {
+              "language": "fr",
+              "statement": "Quelle est la capitale de [QUESTION]?"
+            }
+          ],
+          "question": "countryLabel",
+          "answer": "capitalLabel",
+          "sparqlQuery": "..."
+        },
+        {
+          "type": "currency",
+          "statements": [
+            {
+              "language": "es",
+              "statement": "¿Cuál es la moneda de [QUESTION]?"
+            },
+            {
+              "language": "en",
+              "statement": "What is the currency of [QUESTION]?"
+            },
+            {
+              "language": "fr",
+              "statement": "Quelle est la monnaie de [QUESTION]?"
+            }
+          ],
+          "question": "countryLabel",
+          "answer": "currencyLabel",
+          "sparqlQuery": "..."
+        }
+      ]
+    },
+    {
+      "name": "Science",
+      "questions": [
+        {
+          "type": "element",
+          "statements": [
+            {
+              "language": "es",
+              "statement": "¿Cuál es el símbolo químico del [QUESTION]?"
+            },
+            {
+              "language": "en",
+              "statement": "What is the chemical symbol of [QUESTION]?"
+            },
+            {
+              "language": "fr",
+              "statement": "Quel est le symbole chimique du [QUESTION]?"
+            }
+          ],
+          "question": "elementLabel",
+          "answer": "symbol",
+          "sparqlQuery": "..."
+        }
+      ]
+    }
+  ]
+}
+----
+
+=== Example of a query
+Here's an example of how you could use this JSON structure to query information:
+
+To execute a query you just need to build a SPARQL query that retrieves the data you need. For example, to get the capital of a country, you could use the following query:
+[source, SPARQL]
+----
+select distinct ?country ?countryLabel ?capital ?capitalLabel where {
+  ?country wdt:P31 wd:Q6256 .
+  ?capital wdt:P31 wd:Q5119 .
+  ?country wdt:P36 ?capital .
+  ?country rdfs:label ?countryLabel .
+  ?capital rdfs:label ?capitalLabel .
+  FILTER NOT EXISTS {?country wdt:P31 wd:Q3024240} .
+  FILTER(LANG(?countryLabel)="es" && LANG(?capitalLabel)="es")
+  }
+----
+Once you have a query the next step is to add it to thr JSON file. Following the previous example, you should start declaring a new object inside the `questions` array of the `Geography` category. You should fill the `type`, `statements`, `question`, `answer`, and `sparqlQuery` properties with the appropriate values. For the `type` field you could add the value `"capital"`, for the `statements` array you could add the statements in different languages also adding to them the placeholder that you used in the `question_placeholder` field. For the `question` field you should add the value `"countryLabel"`, for the `answer` you should add the value `"capitalLabel"`. For the `sparqlQuery` field you should replace in your original query every instance of `"countryLabel"` with the value of `question_placeholder` and `"capitalLabel"` with the value of `answer_placeholder`. The final object should look like the one showed in the JSON hierarchy example.
+
+By following this approach, you can dynamically generate a wide variety of questions based on the structured data stored in your JSON file. This allows for flexibility and scalability in your question generation process.
+
+=== Question Generation Process
+Once we have the JSON file with the question templates, we can start generating questions. Each time the application starts the QuestionGeneratorService class reads the JSON file and stores the question templates in memory. This way, the application can generate questions without needing to read the file each time. These templates are stored in a synchronized stack, which allows for thread-safe access to the templates. When the application starts after reading the JSON file and storing  the templates the QuestionGeneratorService class deletes all the questions that are stored in the database. After deleting the questions, the QuestionGeneratorService starts a cycle that generates all the questions in all the 3 main languages of the app for a specific type of question each two and a half minutes. This cycle is repeated until all the question types are generated. After this every 24 hours the cycle will start again with the parsing of the JSON, filling the Stack, emptying the database and generating the questions. All this process can be forced by an Admin user through the Admin panel in the app where an Admin can change the JSON (which will lead to the restart of the question generation process) or delete all questions.

docs/src/14_testing.adoc

@@ -0,0 +1,13 @@
+ifndef::imagesdir[:imagesdir: ../images]
+
+[[section-testing]]
+== Testing
+
+To be able to achieve continuous delivery, we need to have a good test coverage. We need to have a good test coverage to be able to refactor the code without breaking it, to be able to deliver the software with confidence and to be able to deliver the software with quality.
+
+=== Unit Test
+In our project, we have implemented unit tests for various components of the application. The tests are written in Java and use the JUnit 5 framework for testing. We also use the Spring Boot Test framework for testing Spring Boot applications, which provides utilities and annotations to test the application in a way that is very close to its actual runtime behavior.  The tests are located in the src/test/java/com/uniovi directory. The main test class is Wiq_UnitTests.java, which contains tests for various services and repositories in our application.
+
+=== Integration Test (E2E)
+
+=== Load Test

pom.xml

@@ -114,6 +114,14 @@
             <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
             <version>2.5.0</version>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-actuator</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.micrometer</groupId>
+            <artifactId>micrometer-registry-prometheus</artifactId>
+        </dependency>
     </dependencies>
 
     <build>

prometheus.yml

@@ -0,0 +1,12 @@
+global:
+  scrape_interval: 2s
+  scrape_timeout: 1s
+
+scrape_configs:
+  - job_name: 'spring-application'
+    scrape_interval: 2s
+    scrape_timeout: 1s
+    metrics_path: '/actuator/prometheus'
+    scheme: https
+    static_configs:
+      - targets: [ 'wikigame.es:443' ]

src/main/java/com/uniovi/WiqEs04bApplication.java

@@ -2,8 +2,10 @@
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.scheduling.annotation.EnableScheduling;
 
 @SpringBootApplication
+@EnableScheduling
 public class WiqEs04bApplication {
     public static void main(String[] args) {
         SpringApplication.run(WiqEs04bApplication.class, args);