Tests utils suite (#2961)

* Update Python version and benchmark file in benchmark.yml

* Refactor main function and imports in cli.py

* Update import statement in ai_config.py

* Add set_temperature and set_memory_backend methods in config.py

* Remove unused import in prompt.py

* Add goal oriented tasks workflow

* Added agent_utils to create agent

* added pytest and vcrpy

* added write file cassette

* created goal oriented task write file with cassettes to not pay openai tokens

* solve conflicts

* add ability set azure because github workflow needs it off

* solve conflicts in cli.py

* black because linter fails

* solve conflict

* setup github action to v3

Signed-off-by: Merwane Hamadi <merwanehamadi@gmail.com>

* fix conflicts

Signed-off-by: Merwane Hamadi <merwanehamadi@gmail.com>

* Plugins: debug line always printed in plugin load

* add decorator to tests

Signed-off-by: Merwane Hamadi <merwanehamadi@gmail.com>

* move decorator higher up

Signed-off-by: Merwane Hamadi <merwanehamadi@gmail.com>

* init

* more tests

* passing tests

* skip gitbranch decorator on ci

* decorator skiponci

* black

* Update tests/utils.py decorator of skipping ci

Co-authored-by: Nicholas Tindle <nicktindle@outlook.com>

* black

* I oopsed the name

* black

* finally

* black

* wrong file

---------

Signed-off-by: Merwane Hamadi <merwanehamadi@gmail.com>
Co-authored-by: Merwane Hamadi <merwanehamadi@gmail.com>
Co-authored-by: Merwane Hamadi <merwane.hamadi@redica.com>
Co-authored-by: Richard Beales <rich@richbeales.net>
Co-authored-by: Nicholas Tindle <nick@ntindle.com>
Co-authored-by: BillSchumacher <34168009+BillSchumacher@users.noreply.github.com>
Co-authored-by: Nicholas Tindle <nicktindle@outlook.com>

autogpt/utils.py

@@ -49,15 +49,17 @@ def readable_file_size(size, decimal_places=2):
     return f"{size:.{decimal_places}f} {unit}"
 
 
-def get_bulletin_from_web() -> str:
+def get_bulletin_from_web():
     try:
         response = requests.get(
             "https://raw.githubusercontent.com/Significant-Gravitas/Auto-GPT/master/BULLETIN.md"
         )
         if response.status_code == 200:
             return response.text
-    except:
-        return ""
+    except requests.exceptions.RequestException:
+        pass
+
+    return ""
 
 
 def get_current_git_branch() -> str:

tests/test_utils.py

@@ -0,0 +1,200 @@
+import os
+from unittest.mock import Mock, patch
+
+import pytest
+import requests
+from colorama import Fore
+from git import Repo
+
+from autogpt.utils import (
+    clean_input,
+    get_bulletin_from_web,
+    get_current_git_branch,
+    get_latest_bulletin,
+    readable_file_size,
+    validate_yaml_file,
+)
+from tests.utils import skip_in_ci
+
+
+def test_validate_yaml_file_valid():
+    with open("valid_test_file.yaml", "w") as f:
+        f.write("setting: value")
+    result, message = validate_yaml_file("valid_test_file.yaml")
+    os.remove("valid_test_file.yaml")
+
+    assert result == True
+    assert "Successfully validated" in message
+
+
+def test_validate_yaml_file_not_found():
+    result, message = validate_yaml_file("non_existent_file.yaml")
+
+    assert result == False
+    assert "wasn't found" in message
+
+
+def test_validate_yaml_file_invalid():
+    with open("invalid_test_file.yaml", "w") as f:
+        f.write(
+            "settings:\n  first_setting: value\n  second_setting: value\n    nested_setting: value\n  third_setting: value\nunindented_setting: value"
+        )
+    result, message = validate_yaml_file("invalid_test_file.yaml")
+    os.remove("invalid_test_file.yaml")
+    print(result)
+    print(message)
+    assert result == False
+    assert "There was an issue while trying to read" in message
+
+
+def test_readable_file_size():
+    size_in_bytes = 1024 * 1024 * 3.5  # 3.5 MB
+    readable_size = readable_file_size(size_in_bytes)
+
+    assert readable_size == "3.50 MB"
+
+
+@patch("requests.get")
+def test_get_bulletin_from_web_success(mock_get):
+    mock_get.return_value.status_code = 200
+    mock_get.return_value.text = "Test bulletin"
+    bulletin = get_bulletin_from_web()
+
+    assert bulletin == "Test bulletin"
+
+
+@patch("requests.get")
+def test_get_bulletin_from_web_failure(mock_get):
+    mock_get.return_value.status_code = 404
+    bulletin = get_bulletin_from_web()
+    print(bulletin)
+    assert bulletin == ""
+
+
+@skip_in_ci
+def test_get_current_git_branch():
+    branch_name = get_current_git_branch()
+
+    # Assuming that the branch name will be non-empty if the function is working correctly.
+    assert branch_name != ""
+
+
+def test_get_latest_bulletin_no_file():
+    if os.path.exists("CURRENT_BULLETIN.md"):
+        os.remove("CURRENT_BULLETIN.md")
+
+    with patch("autogpt.utils.get_bulletin_from_web", return_value=""):
+        bulletin = get_latest_bulletin()
+        assert bulletin == ""
+
+
+def test_get_latest_bulletin_with_file():
+    with open("CURRENT_BULLETIN.md", "w", encoding="utf-8") as f:
+        f.write("Test bulletin")
+
+    with patch("autogpt.utils.get_bulletin_from_web", return_value=""):
+        bulletin = get_latest_bulletin()
+        assert bulletin == "Test bulletin"
+
+    os.remove("CURRENT_BULLETIN.md")
+
+
+def test_get_latest_bulletin_with_new_bulletin():
+    with open("CURRENT_BULLETIN.md", "w", encoding="utf-8") as f:
+        f.write("Old bulletin")
+
+    with patch("autogpt.utils.get_bulletin_from_web", return_value="New bulletin"):
+        bulletin = get_latest_bulletin()
+        assert "New bulletin" in bulletin
+
+    os.remove("CURRENT_BULLETIN.md")
+
+
+@patch("requests.get")
+def test_get_bulletin_from_web_success(mock_get):
+    mock_get.return_value.status_code = 200
+    mock_get.return_value.text = "Test bulletin"
+    bulletin = get_bulletin_from_web()
+
+    assert bulletin == "Test bulletin"
+    mock_get.assert_called_with(
+        "https://raw.githubusercontent.com/Significant-Gravitas/Auto-GPT/master/BULLETIN.md"
+    )
+
+
+@patch("requests.get")
+def test_get_bulletin_from_web_failure(mock_get):
+    mock_get.return_value.status_code = 404
+    bulletin = get_bulletin_from_web()
+
+    assert bulletin == ""
+
+
+@patch("requests.get")
+def test_get_bulletin_from_web_exception(mock_get):
+    mock_get.side_effect = requests.exceptions.RequestException()
+    bulletin = get_bulletin_from_web()
+
+    assert bulletin == ""
+
+
+@patch("autogpt.utils.Repo")
+def test_get_current_git_branch_success(mock_repo):
+    mock_repo.return_value.active_branch.name = "test-branch"
+    branch_name = get_current_git_branch()
+
+    assert branch_name == "test-branch"
+
+
+@patch("autogpt.utils.Repo")
+def test_get_current_git_branch_failure(mock_repo):
+    mock_repo.side_effect = Exception()
+    branch_name = get_current_git_branch()
+
+    assert branch_name == ""
+
+
+def test_get_latest_bulletin_no_file():
+    if os.path.exists("CURRENT_BULLETIN.md"):
+        os.remove("CURRENT_BULLETIN.md")
+
+    with patch("autogpt.utils.get_bulletin_from_web", return_value=""):
+        bulletin = get_latest_bulletin()
+        assert bulletin == ""
+
+
+def test_get_latest_bulletin_with_file():
+    with open("CURRENT_BULLETIN.md", "w", encoding="utf-8") as f:
+        f.write("Test bulletin")
+
+    with patch("autogpt.utils.get_bulletin_from_web", return_value=""):
+        bulletin = get_latest_bulletin()
+        assert bulletin == "Test bulletin"
+
+    os.remove("CURRENT_BULLETIN.md")
+
+
+def test_get_latest_bulletin_with_new_bulletin():
+    with open("CURRENT_BULLETIN.md", "w", encoding="utf-8") as f:
+        f.write("Old bulletin")
+
+    with patch("autogpt.utils.get_bulletin_from_web", return_value="New bulletin"):
+        bulletin = get_latest_bulletin()
+        assert f" {Fore.RED}::UPDATED:: {Fore.CYAN}New bulletin{Fore.RESET}" in bulletin
+
+    os.remove("CURRENT_BULLETIN.md")
+
+
+def test_get_latest_bulletin_new_bulletin_same_as_old_bulletin():
+    with open("CURRENT_BULLETIN.md", "w", encoding="utf-8") as f:
+        f.write("Test bulletin")
+
+    with patch("autogpt.utils.get_bulletin_from_web", return_value="Test bulletin"):
+        bulletin = get_latest_bulletin()
+        assert bulletin == "Test bulletin"
+
+    os.remove("CURRENT_BULLETIN.md")
+
+
+if __name__ == "__main__":
+    pytest.main()

tests/utils.py

@@ -16,3 +16,10 @@ def requires_api_key(env_var):
         return wrapper
 
     return decorator
+
+
+def skip_in_ci(test_function):
+    return pytest.mark.skipif(
+        os.environ.get("CI") == "true",
+        reason="This test doesn't work on GitHub Actions.",
+    )(test_function)