Internal refactoring

Packages renaming, adjusting naming conventions
kafbat · Jan 24, 2024 · 3a1cec3 · 3a1cec3
1 parent 9186cd0
commit 3a1cec3
Show file tree

Hide file tree

Showing 1,021 changed files with 217 additions and 207 deletions.
diff --git a/CODE-OF-CONDUCT.md → .github/CODE-OF-CONDUCT.md b/CODE-OF-CONDUCT.md → .github/CODE-OF-CONDUCT.md
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -4,15 +4,15 @@
 # BACKEND
 /pom.xml                    @kafbat/backend
 
-/kafka-ui-contract/         @kafbat/backend
+/contract/         @kafbat/backend
 
-/kafka-ui-api/              @kafbat/backend
+/api/              @kafbat/backend
 
 # FRONTEND
-/kafka-ui-react-app/        @kafbat/frontend
+/frontend/        @kafbat/frontend
 
 # TESTS
-/kafka-ui-e2e-checks/       @kafbat/qa
+/e2e-tests/       @kafbat/qa
 
 # INFRA
 /.github/workflows/         @kafbat/devops
diff --git a/CONTRIBUTING.md → .github/CONTRIBUTING.md b/CONTRIBUTING.md → .github/CONTRIBUTING.md
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1 @@
+github: [kafbat]
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,7 +1,7 @@
 blank_issues_enabled: false
 contact_links:
   - name: Report helm issue
-    url: https://github.com/kafbat/kafka-ui-charts
+    url: https://github.com/kafbat/helm-charts
     about: Our helm charts are located in another repo. Please raise issues/PRs regarding charts in that repo.
   - name: Official documentation
     url: https://ui.docs.kafbat.io/

diff --git a/SECURITY.md → .github/SECURITY.md b/SECURITY.md → .github/SECURITY.md
diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md
@@ -0,0 +1 @@
+Please file a new issue and we'll guide you from there.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -12,7 +12,7 @@ updates:
     - "scope/backend"
     - "type/dependencies"
 - package-ecosystem: npm
-  directory: "/kafka-ui-react-app"
+  directory: "/frontend"
   schedule:
     interval: weekly
     time: "10:00"

diff --git a/.github/workflows/backend.yml b/.github/workflows/backend.yml
@@ -6,7 +6,7 @@ on:
   pull_request_target:
     types: ["opened", "edited", "reopened", "synchronize"]
     paths:
-      - "kafka-ui-api/**"
+      - "api/**"
       - "pom.xml"
 permissions: # TODO remove when public
   checks: write
@@ -45,7 +45,7 @@ jobs:
           ./mvnw -B -ntp versions:set -DnewVersion=${{ github.event.pull_request.head.sha }}
           ./mvnw -B -V -ntp verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar \
           -Dsonar.skip=${SKIP_SONAR} \
-          -Dsonar.projectKey=io.kafbat:kafka-ui_backend \
+          -Dsonar.projectKey=io.kafbat:kafbat-ui_backend \
           -Dsonar.pullrequest.key=${{ github.event.pull_request.number }} \
           -Dsonar.pullrequest.branch=$HEAD_REF \
           -Dsonar.pullrequest.base=$BASE_REF
@@ -59,4 +59,4 @@ jobs:
           ./mvnw -B -ntp versions:set -DnewVersion=$GITHUB_SHA
           ./mvnw -B -V -ntp verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar \
           -Dsonar.skip=${SKIP_SONAR} \
-          -Dsonar.projectKey=io.kafbat:kafka-ui_backend
+          -Dsonar.projectKey=io.kafbat:kafbat-ui_backend
diff --git a/.github/workflows/branch-deploy.yml b/.github/workflows/branch-deploy.yml
@@ -61,11 +61,11 @@ jobs:
         uses: docker/build-push-action@v4
         with:
           builder: ${{ steps.buildx.outputs.name }}
-          context: kafka-ui-api
+          context: api
           push: true
           tags: 297478128798.dkr.ecr.eu-central-1.amazonaws.com/kafka-ui:${{ steps.extract_branch.outputs.tag }}
           build-args: |
