[#12939] Release V9.0.0-beta.1

.github/workflows/axe.yml

@@ -31,7 +31,7 @@ jobs:
           path: |
             ~/.gradle/caches
             ~/.gradle/wrapper
-          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
+          key: ${{ runner.os }}-gradle-${{ hashFiles('.gradle/*.gradle*', 'build.gradle') }}
           restore-keys: |
             ${{ runner.os }}-gradle-
       - name: Update Property File

.github/workflows/component.yml

@@ -36,7 +36,7 @@ jobs:
           path: |
             ~/.gradle/caches
             ~/.gradle/wrapper
-          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
+          key: ${{ runner.os }}-gradle-${{ hashFiles('.gradle/*.gradle*', 'build.gradle') }}
           restore-keys: |
             ${{ runner.os }}-gradle-
       - name: Cache eslint

.github/workflows/e2e-cross.yml → .github/workflows/e2e-sql.yml

@@ -1,23 +1,24 @@
-name: E2E Tests (cross-browser)
+name: E2E Sql Tests
 
 on:
   push:
     branches:
       - master
       - release
+  pull_request:
+    branches:
+      - master
+      - release
   schedule:
-    - cron: "0 0 * * *" # end of every day
+    - cron: "0 0 * * *" #end of every day
 jobs:
-  E2E-testing:
-    runs-on: ${{ matrix.os }}
+  E2E-sql-testing:
+    runs-on: ubuntu-latest
     strategy:
-      fail-fast: false # ensure both tests run even if one fails
+      fail-fast: false #ensure both tests run even if one fails
       matrix:
-        include:
-          - os: ubuntu-latest
-            browser: chrome
-          - os: windows-latest
-            browser: edge
+        browser: [firefox]
+        tests: [stable, unstable]
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
@@ -34,16 +35,12 @@ jobs:
           path: |
             ~/.gradle/caches
             ~/.gradle/wrapper
-          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
+          key: ${{ runner.os }}-gradle-${{ hashFiles('.gradle/*.gradle*', 'build.gradle') }}
           restore-keys: |
             ${{ runner.os }}-gradle-
       - name: Update Property File
         run: mv src/e2e/resources/test.ci-${{ matrix.browser }}.properties src/e2e/resources/test.properties
-      - name: Remove Solr setting
-        if: matrix.os == 'windows-latest'
-        run: sed -i 's/app.search.service.host=http\\:\/\/localhost\\:8983\/solr/app.search.service.host=/g' src/main/resources/build.template.properties
       - name: Run Solr search service + local Datastore emulator
-        if: matrix.os == 'ubuntu-latest'
         run: docker-compose up -d
       - name: Create Config Files
         run: ./gradlew createConfigs testClasses generateTypes
@@ -52,16 +49,8 @@ jobs:
       - name: Build Frontend Bundle
         run: npm run build
       - name: Start Server
-        if: matrix.os == 'ubuntu-latest'
         run: |
           ./gradlew serverRun &
           ./wait-for-server.sh
       - name: Start Tests
-        if: matrix.os == 'ubuntu-latest'
-        run: xvfb-run --server-args="-screen 0 1024x768x24" ./gradlew e2eTests
-      - name: Start Server and Tests
-        if: matrix.os == 'windows-latest'
-        run: |
-          ./gradlew runDatastoreEmulator
-          ./gradlew serverRun &
-          ./gradlew e2eTests
+        run: xvfb-run --server-args="-screen 0 1024x768x24" ./gradlew -P${{ matrix.tests }} e2eTestsSql

.github/workflows/e2e.yml

@@ -35,7 +35,7 @@ jobs:
           path: |
             ~/.gradle/caches
             ~/.gradle/wrapper
-          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
+          key: ${{ runner.os }}-gradle-${{ hashFiles('.gradle/*.gradle*', 'build.gradle') }}
           restore-keys: |
             ${{ runner.os }}-gradle-
       - name: Update Property File

.github/workflows/lnp.yml

@@ -23,7 +23,7 @@ jobs:
           path: |
             ~/.gradle/caches
             ~/.gradle/wrapper
-          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
+          key: ${{ runner.os }}-gradle-${{ hashFiles('.gradle/*.gradle*', 'build.gradle') }}
           restore-keys: |
             ${{ runner.os }}-gradle-
       - name: Create Config Files

.gitignore

@@ -80,6 +80,7 @@ src/web/dist/*
 src/web/webtools/*
 filestorage-dev/*
 datastore-dev/datastore/*
+postgres-data/
 
 !.gitkeep
 

build.gradle

@@ -6,6 +6,7 @@ apply plugin: "pmd"
 apply plugin: "com.github.spotbugs"
 apply plugin: "jacoco"
 apply plugin: "cz.habarta.typescript-generator"
+apply plugin: "org.liquibase.gradle"
 
 def checkstyleVersion = "10.3.2"
 def pmdVersion = "6.48.0"
@@ -26,11 +27,14 @@ buildscript {
             exclude group: "org.gradle"
         }
         classpath "com.google.guava:guava:31.1-jre"
+        classpath "org.liquibase:liquibase-gradle-plugin:2.1.1"
     }
 }
 
 configurations {
     staticAnalysis
+
+    liquibaseRuntime.extendsFrom testImplementation
 }
 
 repositories {
@@ -71,6 +75,8 @@ dependencies {
     implementation("org.eclipse.jetty:jetty-webapp")
     implementation("org.eclipse.jetty:jetty-annotations")
     implementation("org.jsoup:jsoup:1.15.2")
+    implementation("org.hibernate.orm:hibernate-core:6.1.6.Final")
+    implementation("org.postgresql:postgresql:42.7.2")
 
     testAnnotationProcessor(testng)
 
@@ -79,6 +85,9 @@ dependencies {
     testImplementation("org.seleniumhq.selenium:selenium-java:4.3.0")
     testImplementation("com.deque.html.axe-core:selenium:4.6.0")
     testImplementation(testng)
+    testImplementation("org.testcontainers:postgresql:1.17.6")
+    testImplementation("org.liquibase:liquibase-core:4.19.0")
+    testImplementation("org.mockito:mockito-core:5.1.1")
     // For supporting authorization code flow locally
     testImplementation("com.google.oauth-client:google-oauth-client-jetty:1.34.1")
     // For using Gmail API
@@ -91,6 +100,8 @@ dependencies {
         exclude group: "org.apache.jmeter", module: "bom"
     }
 
+    liquibaseRuntime("info.picocli:picocli:4.7.1")
+    liquibaseRuntime(sourceSets.main.output)
 }
 
 sourceSets {
@@ -109,19 +120,33 @@ sourceSets {
             srcDir "src/test/java"
             srcDir "src/e2e/java"
             srcDir "src/lnp/java"
+            srcDir "src/it/java"
             srcDir "src/client/java"
             include "**/*.java"
         }
         resources {
             srcDir "src/test/resources"
             srcDir "src/e2e/resources"
             srcDir "src/lnp/resources"
+            srcDir "src/it/resources"
             srcDir "src/client/resources"
             exclude "**/*.java"
         }
     }
 }
 
