[Feature] - OpenBB Platform CLI Unit tests (#6397)

* Unit test batch 1

* CLI controller

* Test batch 3

* Test batch 4

* Test batch 5

* clean some workflows and setup actions

* test

* rename wfs

* rename

* update action

* Skip

* fix cli tests

---------

Co-authored-by: Henrique Joaquim <henriquecjoaquim@gmail.com>
Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>
Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>

.github/scripts/noxfile.py

@@ -9,10 +9,12 @@
 PLATFORM_TESTS = [
     str(PLATFORM_DIR / p) for p in ["tests", "core", "providers", "extensions"]
 ]
+CLI_DIR = ROOT_DIR / "cli"
+CLI_TESTS = CLI_DIR / "tests"
 
 
 @nox.session(python=["3.9", "3.10", "3.11"])
-def tests(session):
+def unit_test_platform(session):
     """Run the test suite."""
     session.install("poetry", "toml")
     session.run(
@@ -27,3 +29,19 @@ def tests(session):
     session.run(
         "pytest", *PLATFORM_TESTS, f"--cov={PLATFORM_DIR}", "-m", "not integration"
     )
+
+
+@nox.session(python=["3.9", "3.10", "3.11"])
+def unit_test_cli(session):
+    """Run the test suite."""
+    session.install("poetry", "toml")
+    session.run(
+        "python",
+        str(PLATFORM_DIR / "dev_install.py"),
+        "-e",
+        "all",
+        external=True,
+    )
+    session.install("pytest")
+    session.install("pytest-cov")
+    session.run("pytest", CLI_TESTS, f"--cov={CLI_DIR}")

.github/workflows/test_pypi_platform.yml → .github/workflows/deploy-test-pypi.yml

@@ -1,4 +1,4 @@
-name: Deploy the OpenBB Platform and the OpenBBTerminal to Test PyPI
+name: Deploy the OpenBB Platform to Test PyPI
 
 on:
   push:

.github/workflows/draft-release.yml

@@ -1,4 +1,4 @@
-name: Release Drafter
+name: Draft release
 
 on:
   workflow_dispatch:

.github/workflows/linting.yml → .github/workflows/general-linting.yml

@@ -1,10 +1,6 @@
 name: General Linting
 
 env:
-  OPENBB_ENABLE_QUICK_EXIT: true
-  OPENBB_LOG_COLLECT: false
-  OPENBB_USE_PROMPT_TOOLKIT: false
-  OPENBB_FILE_OVERWRITE: true
   PIP_DEFAULT_TIMEOUT: 100
 
 on:

.github/workflows/platform-api-integration-test.yml → .github/workflows/test-integration-platform.yml

@@ -1,4 +1,4 @@
-name: API Integration Tests
+name: 🚉 Integration test Platform (API)
 
 on:
   workflow_dispatch:

.github/workflows/test-unit-cli.yml

@@ -0,0 +1,46 @@
+name: 🖥️ Unit test CLI
+
+on:
+  pull_request:
+    branches:
+      - develop
+    paths:
+      - 'cli/**'
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
+    cancel-in-progress: true
+
+jobs:
+  unit_tests:
+    runs-on: ubuntu-latest
+    strategy:
+        fail-fast: false
+
+        matrix:
+          python_version:
+            ["3.9", "3.10", "3.11"]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+      - name: Install Python ${{ matrix.python_version }}
+        uses: actions/setup-python@v4
+        with:
+            python-version: ${{ matrix.python_version }}
+            allow-prereleases: true
+            cache: "pip"
+
+      - name: Cache pip packages
+        uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('cli/poetry.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Run tests
+        run: |
+          pip install nox
+          nox -f .github/scripts/noxfile.py -s unit_test_cli --python ${{ matrix.python_version }}

.github/workflows/platform-core.yml → .github/workflows/test-unit-platform.yml

@@ -1,4 +1,4 @@
-name: Test Platform V4
+name: 🚉 Unit test Platform
 
 on:
   pull_request:
@@ -43,4 +43,4 @@ jobs:
       - name: Run tests
         run: |
           pip install nox
-          nox -f .github/scripts/noxfile.py -s tests --python ${{ matrix.python_version }}
+          nox -f .github/scripts/noxfile.py -s unit_test_platform --python ${{ matrix.python_version }}

.pre-commit-config.yaml

@@ -39,7 +39,7 @@ repos:
             "--ignore-words-list=VAI,MIS,shs,gard,te,commun,parana,ro,zar,vie,hel,jewl,zlot,ba,buil,coo,ether,hist,hsi,mape,navagation,operatio,pres,ser,yeld,shold,ist,varian,datas,ake,creat,statics,ket,toke,certi,buidl,ot,fo",
             "--quiet-level=2",
             "--skip=./**/tests/**,./**/test_*.py,.git,*.css,*.csv,*.html,*.ini,*.ipynb,*.js,*.json,*.lock,*.scss,*.txt,*.yaml,build/pyinstaller/*,./website/config.toml",
-            "-x=.github/workflows/linting.yml"
+            "-x=.github/workflows/general-linting.yml"
           ]
   - repo: local
     hooks:

cli/openbb_cli/config/menu_text.py

@@ -106,20 +106,6 @@ def add_raw(self, text: str, left_spacing: bool = False):
         else:
             self.menu_text += text
 
-    def add_section(
-        self, text: str, description: str = "", leading_new_line: bool = False
-    ):
-        """Append raw text (without translation)."""
-        spacing = (self.CMD_NAME_LENGTH - len(text) + self.SECTION_SPACING) * " "
-        if description:
-            text = f"{text}{spacing}{description}\n"
-
-        if leading_new_line:
-            self.menu_text += "\n" + text
-
-        else:
-            self.menu_text += text
-
     def add_info(self, text: str):
         """Append information text (after translation)."""
         self.menu_text += f"[info]{text}:[/info]\n"