-            JAR_FILE=kafka-ui-api-${{ steps.build.outputs.version }}.jar
+            JAR_FILE=api-${{ steps.build.outputs.version }}.jar
           cache-from: type=local,src=/tmp/.buildx-cache
           cache-to: type=local,dest=/tmp/.buildx-cache
     outputs:

diff --git a/.github/workflows/build-public-image.yml b/.github/workflows/build-public-image.yml
@@ -60,11 +60,11 @@ jobs:
         uses: docker/build-push-action@v4
         with:
           builder: ${{ steps.buildx.outputs.name }}
-          context: kafka-ui-api
+          context: api
           push: true
           tags: public.ecr.aws/kafbat/kafka-ui-custom-build:${{ steps.extract_branch.outputs.tag }}
           build-args: |
-            JAR_FILE=kafka-ui-api-${{ steps.build.outputs.version }}.jar
+            JAR_FILE=api-${{ steps.build.outputs.version }}.jar
           cache-from: type=local,src=/tmp/.buildx-cache
           cache-to: type=local,dest=/tmp/.buildx-cache
       - name: make comment with private deployment link

diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -18,10 +18,10 @@ on:
     # The branches below must be a subset of the branches above
     branches: [ main ]
     paths:
-    - 'kafka-ui-contract/**'
-    - 'kafka-ui-react-app/**'
-    - 'kafka-ui-api/**'
-    - 'kafka-ui-serde-api/**'
+    - 'contract/**'
+    - 'frontend/**'
+    - 'api/**'
+    - 'serde-api/**'
   schedule:
     - cron: '39 15 * * 6'
 

diff --git a/.github/workflows/cve.yaml b/.github/workflows/cve.yaml
@@ -4,7 +4,7 @@ on:
   schedule:
     # * is a special character in YAML so you have to quote this string
     - cron:  '0 8 15 * *'
-  
+
 jobs:
   build-and-test:
     runs-on: ubuntu-latest
@@ -48,14 +48,14 @@ jobs:
         uses: docker/build-push-action@v4
         with:
           builder: ${{ steps.buildx.outputs.name }}
-          context: kafka-ui-api
+          context: api
           platforms: linux/amd64
           push: false
           load: true
           tags: |
             ghcr.io/kafbat/kafka-ui:${{ steps.build.outputs.version }}
           build-args: |
-            JAR_FILE=kafka-ui-api-${{ steps.build.outputs.version }}.jar
+            JAR_FILE=api-${{ steps.build.outputs.version }}.jar
           cache-from: type=local,src=/tmp/.buildx-cache
           cache-to: type=local,dest=/tmp/.buildx-cache
 

diff --git a/.github/workflows/e2e-automation.yml b/.github/workflows/e2e-automation.yml
@@ -15,7 +15,7 @@ on:
         description: 'Set Qase token to enable integration'
         required: false
         type: string
-  
+
 jobs:
   build-and-test:
     runs-on: ubuntu-latest
@@ -35,7 +35,7 @@ jobs:
       - name: Set up environment
         id: set_env_values
         run: |
-          cat "./kafka-ui-e2e-checks/.env.ci" >> "./kafka-ui-e2e-checks/.env"
+          cat "./e2e-tests/.env.ci" >> "./e2e-tests/.env"
       - name: Pull with Docker
         id: pull_chrome
         run: |
@@ -55,18 +55,18 @@ jobs:
         id: compose_app
         # use the following command until #819 will be fixed
         run: |
-          docker-compose -f kafka-ui-e2e-checks/docker/selenoid-git.yaml up -d
+          docker-compose -f e2e-tests/docker/selenoid-git.yaml up -d
           docker-compose -f ./documentation/compose/e2e-tests.yaml up -d
       - name: Run test suite
         run: |
           ./mvnw -B -ntp versions:set -DnewVersion=${{ github.sha }}
