Sample Data Loading and Test in GitHub Action (#3223)

* DB testing Workflow

* workflow

* fix data readibility

* dynamic insertion

* dynamic testing

* prettier

* Clean Code

* finalizing

* comment

* graceful exit

* pretty

* pretty

* Test case

* pretty

* basic testing

* pretty

* Empty commit

* type check

* pretty

* coderabbit

* Empty commit

* changes

* change

* pretty

* Final test

* major changes

* correction

* docs

* prettier

* finalizing

* test modifications

* test modify

* pretty

* remove test

* environment setup

* changes

* documentation updated

* documentation

* documentation

* documentation

* test

* module

* major testing improvement

* test

* pretty

* xoldd, coderabbit ai implementation

* changes

* fix

* improvements

* improvements

* code quality

* removed unnecessary packages

* fix

* remove unwanted package (xoldd)

* fix

* test database

* code-quality

* manipulate db

* fix

* backward compatibility

* fix

* final

* cleaning

* corrected environment

* host managment

* fixed code quality

* sample

* removed unncessary dependencies

* roll back to postgres env

* pretty

* pretty

* fix

* added tests

* fix

* vitest is sufficient

* coderabbit

* docker environment configuration

* docs

---------

Co-authored-by: JaiPannu-IITI <[email protected]>

Author: JaiPannu-IITI

.github/workflows/pull-request.yml

@@ -313,21 +313,3 @@ jobs:
         run: |
           source venv/bin/activate
           python .github/workflows/scripts/check_docstrings.py --directories .github
-
-
-  # Import-Sample-Data:
-  #   name: Import Sample Data
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - name: Checkout this repository
-  #       uses: actions/[email protected]
-  #     - name: Create .env file for talawa api testing environment
-  #       run: cp ./envFiles/.env.ci ./.env
-  #     - name: Build talawa api non production environment docker image
-  #       run: docker compose build
-  #     - name: Run import:sample-data
-  #       uses: addnab/docker-run-action@v3
-  #       with:
-  #         image: talawa_api
-  #         options: --env-file ./envFiles/.env.ci
-  #         run: pnpm run import:sample-data

docker/api.Containerfile

@@ -37,6 +37,9 @@ USER talawa
 RUN curl -fsSL https://fnm.vercel.app/install | bash -s -- --skip-shell \ 
 # Appends the fnm configuration to `/home/talawa/.bashrc` file.
 && echo eval \"\$\(fnm env --corepack-enabled --resolve-engines --use-on-cd --version-file-strategy=recursive\)\" >> /home/talawa/.bashrc
+# Set the PATH for all shells
+ENV NODE_VERSION=23.7.0
+ENV PATH="/home/talawa/.local/share/fnm/node-versions/v${NODE_VERSION}/installation/bin:/home/talawa/.local/share/fnm/node-versions/v${NODE_VERSION}/installation/lib/node_modules/corepack/shims:${PATH}"
 ENV PATH=/home/talawa/.local/share/fnm:${PATH}
 WORKDIR /home/talawa/api
 

docs/docs/docs/developer-resources/testing.md

@@ -10,9 +10,10 @@ This section covers important tests to validate the operation of the API.
 ### Sample Database Login Credentials
 
 If the API:
+
 1. is running with an unmodified `.env` file copied from `envFiles/.env.devcontainer` and;
 2. the API sample database is loaded;
-then you can use these login credentials to access the API via various clients.
+   then you can use these login credentials to access the API via various clients.
 
 | Email                              | Password | User Type      | Joined Organization  |
 | -----------------------------------| -------- | ---------------| -------------------- |
@@ -186,6 +187,57 @@ CloudBeaver is a lightweight web application designed for comprehensive data man
 6. You should now see the `PostgreSql@postgres-test` connection in the list of available connections. Click on the connection to open the database.
 7. Navigate to `PostgreSql@postgres-test > Databases > talawa > Schemas > public > Tables` to view the available tables.
 
+## Resetting Database (Interactive)
+
+**NOTE:** This applies only to Talawa API developers.
+
+Sometimes you may want to start all over again from scratch. These steps ensure all tables emptied and the default administrator account automatically restored.
+
+### Using the CLI (Dev Containers)
+
+This applies to users running Talawa API in dev containers.
+
+1. Once the server is running, open a new terminal session.
+
+2. Open a bash session inside the running container:
+
+  ```bash
+  docker exec -it talawa-api-1 /bin/bash
+  ```
+
+3. **WARNING:** This command will **DELETE** all data from each table in your database, administrator roles will be restored. Use with extreme caution.
+
+  ```bash
+  pnpm run reset:db
+  ```
+
+4. This command will add sample data to make it easier for developers to get an understanding of the application.
+
+  ```bash
+  pnpm run add:sample_data
+  ```
+  
+5. Then exit
+
+  ```bash
+  exit
+  ```
+
+### Using VS Code Dev Container
+
+This applies to users running Talawa API in dev containers and VSCode.
+
+1. **WARNING:** This command will **DELETE** all data from each table in your database, administrator roles will be restored. Use with extreme caution.
+  ```bash
+  pnpm run reset:db
+  ```
+2. This command will add sample data to make it easier for developers to get an understanding of the application.
+  ```bash
+  pnpm run add:sample_data
+  ```
+
+Now you can resume your development work.
+
 ## Object Storage Management
 
 MinIO is a free, open-source object storage server that's compatible with Amazon S3. It's designed for large-scale data storage and can run on-premises or in the cloud.

docs/docs/docs/getting-started/installation.md

@@ -387,24 +387,31 @@ You can run the app after closing the terminal or restating the vscode using the
 
 We have created sample data to make it easier for end users to get an understanding of the application.
 
-### Importing Sample Data
+### Using the CLI (Dev Containers)
 
 This applies to users running Talawa API in dev containers.
 
 1. Once the server is running, open a new terminal session.
-2. Open a bash session inside the running container:
-   ```bash
-   docker exec -it talawa-api-1 /bin/bash
-   ```
-3. Inside the container, run the following command to import sample data into the database:
+
+2. Run the following command to import sample data into the database:
+
    ```bash
-    pnpm run import:sample-data
+   docker exec talawa-api-1 /bin/bash -c 'pnpm run add:sample_data && exit'
    ```
-4. Then exit
+   
+   Refer to the next section for login information.
+
+### Using VS Code Dev Container
+
+This applies to users running Talawa API in dev containers and VSCode.
+
+1. Open a terminal inside the container.
+
+2. Run the following command to import sample data into the database:
+
    ```bash
-    exit
+   pnpm run add:sample_data
    ```
-   Refer to the next section for login information.
 
 ### Sample Data Users
 

package.json

@@ -17,20 +17,17 @@
     "close-with-grace": "^2.2.0",
     "drizzle-orm": "^0.39.1",
     "drizzle-zod": "0.6.1",
-    "dotenv": "^16.0.3",
     "env-schema": "^6.0.1",
     "fastify": "^5.2.1",
     "fastify-plugin": "^5.0.1",
     "graphql": "^16.10.0",
     "graphql-scalars": "^1.24.0",
     "graphql-upload-minimal": "^1.6.1",
-    "inquirer": "^12.4.1",
     "mercurius": "^16.0.1",
     "mercurius-upload": "^8.0.0",
     "minio": "^8.0.4",
     "postgres": "^3.4.5",
     "ulidx": "^2.4.1",
-    "uuid": "^11.0.5",
     "uuidv7": "^1.0.2",
     "zod": "^3.24.1"
   },
@@ -88,7 +85,8 @@
     "generate_drizzle_migrations": "drizzle-kit generate",
     "generate_graphql_sdl_file": "tsx ./scripts/generateGraphQLSDLFile.ts",
     "generate_gql_tada": "gql.tada generate-output && gql.tada turbo --fail-on-warn",
-    "import:sample-data": "tsx ./src/utilities/loadSampleData.ts",
+    "reset:db": "tsx ./scripts/dbManagement/resetDB.ts",
+    "add:sample_data": "tsx ./scripts/dbManagement/addSampleData.ts",
     "push_drizzle_schema": "drizzle-kit push",
     "push_drizzle_test_schema": "drizzle-kit push --config=./test/drizzle.config.ts",
     "run_tests": "vitest --coverage",