Merge pull request #3 from infactory-io/tech-1578-infactory-end-to-end-testing-for-cli

basic cli implemented

Author: closedLoop

.flake8

@@ -0,0 +1,11 @@
+[flake8]
+max-line-length = 120
+max-complexity = 18
+select = B,C,E,F,W,T4,B9
+ignore = E203, E266, E501, W503, F403, E743, E741
+exclude =
+    # list of ignores
+    .git,
+    __pycache__,
+    .pytest_cache,
+    .vscode

.gitattributes

@@ -0,0 +1,2 @@
+*.cql filter=lfs diff=lfs merge=lfs -text
+*.csv filter=lfs diff=lfs merge=lfs -text

.github/workflows/pypi.yml

@@ -16,24 +16,24 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      
+
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
           python-version: '3.11'
-      
+
       - name: Install Poetry
         run: |
           curl -sSL https://install.python-poetry.org | python3 -
           poetry --version
-      
+
       - name: Install dependencies
         run: poetry install --only main
-      
+
       - name: Build package
         run: poetry build
-      
+
       - name: Publish to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
-          packages-dir: dist/ 
+          packages-dir: dist/

.github/workflows/python.yml

@@ -3,29 +3,41 @@
 #
 # ref: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
 
-name: openapi_client Python package
+name: Python Tests
 
 on: [push, pull_request]
 
 jobs:
-  build:
-
+  test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.10", "3.11", "3.12"]
 
     steps:
       - uses: actions/checkout@v4
+
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
+
+      - name: Install Poetry
+        run: |
+          curl -sSL https://install.python-poetry.org | python3 -
+
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install -r requirements.txt
-          pip install -r test-requirements.txt
-      - name: Test with pytest
+          poetry install
+
+      - name: Run tests with coverage
         run: |
-          pytest --cov={{packageName}}
+          poetry run coverage run -m pytest
+          poetry run coverage report -m
+          poetry run coverage html
+
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v3
+        with:
+          name: coverage-report
+          path: htmlcov/

.isort.cfg

@@ -0,0 +1,7 @@
+[settings]
+line_length = 88
+multi_line_output = 3
+include_trailing_comma = True
+force_grid_wrap = 0
+use_parentheses = True
+ensure_newline_before_comments = True

.pre-commit-config.yaml

@@ -0,0 +1,60 @@
+minimum_pre_commit_version: '2.9.0'
+repos:
+ - repo: https://github.com/pre-commit/pre-commit-hooks
+   rev: v4.6.0
+   hooks:
+   - id: trailing-whitespace
+   - id: end-of-file-fixer
+   - id: mixed-line-ending
+     args: ['--fix=lf']
+   - id: check-added-large-files
+     args: ['--maxkb=30000']
+  #  - id: no-commit-to-branch
+ - repo: https://github.com/asottile/pyupgrade
+   rev: v3.17.0
+   hooks:
+   - id: pyupgrade
+     args: [--py311-plus]
+     files: \.py$
+ - repo: https://github.com/PyCQA/isort
+   rev: 5.13.2
+   hooks:
+   - id: isort
+ - repo: https://github.com/ambv/black
+   rev: 24.8.0
+   hooks:
+   - id: black
+#  - repo: https://github.com/myint/eradicate
+#    rev: v2.1.0
+#    hooks:
+#    - id: eradicate
+ - repo: https://github.com/PyCQA/flake8
+   rev: 7.1.1
+   hooks:
+   - id: flake8
+#  - repo: local
+#    hooks:
+#    - id: vulture
+#      name: vulture
+#      description: Find dead Python code
+#      entry: vulture
+#      args: ["--min-confidence", "80", "--exclude", "env,examples/human_eval,examples/leetcode_results", "."]
+#      language: system
+#      types: [python]
+ - repo: https://github.com/PyCQA/autoflake
+   rev: v2.3.1
+   hooks:
+   - id: autoflake
+     args: [--in-place, --remove-all-unused-imports, --remove-unused-variables]
+     types_or: [python, pyi]
+#  - repo: https://github.com/adamchainz/blacken-docs
+#    rev: 1.18.0
+#    hooks:
+#    - id: blacken-docs
+#      additional_dependencies:
+#      - black
+ - repo: https://github.com/gitleaks/gitleaks
+   rev: v8.20.0
+   hooks:
+   - id: gitleaks
+exclude: '^(frontends/.*|infactory/connectors/.*|infactory/storage/core_schema\.py|infactory/storage/schema\.py|infactory/storage/_static/.*|infactory/embeddings\.py)$'

README-tests.md

@@ -20,11 +20,11 @@ def test_projects_list(mocker):
     # Mock the HTTP response
     mock_response = [{"id": "proj-123", "name": "Test Project", "team_id": "team-456"}]
     mock_get = mocker.patch("infactory_client.client.Client._get", return_value=mock_response)
-    
+
     # Create client and call the method
     client = Client(api_key="test_key")
     projects = client.projects.list(team_id="team-456")