-          ./mvnw -B -V -ntp -DQASEIO_API_TOKEN=${{ github.event.inputs.qase_token }} -Dsurefire.suiteXmlFiles='src/test/resources/${{ github.event.inputs.test_suite }}.xml' -Dsuite=${{ github.event.inputs.test_suite }} -f 'kafka-ui-e2e-checks' test -Pprod
+          ./mvnw -B -V -ntp -DQASEIO_API_TOKEN=${{ github.event.inputs.qase_token }} -Dsurefire.suiteXmlFiles='src/test/resources/${{ github.event.inputs.test_suite }}.xml' -Dsuite=${{ github.event.inputs.test_suite }} -f 'e2e-tests' test -Pprod
       - name: Generate Allure report
         uses: simple-elf/allure-report-action@master
         if: always()
         id: allure-report
         with:
-          allure_results: ./kafka-ui-e2e-checks/allure-results
+          allure_results: ./e2e-tests/allure-results
           gh_pages: allure-results
           allure_report: allure-report
           subfolder: allure-results

diff --git a/.github/workflows/e2e-manual.yml b/.github/workflows/e2e-manual.yml
@@ -14,7 +14,7 @@ on:
         description: 'Set Qase token to enable integration'
         required: true
         type: string
-  
+
 jobs:
   build-and-test:
     runs-on: ubuntu-latest
@@ -28,7 +28,7 @@ jobs:
       - name: Set up environment
         id: set_env_values
         run: |
-          cat "./kafka-ui-e2e-checks/.env.ci" >> "./kafka-ui-e2e-checks/.env"
+          cat "./e2e-tests/.env.ci" >> "./e2e-tests/.env"
       - name: Set up JDK
         uses: actions/setup-java@v3
         with:
@@ -43,4 +43,4 @@ jobs:
       - name: Run test suite
         run: |
           ./mvnw -B -ntp versions:set -DnewVersion=${{ github.sha }}
-          ./mvnw -B -V -ntp -DQASEIO_API_TOKEN=${{ github.event.inputs.qase_token }} -Dsurefire.suiteXmlFiles='src/test/resources/${{ github.event.inputs.test_suite }}.xml' -Dsuite=${{ github.event.inputs.test_suite }} -f 'kafka-ui-e2e-checks' test -Pprod
+          ./mvnw -B -V -ntp -DQASEIO_API_TOKEN=${{ github.event.inputs.qase_token }} -Dsurefire.suiteXmlFiles='src/test/resources/${{ github.event.inputs.test_suite }}.xml' -Dsuite=${{ github.event.inputs.test_suite }} -f 'e2e-tests' test -Pprod
diff --git a/.github/workflows/e2e-checks.yaml → .github/workflows/e2e-tests.yaml b/.github/workflows/e2e-checks.yaml → .github/workflows/e2e-tests.yaml
@@ -3,10 +3,10 @@ on:
   pull_request_target:
     types: [ "opened", "edited", "reopened", "synchronize" ]
     paths:
-      - "kafka-ui-api/**"
-      - "kafka-ui-contract/**"
-      - "kafka-ui-react-app/**"
-      - "kafka-ui-e2e-checks/**"
+      - "api/**"
+      - "contract/**"
+      - "frontend/**"
+      - "e2e-tests/**"
       - "pom.xml"
 permissions: # TODO remove when public
   statuses: write
@@ -28,7 +28,7 @@ jobs:
       - name: Set up environment
         id: set_env_values
         run: |
-          cat "./kafka-ui-e2e-checks/.env.ci" >> "./kafka-ui-e2e-checks/.env"
+          cat "./e2e-tests/.env.ci" >> "./e2e-tests/.env"
       - name: Pull with Docker
         id: pull_chrome
         run: |
@@ -48,18 +48,18 @@ jobs:
         id: compose_app
         # use the following command until #819 will be fixed
         run: |
-          docker-compose -f kafka-ui-e2e-checks/docker/selenoid-git.yaml up -d
-          docker-compose -f ./documentation/compose/e2e-tests.yaml up -d && until [ "$(docker exec  kafka-ui wget --spider  --server-response  http://localhost:8080/actuator/health 2>&1 |  grep -c 'HTTP/1.1 200 OK')" == "1" ]; do echo "Waiting for kafka-ui ..." && sleep 1; done
+          docker-compose -f e2e-tests/docker/selenoid-git.yaml up -d
+          docker-compose -f ./documentation/compose/e2e-tests.yaml up -d && until [ "$(docker exec kafbat-ui wget --spider  --server-response  http://localhost:8080/actuator/health 2>&1 |  grep -c 'HTTP/1.1 200 OK')" == "1" ]; do echo "Waiting for kafka-ui ..." && sleep 1; done
       - name: Run test suite
         run: |
           ./mvnw -B -ntp versions:set -DnewVersion=${{ github.event.pull_request.head.sha }}
