✅ CI / CD - run tests on every commit

.github/workflows/docker-build.yml

@@ -0,0 +1,45 @@
+name: GPTR tests
+run-name: ${{ github.actor }} ran the GPTR tests flow
+permissions:
+  contents: read
+  pull-requests: write
+on:
+  workflow_dispatch:  # Add this line to enable manual triggering
+  # pull_request:
+  #   types: [opened, synchronize]
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    environment: tests  # Specify the environment to use for this job
+    env:
+      # Ensure these environment variables are set for the entire job
+      OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+      TAVILY_API_KEY: ${{ secrets.TAVILY_API_KEY }}
+      LANGCHAIN_API_KEY: ${{ secrets.LANGCHAIN_API_KEY }}
+    steps:
+      - name: Git checkout
+        uses: actions/checkout@v3
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+        with:
+          driver: docker
+
+      # - name: Build Docker images
+      #   uses: docker/build-push-action@v4
+      #   with:
+      #     push: false
+      #     tags: gptresearcher/gpt-researcher:latest
+      #     file: Dockerfile          
+
+      - name: Set up Docker Compose
+        run: |
+          sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
+          sudo chmod +x /usr/local/bin/docker-compose
+      - name: Run tests with Docker Compose
+        run: |
+          docker-compose run --rm gpt-researcher-tests

Dockerfile

@@ -33,6 +33,12 @@ RUN pip install -r multi_agents/requirements.txt
 
 FROM gpt-researcher-install AS gpt-researcher
 
+ARG OPENAI_API_KEY
+ARG TAVILY_API_KEY
+
+ENV OPENAI_API_KEY=${OPENAI_API_KEY}
+ENV TAVILY_API_KEY=${TAVILY_API_KEY}
+
 RUN useradd -ms /bin/bash gpt-researcher \
     && chown -R gpt-researcher:gpt-researcher /usr/src/app
 

README.md

@@ -30,7 +30,7 @@
 
 The agent can produce detailed, factual and unbiased research reports, with customization options for focusing on relevant resources and outlines. Inspired by the recent [Plan-and-Solve](https://arxiv.org/abs/2305.04091) and [RAG](https://arxiv.org/abs/2005.11401) papers, GPT Researcher addresses issues of misinformation, speed, determinism and reliability, offering a more stable performance and increased speed through parallelized agent work, as opposed to synchronous operations.
 
-**Our mission is to empower individuals and organizations with accurate, unbiased, and factual information by leveraging the power of AI.**
+**Our mission is to empower individuals and organizations with accurate, unbiased, and factual information by leveraging the power of AI.** 
 
 ## Why GPT Researcher?
 

application/next-env.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/basic-features/typescript for more information.

docker-compose.yml

@@ -26,3 +26,16 @@ services:
     restart: always
     ports:
       - 3000:3000
+
+  gpt-researcher-tests:
+    image: gptresearcher/gpt-researcher
+    build: ./
+    environment: 
+      OPENAI_API_KEY: ${OPENAI_API_KEY}
+      TAVILY_API_KEY: ${TAVILY_API_KEY}
+      LANGCHAIN_API_KEY: ${LANGCHAIN_API_KEY}
+    command: >
+      /bin/sh -c "
+      pip install pytest pytest-asyncio &&
+      python -m pytest tests/report-types.py
+      "

tests/all-6-report-types.py → tests/report-types.py

@@ -6,16 +6,12 @@
 # Define the report types to test
 report_types = [
     "research_report",
-    "custom_report",
-    "subtopic_report",
-    "summary_report",
-    "detailed_report",
-    "quick_report"
+    "subtopic_report"
 ]
 
 # Define a common query and sources for testing
 query = "What are the latest advancements in AI?"
-sources = ["https://en.wikipedia.org/wiki/Artificial_intelligence", "https://www.ibm.com/watson/ai"]
+# sources = ["https://en.wikipedia.org/wiki/Artificial_intelligence", "https://www.ibm.com/watson/ai"]
 
 # Define the output directory
 output_dir = "./outputs"
@@ -28,7 +24,7 @@ async def test_gpt_researcher(report_type):
         os.makedirs(output_dir)
 
     # Create an instance of GPTResearcher
-    researcher = GPTResearcher(query=query, report_type=report_type, source_urls=sources)
+    researcher = GPTResearcher(query=query, report_type=report_type)
 
     # Conduct research and write the report
     await researcher.conduct_research()