-    
+
     # Assertions
     mock_get.assert_called_once_with("v1/projects", {"team_id": "team-456"})
     assert len(projects) == 1
@@ -43,11 +43,11 @@ def test_projects_list_command(mocker):
     mock_client = MagicMock()
     mock_client.projects.list.return_value = mock_projects
     mocker.patch("infactory_cli.get_client", return_value=mock_client)
-    
+
     # Call the CLI command handler
     args = MagicMock(team_id="team-456")
     handle_projects_list(args)
-    
+
     # Assertions
     mock_client.projects.list.assert_called_once_with(team_id="team-456")
 ```
@@ -69,12 +69,12 @@ def test_create_and_publish_query_program(requests_mock):
     # Mock API responses
     requests_mock.post("https://api.infactory.ai/v1/queryprograms", json={"id": "qp-123", "name": "Test Query"})
     requests_mock.patch("https://api.infactory.ai/v1/queryprograms/qp-123/publish", json={"id": "qp-123", "published": True})
-    
+
     # Execute the workflow
     client = Client(api_key="test_key")
     query = client.query_programs.create(name="Test Query", dataline_id="dl-456", code="test code")
     published = client.query_programs.publish(query.id)
-    
+
     # Assertions
     assert published.id == "qp-123"
     assert published.published is True
@@ -93,7 +93,7 @@ Record actual API responses and replay them in tests:
 def test_list_projects():
     client = Client(api_key="test_key")
     projects = client.projects.list(team_id="team-456")
-    
+
     assert len(projects) > 0
     assert projects[0].id is not None
 ```
@@ -112,19 +112,19 @@ E2E tests validate complete user workflows against the actual API:
 def test_e2e_datasource_workflow():
     # Use a test API key from environment variable
     client = Client(api_key=os.environ.get("NF_TEST_API_KEY"))
-    
+
     # Create a project
     project = client.projects.create(name="Test Project", team_id=os.environ.get("NF_TEST_TEAM_ID"))
-    
+
     # Create a datasource
     datasource = client.datasources.create(name="Test DB", project_id=project.id, type="postgres")
-    
+
     # List datasources
     datasources = client.datasources.list(project_id=project.id)
-    
+
     # Assertions
     assert any(ds.id == datasource.id for ds in datasources)
-    
+
     # Clean up
     client.datasources.delete(datasource.id)
     client.projects.delete(project.id)
@@ -142,7 +142,7 @@ def test_cli_e2e():
         capture_output=True, text=True
     )
     assert "API key saved successfully" in result.stdout
-    
+
     result = subprocess.run(
         ["nf", "projects", "list", "--team-id", os.environ.get("NF_TEST_TEAM_ID")],
         capture_output=True, text=True

README.md

@@ -223,7 +223,7 @@ query_program = client.query_programs.create(
     question="What are the monthly sales by region?",
     code="""
     import pandas as pd
-    
+
     def execute(df):
         # Group by month and region, sum sales
         result = df.groupby(['month', 'region'])['sales'].sum().reset_index()

examples.py

@@ -5,24 +5,33 @@
 from infactory_client.client import InfactoryClient
 
 
-def create_api_for_user():  
+def create_api_for_user():
     nf = InfactoryClient()
-    nf.login() # This should open a browser window to login via Clerk and return with the JWT token
+    nf.login()  # This should open a browser window to login via Clerk and return with the JWT token
     # optionally
-    nf.connect() # This should connect to the Infactory API using the API Key to generate the JWT token
+    nf.connect()  # This should connect to the Infactory API using the API Key to generate the JWT token
 
     # The account creation should also run to create a default organization, team, user and project and set it to the state of the client
     state = nf.state
     print(state)
 
     # The state serve as the default parameters for all requests
 
-    nf.upload("data/test.csv") # This should upload the file to the default project and create a dataline
-    nf.explore(n=10) # This should generate 10 random questions and answers about the data - stored as query programs
-    nf.query_programs.publish(all=True, public=True) # This should publish all query programs publicly
-    print(nf.query_programs()) # This should list all query programs
-    print(nf.project.docs.endpoint()) # This should return the project docs endpoint
-    print(nf.project.docs.as_tools()) # Format the docs as tools to be used in a LLM chain
+    nf.upload(
+        "data/test.csv"
+    )  # This should upload the file to the default project and create a dataline
+    nf.explore(
+        n=10
+    )  # This should generate 10 random questions and answers about the data - stored as query programs
+    nf.query_programs.publish(
+        all=True, public=True
+    )  # This should publish all query programs publicly
+    print(nf.query_programs())  # This should list all query programs
+    print(nf.project.docs.endpoint())  # This should return the project docs endpoint
+    print(
+        nf.project.docs.as_tools()
+    )  # Format the docs as tools to be used in a LLM chain
+
 
 def ask_questions_of_a_dataset():
     nf = InfactoryClient()