-          ./mvnw -B -V -ntp -Dsurefire.suiteXmlFiles='src/test/resources/smoke.xml' -f 'kafka-ui-e2e-checks' test -Pprod
+          ./mvnw -B -V -ntp -Dsurefire.suiteXmlFiles='src/test/resources/smoke.xml' -f 'e2e-tests' test -Pprod
       - name: Generate allure report
         uses: simple-elf/allure-report-action@master
         if: always()
         id: allure-report
         with:
-          allure_results: ./kafka-ui-e2e-checks/allure-results
+          allure_results: ./e2e-tests/allure-results
           gh_pages: allure-results
           allure_report: allure-report
           subfolder: allure-results

diff --git a/.github/workflows/e2e-weekly.yml b/.github/workflows/e2e-weekly.yml
@@ -22,7 +22,7 @@ jobs:
       - name: Set up environment
         id: set_env_values
         run: |
-          cat "./kafka-ui-e2e-checks/.env.ci" >> "./kafka-ui-e2e-checks/.env"
+          cat "./e2e-tests/.env.ci" >> "./e2e-tests/.env"
       - name: Pull with Docker
         id: pull_chrome
         run: |
@@ -42,18 +42,18 @@ jobs:
         id: compose_app
         # use the following command until #819 will be fixed
         run: |
-          docker-compose -f kafka-ui-e2e-checks/docker/selenoid-git.yaml up -d
+          docker-compose -f e2e-tests/docker/selenoid-git.yaml up -d
           docker-compose -f ./documentation/compose/e2e-tests.yaml up -d
       - name: Run test suite
         run: |
           ./mvnw -B -ntp versions:set -DnewVersion=${{ github.sha }}
-          ./mvnw -B -V -ntp -DQASEIO_API_TOKEN=${{ secrets.QASEIO_API_TOKEN }} -Dsurefire.suiteXmlFiles='src/test/resources/sanity.xml' -Dsuite=weekly -f 'kafka-ui-e2e-checks' test -Pprod
+          ./mvnw -B -V -ntp -DQASEIO_API_TOKEN=${{ secrets.QASEIO_API_TOKEN }} -Dsurefire.suiteXmlFiles='src/test/resources/sanity.xml' -Dsuite=weekly -f 'e2e-tests' test -Pprod
       - name: Generate Allure report
         uses: simple-elf/allure-report-action@master
         if: always()
         id: allure-report
         with:
-          allure_results: ./kafka-ui-e2e-checks/allure-results
+          allure_results: ./e2e-tests/allure-results
           gh_pages: allure-results
           allure_report: allure-report
           subfolder: allure-results

diff --git a/.github/workflows/frontend.yaml b/.github/workflows/frontend.yaml
@@ -6,8 +6,8 @@ on:
   pull_request_target:
     types: ["opened", "edited", "reopened", "synchronize"]
     paths:
-      - "kafka-ui-contract/**"
-      - "kafka-ui-react-app/**"
+      - "contract/**"
+      - "frontend/**"
 
 jobs:
   build-and-test:
@@ -32,28 +32,28 @@ jobs:
         with:
           node-version: "18.17.1"
           cache: "pnpm"
-          cache-dependency-path: "./kafka-ui-react-app/pnpm-lock.yaml"
+          cache-dependency-path: "./frontend/pnpm-lock.yaml"
       - name: Install Node dependencies
         run: |
-          cd kafka-ui-react-app/
+          cd frontend/
           pnpm install --frozen-lockfile
       - name: Generate sources
         run: |
-          cd kafka-ui-react-app/
+          cd frontend/
           pnpm gen:sources
       - name: Linter
         run: |
-          cd kafka-ui-react-app/
+          cd frontend/
           pnpm lint:CI
       - name: Tests
         run: |
