Merge pull request #865 from drikusroor/add-unit-tests-workflow

Add unit tests workflow

.github/workflows/unit_tests.yml

@@ -0,0 +1,40 @@
+name: Unit Tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: [3.8]
+
+    steps:
+    - name: Check out repository
+      uses: actions/checkout@v2
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+
+    - name: Run unittest tests with coverage
+      run: |
+        coverage run --source=scripts -m unittest discover tests
+
+    - name: Generate coverage report
+      run: |
+        coverage report
+        coverage xml

.gitignore

@@ -14,3 +14,8 @@ ai_settings.yaml
 .idea/*
 auto-gpt.json
 log.txt
+
+# Coverage reports
+.coverage
+coverage.xml
+htmlcov/

README.md

@@ -1,13 +1,15 @@
 # Auto-GPT: An Autonomous GPT-4 Experiment
+
 ![GitHub Repo stars](https://img.shields.io/github/stars/Torantulino/auto-gpt?style=social)
 ![Twitter Follow](https://img.shields.io/twitter/follow/siggravitas?style=social)
 [![](https://dcbadge.vercel.app/api/server/PQ7VX6TY4t?style=flat)](https://discord.gg/PQ7VX6TY4t)
+[![Unit Tests](https://github.com/Torantulino/Auto-GPT/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/Torantulino/Auto-GPT/actions/workflows/unit_tests.yml)
 
 Auto-GPT is an experimental open-source application showcasing the capabilities of the GPT-4 language model. This program, driven by GPT-4, chains together LLM "thoughts", to autonomously achieve whatever goal you set. As one of the first examples of GPT-4 running fully autonomously, Auto-GPT pushes the boundaries of what is possible with AI.
 
 ### Demo (30/03/2023):
-https://user-images.githubusercontent.com/22963551/228855501-2f5777cf-755b-4407-a643-c7299e5b6419.mp4
 
+https://user-images.githubusercontent.com/22963551/228855501-2f5777cf-755b-4407-a643-c7299e5b6419.mp4
 
 <h2 align="center"> 💖 Help Fund Auto-GPT's Development 💖</h2>
 <p align="center">
@@ -26,11 +28,10 @@ Your support is greatly appreciated
 &nbsp;&nbsp;<a href="https://github.com/SpacingLily"><img src="https://github.com/SpacingLily.png" width="50px" alt="SpacingLily" /></a>&nbsp;&nbsp;<a href="https://github.com/merwanehamadi"><img src="https://github.com/merwanehamadi.png" width="50px" alt="merwanehamadi" /></a>&nbsp;&nbsp;<a href="https://github.com/m"><img src="https://github.com/m.png" width="50px" alt="m" /></a>&nbsp;&nbsp;<a href="https://github.com/zkonduit"><img src="https://github.com/zkonduit.png" width="50px" alt="zkonduit" /></a>&nbsp;&nbsp;<a href="https://github.com/maxxflyer"><img src="https://github.com/maxxflyer.png" width="50px" alt="maxxflyer" /></a>&nbsp;&nbsp;<a href="https://github.com/tekelsey"><img src="https://github.com/tekelsey.png" width="50px" alt="tekelsey" /></a>&nbsp;&nbsp;<a href="https://github.com/digisomni"><img src="https://github.com/digisomni.png" width="50px" alt="digisomni" /></a>&nbsp;&nbsp;<a href="https://github.com/nocodeclarity"><img src="https://github.com/nocodeclarity.png" width="50px" alt="nocodeclarity" /></a>&nbsp;&nbsp;<a href="https://github.com/tjarmain"><img src="https://github.com/tjarmain.png" width="50px" alt="tjarmain" /></a>
 </p>
 
-
 ## Table of Contents
 
 - [Auto-GPT: An Autonomous GPT-4 Experiment](#auto-gpt-an-autonomous-gpt-4-experiment)
-    - [Demo (30/03/2023):](#demo-30032023)
+  - [Demo (30/03/2023):](#demo-30032023)
   - [💖 Help Fund Auto-GPT's Development](#-help-fund-auto-gpts-development)
   - [Table of Contents](#table-of-contents)
   - [🚀 Features](#-features)
@@ -47,7 +48,6 @@ Your support is greatly appreciated
   - [🛡 Disclaimer](#-disclaimer)
   - [🐦 Connect with Us on Twitter](#-connect-with-us-on-twitter)
 
-
 ## 🚀 Features
 
 - 🌐 Internet access for searches and information gathering
@@ -57,11 +57,13 @@ Your support is greatly appreciated
 - 🗃️ File storage and summarization with GPT-3.5
 
 ## 📋 Requirements
+
 - [Python 3.8 or later](https://www.tutorialspoint.com/how-to-install-python-in-windows)
 - [OpenAI API key](https://platform.openai.com/account/api-keys)
 - [PINECONE API key](https://www.pinecone.io/)
 
 Optional:
+
 - ElevenLabs Key (If you want the AI to speak)
 
 ## 💾 Installation
@@ -70,22 +72,25 @@ To install Auto-GPT, follow these steps:
 
 0. Make sure you have all the **requirements** above, if not, install/get them.
 
-*The following commands should be executed in a CMD, Bash or Powershell window. To do this, go to a folder on your computer, click in the folder path at the top and type CMD, then press enter.*
+_The following commands should be executed in a CMD, Bash or Powershell window. To do this, go to a folder on your computer, click in the folder path at the top and type CMD, then press enter._
 
 1. Clone the repository:
-For this step you need Git installed, but you can just download the zip file instead by clicking the button at the top of this page ☝️
+   For this step you need Git installed, but you can just download the zip file instead by clicking the button at the top of this page ☝️
+
 ```
 git clone https://github.com/Torantulino/Auto-GPT.git
 ```
 
 2. Navigate to the project directory:
-*(Type this into your CMD window, you're aiming to navigate the CMD window to the repository you just downloaded)*
+   _(Type this into your CMD window, you're aiming to navigate the CMD window to the repository you just downloaded)_
+
 ```
 cd 'Auto-GPT'
 ```
 
 3. Install the required dependencies:
-*(Again, type this into your CMD window)*
+   _(Again, type this into your CMD window)_
+
 ```
 pip install -r requirements.txt
 ```
@@ -98,15 +103,19 @@ pip install -r requirements.txt
 ## 🔧 Usage
 
 1. Run the `main.py` Python script in your terminal:
-*(Type this into your CMD window)*
+   _(Type this into your CMD window)_
+
 ```
 python scripts/main.py
 ```
+
 2. After each of AUTO-GPT's actions, type "NEXT COMMAND" to authorise them to continue.
 3. To exit the program, type "exit" and press Enter.
 
 ## 🗣️ Speech Mode
+
 Use this to use TTS for Auto-GPT
+
 ```
 python scripts/main.py --speak
 
@@ -125,18 +134,22 @@ To use the `google_official_search` command, you need to set up your Google API
 6. Copy the API key and set it as an environment variable named `GOOGLE_API_KEY` on your machine. See setting up environment variables below.
 7. Go to the [Custom Search Engine](https://cse.google.com/cse/all) page and click "Add".
 8. Set up your search engine by following the prompts. You can choose to search the entire web or specific sites.
-9.  Once you've created your search engine, click on "Control Panel" and then "Basics". Copy the "Search engine ID" and set it as an environment variable named `CUSTOM_SEARCH_ENGINE_ID` on your machine. See setting up environment variables below.
+9. Once you've created your search engine, click on "Control Panel" and then "Basics". Copy the "Search engine ID" and set it as an environment variable named `CUSTOM_SEARCH_ENGINE_ID` on your machine. See setting up environment variables below.
 
-*Remember that your free daily custom search quota allows only up to 100 searches. To increase this limit, you need to assign a billing account to the project to profit from up to 10K daily searches.*
+_Remember that your free daily custom search quota allows only up to 100 searches. To increase this limit, you need to assign a billing account to the project to profit from up to 10K daily searches._
 
 ### Setting up environment variables
-   For Windows Users:
+
+For Windows Users:
+
 ```
 setx GOOGLE_API_KEY "YOUR_GOOGLE_API_KEY"
 setx CUSTOM_SEARCH_ENGINE_ID "YOUR_CUSTOM_SEARCH_ENGINE_ID"
 
 ```
+
 For macOS and Linux users:
+
 ```
 export GOOGLE_API_KEY="YOUR_GOOGLE_API_KEY"
 export CUSTOM_SEARCH_ENGINE_ID="YOUR_CUSTOM_SEARCH_ENGINE_ID"
@@ -148,12 +161,15 @@ export CUSTOM_SEARCH_ENGINE_ID="YOUR_CUSTOM_SEARCH_ENGINE_ID"
 Install docker desktop.
 
 Run:
+
 ```
 docker run -d --name redis-stack-server -p 6379:6379 redis/redis-stack-server:latest
 ```
+
 See https://hub.docker.com/r/redis/redis-stack-server for setting a password and additional configuration.
 
 Set the following environment variables:
+
 ```
 MEMORY_BACKEND=redis
 REDIS_HOST=localhost
@@ -173,9 +189,9 @@ To persist memory stored in Redis.
 
 You can specify the memory index for redis using the following:
 
-````
+```
 MEMORY_INDEX=whatever
-````
+```
 
 ## 🌲 Pinecone API Key Setup
 
@@ -187,58 +203,69 @@ Pinecone enables the storage of vast amounts of vector-based memory, allowing fo
 
 ### Setting up environment variables
 
-Simply set them in the `.env` file. 
+Simply set them in the `.env` file.
 
 Alternatively, you can set them from the command line (advanced):
 
 For Windows Users:
+
 ```
 setx PINECONE_API_KEY "YOUR_PINECONE_API_KEY"
 setx PINECONE_ENV "Your pinecone region" # something like: us-east4-gcp
 
 ```
+
 For macOS and Linux users:
+
 ```
 export PINECONE_API_KEY="YOUR_PINECONE_API_KEY"
 export PINECONE_ENV="Your pinecone region" # something like: us-east4-gcp
 
 ```
 
-
 ## View Memory Usage
 
 1. View memory usage by using the `--debug` flag :)
 
-
 ## 💀 Continuous Mode ⚠️
+
 Run the AI **without** user authorisation, 100% automated.
 Continuous mode is not recommended.
 It is potentially dangerous and may cause your AI to run forever or carry out actions you would not usually authorise.
 Use at your own risk.
+
 1. Run the `main.py` Python script in your terminal:
+
 ```
 python scripts/main.py --continuous
 
 ```
+
 2. To exit the program, press Ctrl + C
 
 ## GPT3.5 ONLY Mode
+
 If you don't have access to the GPT4 api, this mode will allow you to use Auto-GPT!
+
 ```
 python scripts/main.py --gpt3only
 ```
+
 It is recommended to use a virtual machine for tasks that require high security measures to prevent any potential harm to the main computer's system and data.
 
 ## 🖼 Image Generation
+
 By default, Auto-GPT uses DALL-e for image generation. To use Stable Diffusion, a [HuggingFace API Token](https://huggingface.co/settings/tokens) is required.
 
 Once you have a token, set these variables in your `.env`:
+
 ```
 IMAGE_PROVIDER=sd
 HUGGINGFACE_API_TOKEN="YOUR_HUGGINGFACE_API_TOKEN"
 ```
 
 ## ⚠️ Limitations
+
 This experiment aims to showcase the potential of GPT-4 but comes with some limitations:
 
 1. Not a polished application or product, just an experiment
@@ -272,3 +299,17 @@ We look forward to connecting with you and hearing your thoughts, ideas, and exp
     <img src="https://api.star-history.com/svg?repos=Torantulino/auto-gpt&type=Date" alt="Star History Chart">
   </a>
 </p>
+
+## Run tests
+
+To run tests, run the following command:
+
+```
+python -m unittest discover tests
+```
+
+To run tests and see coverage, run the following command:
+
+```
+coverage run -m unittest discover tests
+```

main.py

@@ -0,0 +1 @@
+from scripts.main import main

requirements.txt

@@ -15,3 +15,4 @@ pinecone-client==2.2.1
 redis
 orjson
 Pillow
+coverage

tests.py

@@ -0,0 +1,8 @@
+import unittest
+
+if __name__ == "__main__":
+    # Load all tests from the 'scripts/tests' package
+    suite = unittest.defaultTestLoader.discover('scripts/tests')
+    
+    # Run the tests
+    unittest.TextTestRunner().run(suite)

tests/context.py

@@ -0,0 +1,5 @@
+import sys
+import os
+
+sys.path.insert(0, os.path.abspath(
+    os.path.join(os.path.dirname(__file__), '../scripts')))

tests/test_browse_scrape_text.py

@@ -2,7 +2,7 @@
 # Generated by CodiumAI
 
 import requests
-import pytest
+import tests.context
 
 from scripts.browse import scrape_text
 

tests/test_config.py

@@ -0,0 +1,58 @@
+import unittest
+from scripts.config import Config
+
+class TestConfig(unittest.TestCase):
+
+    def test_singleton(self):
+        config1 = Config()
+        config2 = Config()
+        self.assertIs(config1, config2)
+
+    def test_initial_values(self):
+        config = Config()
+        self.assertFalse(config.debug_mode)
+        self.assertFalse(config.continuous_mode)
+        self.assertFalse(config.speak_mode)
+        self.assertEqual(config.fast_llm_model, "gpt-3.5-turbo")
+        self.assertEqual(config.smart_llm_model, "gpt-4")
+        self.assertEqual(config.fast_token_limit, 4000)
+        self.assertEqual(config.smart_token_limit, 8000)
+
+    def test_set_continuous_mode(self):
+        config = Config()
+        config.set_continuous_mode(True)
+        self.assertTrue(config.continuous_mode)
+
+    def test_set_speak_mode(self):
+        config = Config()
+        config.set_speak_mode(True)
+        self.assertTrue(config.speak_mode)
+
+    def test_set_fast_llm_model(self):
+        config = Config()
+        config.set_fast_llm_model("gpt-3.5-turbo-test")
+        self.assertEqual(config.fast_llm_model, "gpt-3.5-turbo-test")
+
+    def test_set_smart_llm_model(self):
+        config = Config()
+        config.set_smart_llm_model("gpt-4-test")
+        self.assertEqual(config.smart_llm_model, "gpt-4-test")
+
+    def test_set_fast_token_limit(self):
+        config = Config()
+        config.set_fast_token_limit(5000)
+        self.assertEqual(config.fast_token_limit, 5000)
+
+    def test_set_smart_token_limit(self):
+        config = Config()
+        config.set_smart_token_limit(9000)
+        self.assertEqual(config.smart_token_limit, 9000)
+
+    def test_set_debug_mode(self):
+        config = Config()
+        config.set_debug_mode(True)
+        self.assertTrue(config.debug_mode)
+
+
+if __name__ == '__main__':
+    unittest.main()

tests/test_json_parser.py

@@ -0,0 +1,113 @@
+import unittest
+import tests.context
+
+from scripts.json_parser import fix_and_parse_json
+
+class TestParseJson(unittest.TestCase):
+    def test_valid_json(self):
+        # Test that a valid JSON string is parsed correctly
+        json_str = '{"name": "John", "age": 30, "city": "New York"}'
+        obj = fix_and_parse_json(json_str)
+        self.assertEqual(obj, {"name": "John", "age": 30, "city": "New York"})
+
+    def test_invalid_json_minor(self):
+        # Test that an invalid JSON string can be fixed with gpt
+        json_str = '{"name": "John", "age": 30, "city": "New York",}'
+        self.assertRaises(Exception, fix_and_parse_json, json_str, try_to_fix_with_gpt=False)
+
+    def test_invalid_json_major_with_gpt(self):
+        # Test that an invalid JSON string raises an error when try_to_fix_with_gpt is False
+        json_str = 'BEGIN: "name": "John" - "age": 30 - "city": "New York" :END'
+        self.assertRaises(Exception, fix_and_parse_json, json_str, try_to_fix_with_gpt=False)
+
+    def test_invalid_json_major_without_gpt(self):
+        # Test that a REALLY invalid JSON string raises an error when try_to_fix_with_gpt is False
+        json_str = 'BEGIN: "name": "John" - "age": 30 - "city": "New York" :END'
+        # Assert that this raises an exception:
+        with self.assertRaises(Exception):
+            fix_and_parse_json(json_str, try_to_fix_with_gpt=False)
+
+    def test_invalid_json_leading_sentence_with_gpt(self):
+        # Test that a REALLY invalid JSON string raises an error when try_to_fix_with_gpt is False
+        json_str = """I suggest we start by browsing the repository to find any issues that we can fix.
+
+{
+    "command": {
+        "name": "browse_website",
+        "args":{
+            "url": "https://github.com/Torantulino/Auto-GPT"
+        }
+    },
+    "thoughts":
+    {
+        "text": "I suggest we start browsing the repository to find any issues that we can fix.",
+        "reasoning": "Browsing the repository will give us an idea of the current state of the codebase and identify any issues that we can address to improve the repo.",
+        "plan": "- Look through the repository to find any issues.\n- Investigate any issues to determine what needs to be fixed\n- Identify possible solutions to fix the issues\n- Open Pull Requests with fixes",
+        "criticism": "I should be careful while browsing so as not to accidentally introduce any new bugs or issues.",
+        "speak": "I will start browsing the repository to find any issues we can fix."
+    }
+}"""
+        good_obj = {
+          "command": {
+              "name": "browse_website",
+              "args":{
+                  "url": "https://github.com/Torantulino/Auto-GPT"
+              }
+          },
+          "thoughts":
+          {
+              "text": "I suggest we start browsing the repository to find any issues that we can fix.",
+              "reasoning": "Browsing the repository will give us an idea of the current state of the codebase and identify any issues that we can address to improve the repo.",
+              "plan": "- Look through the repository to find any issues.\n- Investigate any issues to determine what needs to be fixed\n- Identify possible solutions to fix the issues\n- Open Pull Requests with fixes",
+              "criticism": "I should be careful while browsing so as not to accidentally introduce any new bugs or issues.",
+              "speak": "I will start browsing the repository to find any issues we can fix."
+          }
+      }
+        # Assert that this raises an exception:
+        self.assertEqual(fix_and_parse_json(json_str, try_to_fix_with_gpt=False), good_obj)
+
+
+
+    def test_invalid_json_leading_sentence_with_gpt(self):
+        # Test that a REALLY invalid JSON string raises an error when try_to_fix_with_gpt is False
+        json_str = """I will first need to browse the repository (https://github.com/Torantulino/Auto-GPT) and identify any potential bugs that need fixing. I will use the "browse_website" command for this.
+
+{
+    "command": {
+        "name": "browse_website",
+        "args":{
+            "url": "https://github.com/Torantulino/Auto-GPT"
+        }
+    },
+    "thoughts":
+    {
+        "text": "Browsing the repository to identify potential bugs",
+        "reasoning": "Before fixing bugs, I need to identify what needs fixing. I will use the 'browse_website' command to analyze the repository.",
+        "plan": "- Analyze the repository for potential bugs and areas of improvement",
+        "criticism": "I need to ensure I am thorough and pay attention to detail while browsing the repository.",
+        "speak": "I am browsing the repository to identify potential bugs."
+    }
+}"""
+        good_obj = {
+    "command": {
+        "name": "browse_website",
+        "args":{
+            "url": "https://github.com/Torantulino/Auto-GPT"
+        }
+    },
+    "thoughts":
+    {
+        "text": "Browsing the repository to identify potential bugs",
+        "reasoning": "Before fixing bugs, I need to identify what needs fixing. I will use the 'browse_website' command to analyze the repository.",
+        "plan": "- Analyze the repository for potential bugs and areas of improvement",
+        "criticism": "I need to ensure I am thorough and pay attention to detail while browsing the repository.",
+        "speak": "I am browsing the repository to identify potential bugs."
+    }
+}
+        # Assert that this raises an exception:
+        self.assertEqual(fix_and_parse_json(json_str, try_to_fix_with_gpt=False), good_obj)
+
+
+
+if __name__ == '__main__':
+    unittest.main()