+liquibase {
+    activities {
+        main {
+            searchPath "${projectDir}"
+            changeLogFile "src/main/resources/db/changelog/db.changelog-root.xml"
+            url project.properties['liquibaseDbUrl']
+            username project.properties['liquibaseUsername']
+            password project.properties['liquibasePassword']
+        }
+    }
+}
+
 tasks.withType(cz.habarta.typescript.generator.gradle.GenerateTask) {
     jsonLibrary = "jackson2"
     optionalAnnotations = [
@@ -515,8 +540,8 @@ task lnpTests(type: Test) {
     }
 }
 
-task componentTests(type: Test) {
-    description "Runs the full unit and integration test suite."
+task unitTests(type: Test) {
+    description "Runs the full unit test suite."
     group "Test"
     useTestNG()
     options.suites "src/test/resources/testng-component.xml"
@@ -533,6 +558,30 @@ task componentTests(type: Test) {
     }
 }
 
+task integrationTests(type: Test) {
+    description "Runs the full integration test suite."
+    group "Test"
+    useTestNG()
+    options.suites "src/it/resources/testng-it.xml"
+    options.useDefaultListeners = true
+    ignoreFailures false
+    maxHeapSize = "1g"
+    reports.html.required = false
+    reports.junitXml.required = false
+    jvmArgs "-ea", "-Xss2m", "-Dfile.encoding=UTF-8"
+    afterTest afterTestClosure
+    afterSuite checkTestNgFailureClosure
+    testLogging {
+        events "passed"
+    }
+}
+
+task componentTests(type: Test) {
+    description "Runs the full unit and integration test suite."
+    group "Test"
+    dependsOn unitTests, integrationTests
+}
+
 task e2eTests {
     description "Runs the E2E test suite and retries failed test up to ${numOfTestRetries} times."
     group "Test"
@@ -570,6 +619,43 @@ task e2eTests {
     e2eTests.dependsOn "e2eTestTry${id}"
 }
 
+task e2eTestsSql {
+    description "Runs the E2E SQL test suite and retries failed test up to ${numOfTestRetries} times."
+    group "Test"
+}
+
+(1..numOfTestRetries + 1).each { id ->
+    def isFirstTry = id == 1
+    def isLastRetry = id == numOfTestRetries + 1
+    def runUnstableTests = project.hasProperty('unstable')
+    def outputFileName = runUnstableTests ? "e2e-sql-unstable-test-try-" : "e2e-sql-test-try-"
+
+    task "e2eSqlTestTry${id}"(type: Test) {
+        useTestNG()
+        options.suites isFirstTry
+                ? (runUnstableTests ? "src/e2e/resources/testng-unstable-e2e-sql.xml" : "src/e2e/resources/testng-e2e-sql.xml")
+                : file("${buildDir}/reports/${outputFileName}${id - 1}/testng-failed.xml")
+        options.outputDirectory = file("${buildDir}/reports/${outputFileName}${id}")
+        options.useDefaultListeners = true
+        ignoreFailures = !isLastRetry
+        maxHeapSize = "1g"
+        reports.html.required = false
+        reports.junitXml.required = false
+        jvmArgs "-Xss2m", "-Dfile.encoding=UTF-8"
+        testLogging {
+            events "passed"
+        }
+        afterTest afterTestClosure
+        if (isFirstTry) {
+            afterSuite checkTestNgFailureClosure
+        }
+        onlyIf {
+            isFirstTry || file("${buildDir}/reports/${outputFileName}${id - 1}/testng-failed.xml").exists()
+        }
+    }
+    e2eTestsSql.dependsOn "e2eSqlTestTry${id}"
+}
+
 task axeTests {
     description "Runs the full accessibility test suite and retries failed tests once."
     group "Test"

docker-compose.yml

@@ -12,3 +12,14 @@ services:
       context: solr
     ports:
       - 8983:8983
+  postgres:
+    image: postgres:15.1-alpine
+    restart: always
+    volumes:
+      - ./postgres-data:/var/lib/postgresql/data
+    ports:
+      - 5432:5432
+    environment:
+      POSTGRES_USER: teammates
+      POSTGRES_PASSWORD: teammates
+      POSTGRES_DB: teammates

docs/_markbind/layouts/default.md

@@ -1,24 +1,4 @@
-<head-bottom>
-  <link rel="stylesheet" href="{{ baseUrl }}/stylesheets/main.css">
-</head-bottom>
-
-<header fixed>
-  <navbar placement="top" type="inverse">
-    <a slot="brand" href="{{ baseUrl }}/index.html" title="Home" class="navbar-brand">
-      <pic src="{{ baseUrl }}/images/teammateslogo.png" width="150" alt="Logo" caption=""/>
-      <span style="font-style:italic;font-size:small">[dev docs]</span>
-    </a>
-    <li><a href="{{ baseUrl }}/index.html" class="nav-link">Home</a></li>
-    <li><a href="{{ baseUrl }}/contributing-doc.html" class="nav-link">Contributing</a></li>
-    <li><a href="https://teammatesv4.appspot.com/" target="_blank" class="nav-link">Product Website <md>:glyphicon-share-alt:</md></a></li>
-    <li><a href="https://github.com/TEAMMATES/teammates" target="_blank" class="nav-link"><md>:fab-github:</md></a></li>
-  <li slot="right">
-    <form class="navbar-form">
-      <searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback" menu-align-right></searchbar>
-    </form>
-  </li>
-  </navbar>
-</header>
+{% include "_markbind/layouts/header.md" %}
 
 <div id="flex-body">
   <nav id="site-nav" class="fixed-header-padding">
@@ -59,6 +39,7 @@
     </div>
   </nav>
   <div id="content-wrapper" class="fixed-header-padding">
+    <breadcrumb/>
     {{ content }}
   </div>
   <nav id="page-nav" class="fixed-header-padding">
@@ -68,11 +49,4 @@
   </nav>
 </div>
 
-<footer>
-
-<!-- Support MarkBind by including a link to us on your landing page! -->
-<div class="text-center">
-  <small>[Generated by {{MarkBind}} on {{timestamp}}]</small>
-</div>
-
-</footer>
+{% include "_markbind/layouts/footer.md" %}

docs/_markbind/layouts/footer.md

@@ -0,0 +1,6 @@
+<footer>
+<!-- Support MarkBind by including a link to us on your landing page! -->
+<div class="text-center">
+  <small>[Generated by {{MarkBind}} on {{timestamp}}]</small>
+</div>
+</footer>

docs/_markbind/layouts/header.md

@@ -0,0 +1,21 @@
+<head-bottom>
+  <link rel="stylesheet" href="{{ baseUrl }}/stylesheets/main.css">
+</head-bottom>
+
+<header sticky>
+  <navbar type="inverse">
+    <a slot="brand" href="{{ baseUrl }}/index.html" title="Home" class="navbar-brand">
+      <pic src="{{ baseUrl }}/images/teammateslogo.png" width="150" alt="Logo" caption=""/>
+      <span style="font-style:italic;font-size:small">[dev docs]</span>
+    </a>
+    <li><a href="{{ baseUrl }}/index.html" class="nav-link">Home</a></li>
+    <li><a href="{{ baseUrl }}/contributing-doc.html" class="nav-link">Contributing</a></li>
+    <li><a href="https://teammatesv4.appspot.com/" target="_blank" class="nav-link">Product Website <md>:glyphicon-share-alt:</md></a></li>
+    <li><a href="https://github.com/TEAMMATES/teammates" target="_blank" class="nav-link"><md>:fab-github:</md></a></li>
+  <li slot="right">
+    <form class="navbar-form">
+      <searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback" menu-align-right></searchbar>
+    </form>
+  </li>
+  </navbar>
+</header>

docs/_markbind/variables.md

@@ -1,6 +1,4 @@
 <variable name="example">
 To inject this HTML segment in your MarkBind files, use {{ example }} where you want to place it.
 More generally, surround the segment's id with double curly braces.
-</variable>
-
-<variable from="variables.json" />
+</variable>