-          cd kafka-ui-react-app/
+          cd frontend/
           pnpm test:CI
       - name: SonarCloud Scan
         if: false # TODO remove when public
         uses: sonarsource/sonarcloud-github-action@master
         with:
-          projectBaseDir: ./kafka-ui-react-app
+          projectBaseDir: ./frontend
           args: -Dsonar.pullrequest.key=${{ github.event.pull_request.number }} -Dsonar.pullrequest.branch=${{ github.head_ref }} -Dsonar.pullrequest.base=${{ github.base_ref }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

diff --git a/.github/workflows/master.yaml b/.github/workflows/master.yaml
@@ -3,7 +3,7 @@ on:
   workflow_dispatch:
   push:
     branches: [ "main" ]
-  
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -54,15 +54,15 @@ jobs:
         uses: docker/build-push-action@v4
         with:
           builder: ${{ steps.buildx.outputs.name }}
-          context: kafka-ui-api
+          context: api
           platforms: linux/amd64,linux/arm64
           provenance: false
           push: true
           tags: |
             ghcr.io/kafbat/kafka-ui:${{ steps.build.outputs.version }}
             ghcr.io/kafbat/kafka-ui:main
           build-args: |
-            JAR_FILE=kafka-ui-api-${{ steps.build.outputs.version }}.jar
+            JAR_FILE=api-${{ steps.build.outputs.version }}.jar
           cache-from: type=local,src=/tmp/.buildx-cache
           cache-to: type=local,dest=/tmp/.buildx-cache
 #################################

diff --git a/.github/workflows/release-serde-api.yaml b/.github/workflows/release-serde-api.yaml
@@ -30,4 +30,4 @@ jobs:
 
       - name: Publish to Maven Central
         run: |
-          mvn source:jar  javadoc:jar  package  gpg:sign -Dgpg.passphrase=${{ secrets.GPG_PASSPHRASE }} -Dserver.username=${{ secrets.NEXUS_USERNAME }} -Dserver.password=${{ secrets.NEXUS_PASSWORD }} nexus-staging:deploy   -pl kafka-ui-serde-api  -s settings.xml
+          mvn source:jar  javadoc:jar  package  gpg:sign -Dgpg.passphrase=${{ secrets.GPG_PASSPHRASE }} -Dserver.username=${{ secrets.NEXUS_USERNAME }} -Dserver.password=${{ secrets.NEXUS_PASSWORD }} nexus-staging:deploy   -pl serde-api  -s settings.xml
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -40,14 +40,14 @@ jobs:
         uses: svenstaro/[email protected]
         with:
           repo_token: ${{ secrets.GITHUB_TOKEN }}
-          file: kafka-ui-api/target/kafka-ui-api-${{ steps.build.outputs.version }}.jar
+          file: api/target/api-${{ steps.build.outputs.version }}.jar
           tag: ${{ github.event.release.tag_name }}
 
       - name: Archive JAR
         uses: actions/upload-artifact@v3
         with:
-          name: kafka-ui-${{ steps.build.outputs.version }}
-          path: kafka-ui-api/target/kafka-ui-api-${{ steps.build.outputs.version }}.jar
+          name: kafbat-ui-${{ steps.build.outputs.version }}
+          path: api/target/api-${{ steps.build.outputs.version }}.jar
 #################
 #               #
 # Docker images #
@@ -73,15 +73,15 @@ jobs:
         uses: docker/build-push-action@v4
         with:
           builder: ${{ steps.buildx.outputs.name }}
-          context: kafka-ui-api
+          context: api
           platforms: linux/amd64,linux/arm64
           provenance: false
           push: true
           tags: |
             ghcr.io/kafbat/kafka-ui:${{ steps.build.outputs.version }}
             ghcr.io/kafbat/kafka-ui:latest
           build-args: |
-            JAR_FILE=kafka-ui-api-${{ steps.build.outputs.version }}.jar
+            JAR_FILE=api-${{ steps.build.outputs.version }}.jar
           cache-from: type=local,src=/tmp/.buildx-cache
           cache-to: type=local,dest=/tmp/.buildx-cache
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Please file a new issue and we'll guide you from there.