smart-tests-cli 2.5.2__tar.gz → 2.6.0__tar.gz

{smart_tests_cli-2.5.2 → smart_tests_cli-2.6.0}/.github/workflows/test.yml

@@ -10,10 +10,12 @@ on:
     paths-ignore:
       - "WORKSPACE"
       - "src/**"
+      - "smart_tests/docs/**"
   pull_request:
     paths-ignore:
       - "WORKSPACE"
       - "src/**"
+      - "smart_tests/docs/**"
   schedule:
     # This job runs at 00:00 JST every day.
     - cron: "0 9 * * *"

{smart_tests_cli-2.5.2 → smart_tests_cli-2.6.0}/.pre-commit-config.yaml

@@ -3,6 +3,7 @@ repos:
     rev: v4.0.1
     hooks:
     - id: end-of-file-fixer
+      exclude: ^smart_tests/docs/
 
   - repo: https://github.com/PyCQA/flake8
     rev: 7.0.0

{smart_tests_cli-2.5.2/smart_tests_cli.egg-info → smart_tests_cli-2.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: smart-tests-cli
-Version: 2.5.2
+Version: 2.6.0
 Summary: Smart Tests CLI
 Author-email: CloudBees <support@cloudbees.com>
 License: Apache Software License v2
@@ -21,6 +21,8 @@ Requires-Dist: tabulate>=0.9
 Requires-Dist: click<8.2,>=8.1
 Dynamic: license-file
 
+This is a CLI to interact with CloudBees Smart Tests.
+
 # Usage
 
 See https://help.launchableinc.com/resources/cli-reference/ and
@@ -112,6 +114,13 @@ uv add some-package
 uv add --dev some-dev-package
 ```
 
+## Adding new command
+`smart_tests/args4p` defines a small command line argument parsing framework for this CLI. See its README.md for
+the capabilities.
+
+`smart_tests/__main__.py` defines the top level commands. Follow the code from there to see where sub-commands
+are registered.
+
 ## Updating Python Version
 
 When updating the Python version requirement, update the following files:
@@ -129,6 +138,21 @@ When updating the Python version requirement, update the following files:
 Create new release on Github, then Github Actions automatically uploads the
 module to PyPI.
 
+## How to update bundled documentation
+
+The product documentation lives in `smart_tests/docs/` and is bundled into the
+distributed package. To pull in the latest from the docsite repository:
+
+```shell
+uv run poe update-docs
+```
+
+Users can extract the bundled docs to the current directory with:
+
+```shell
+smart-tests get docs
+```
+
 ## How to update smart_tests/jar/exe_deploy.jar
 
 ```

{smart_tests_cli-2.5.2 → smart_tests_cli-2.6.0}/README.md

@@ -1,3 +1,5 @@
+This is a CLI to interact with CloudBees Smart Tests.
+
 # Usage
 
 See https://help.launchableinc.com/resources/cli-reference/ and
@@ -89,6 +91,13 @@ uv add some-package
 uv add --dev some-dev-package
 ```
 
+## Adding new command
+`smart_tests/args4p` defines a small command line argument parsing framework for this CLI. See its README.md for
+the capabilities.
+
+`smart_tests/__main__.py` defines the top level commands. Follow the code from there to see where sub-commands
+are registered.
+
 ## Updating Python Version
 
 When updating the Python version requirement, update the following files:
@@ -106,6 +115,21 @@ When updating the Python version requirement, update the following files:
 Create new release on Github, then Github Actions automatically uploads the
 module to PyPI.
 
+## How to update bundled documentation
+
+The product documentation lives in `smart_tests/docs/` and is bundled into the
+distributed package. To pull in the latest from the docsite repository:
+
+```shell
+uv run poe update-docs
+```
+
+Users can extract the bundled docs to the current directory with:
+
+```shell
+smart-tests get docs
+```
+
 ## How to update smart_tests/jar/exe_deploy.jar
 
 ```

{smart_tests_cli-2.5.2 → smart_tests_cli-2.6.0}/pyproject.toml

@@ -52,6 +52,7 @@ lint-warn = "flake8 --count --exit-zero --max-complexity=15 --max-line-length=13
 test = "python -m unittest"
 test-xml = "python -m test-runner"
 type = "mypy smart_tests tests"
+update-docs = "bash scripts/update_docs.sh"
 
 [build-system]
 requires = ["setuptools>=45", "wheel", "setuptools_scm"]
@@ -61,6 +62,6 @@ build-backend = "setuptools.build_meta"
 packages = ["smart_tests"]
 
 [tool.setuptools.package-data]
-smart_tests = ["jar/exe_deploy.jar"]
+smart_tests = ["jar/exe_deploy.jar", "docs/**/*"]
 
 [tool.setuptools_scm]

smart_tests_cli-2.6.0/scripts/update_docs.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+# Fetch the latest docs from the docsite repository into smart_tests/docs/.
+# Run via: uv run poe update-docs
+set -euo pipefail
+
+REPO="git@github.com:cloudbees/docsite-cloudbees-smart-tests.git"
+DOCS_DST="$(dirname "$0")/../smart_tests/docs"
+
+tmpdir=$(mktemp -d)
+trap 'rm -rf "$tmpdir"' EXIT
+
+git clone --depth=1 "$REPO" "$tmpdir"
+rm -rf "$DOCS_DST"
+cp -r "$tmpdir/docs" "$DOCS_DST"
+echo "Docs updated at $DOCS_DST"

{smart_tests_cli-2.5.2 → smart_tests_cli-2.6.0}/smart_tests/__main__.py

@@ -9,6 +9,7 @@ from smart_tests.args4p.command import Group
 from smart_tests.commands.compare import compare
 from smart_tests.commands.detect_flakes import detect_flakes
 from smart_tests.commands.gate import gate
+from smart_tests.commands.get import get
 from smart_tests.commands.inspect import inspect
 from smart_tests.commands.record import record
 from smart_tests.commands.stats import stats
@@ -25,6 +26,7 @@ cli.add_command(stats)
 cli.add_command(compare)
 cli.add_command(detect_flakes)
 cli.add_command(gate)
+cli.add_command(get)
 
 
 def _load_test_runners():

smart_tests_cli-2.6.0/smart_tests/commands/get/__init__.py

@@ -0,0 +1,11 @@
+from ... import args4p
+from ...app import Application
+from .docs import docs
+
+
+@args4p.group(help="Retrieve resources")
+def get(app: Application):
+    return app
+
+
+get.add_command(docs)

smart_tests_cli-2.6.0/smart_tests/commands/get/docs.py

@@ -0,0 +1,27 @@
+import importlib.resources
+import shutil
+import sys
+from pathlib import Path
+
+import click
+
+from ... import args4p
+from ...app import Application
+
+OUTPUT_DIR = 'smart-tests-docs'
+
+
+@args4p.command(help="Copy product documentation into ./smart-tests-docs")
+def docs(app: Application):
+    output = Path(OUTPUT_DIR)
+    if output.exists():
+        click.secho(
+            f"'{OUTPUT_DIR}' already exists. Please delete it first, then re-run this command.",
+            fg='red', err=True,
+        )
+        sys.exit(1)
+
+    docs_src = Path(str(importlib.resources.files('smart_tests') / 'docs'))
+    click.echo(f"Copying docs to ./{OUTPUT_DIR} ...")
+    shutil.copytree(docs_src, output)
+    click.echo(f"Done. Documentation is in ./{OUTPUT_DIR}")

{smart_tests_cli-2.5.2 → smart_tests_cli-2.6.0}/smart_tests/commands/record/tests.py

@@ -260,7 +260,56 @@ class RecordTests:
         for t in glob.iglob(os.path.join(base, pattern), recursive=True):
             self.report(t)
 
+    def upload_raw_file(self, file_path: str) -> bool:
+
+        try:
+            # Debug: verify we're using the right code
+            self.logger.debug("Using updated upload_raw_file method")
+
+            # Build the full URL with /intake prefix
+            path = f"/intake/organizations/{self.org}/workspaces/{self.workspace}/{self.session.subpath('test_result_file')}"
+            url = f"{self.client.base_url()}{path}"
+
+            with open(file_path, 'rb') as f:
+                files = {'file': (os.path.basename(file_path), f)}
+                headers = self.client.http_client._headers(compress=False)
+                # Remove Content-Type header to let requests set it for multipart
+                headers.pop('Content-Type', None)
+
+                response = self.client.http_client.session.request(
+                    'POST',
+                    url,
+                    files=files,
+                    headers=headers,
+                    timeout=(5, 60),
+                    verify=(not self.client.http_client.skip_cert_verification)
+                )
+
+                if response.status_code == 200:
+                    self.logger.debug(f"Uploaded raw test result file: {file_path}")
+                    return True
+                else:
+                    self.logger.warning(
+                        f"Failed to upload raw test result file {file_path}: "
+                        f"HTTP {response.status_code} - {response.reason}"
+                    )
+                    return False
+
+        except Exception as e:
+            self.logger.warning(f"Error uploading raw test result file {file_path}: {str(e)}")
+            return False
+
+    def upload_raw_files(self) -> None:
+
+        if self.reports and not self.dry_run:
+            self.logger.debug(f"Uploading {len(self.reports)} raw test result file(s)")
+            for report_file in self.reports:
+                self.upload_raw_file(report_file)
+
     def run(self):
+        # Upload raw test result files before parsing
+        self.upload_raw_files()
+
         count = 0  # count number of test cases sent
         is_observation = False
 

smart_tests_cli-2.6.0/smart_tests/docs/antora.yml

@@ -0,0 +1,14 @@
+name: cloudbees-smart-tests
+title: CloudBees Smart Tests
+version: latest
+start_page: ROOT:index.adoc
+nav:
+  - modules/ROOT/nav.adoc
+asciidoc:
+  attributes:
+    sectanchors: ""
+    experimental: ""
+    toc: ""
+    toc-title: On this page
+    toc-placement: manual
+    toclevels: 1@

smart_tests_cli-2.6.0/smart_tests/docs/modules/ROOT/nav.adoc

@@ -0,0 +1,116 @@
+include::ROOT:partial$abbr.adoc[]
+
+* xref:ROOT:index.adoc[Overview]
+
+* xref:send-data-to-smart-tests:send-data-to-smart-tests.adoc[Send data to {PRODUCT}]
+** xref:send-data-to-smart-tests:getting-started/getting-started.adoc[Getting started]
+*** xref:send-data-to-smart-tests:getting-started/use-the-cli-with-a-public-repository.adoc[Use the CLI with a public repository]
+*** xref:send-data-to-smart-tests:getting-started/migration-to-github-oidc-auth.adoc[Update tokenless authentication to use GitHub OIDC]
+*** xref:send-data-to-smart-tests:getting-started/use-the-cli-with-docker-image.adoc[Use the CLI with Docker image]
+** xref:send-data-to-smart-tests:record-builds/record-builds.adoc[Record builds]
+*** xref:send-data-to-smart-tests:record-builds/choose-a-value-for-build-name.adoc[Choose a value for build name]
+*** xref:send-data-to-smart-tests:record-builds/record-builds-from-multiple-repositories.adoc[Record builds from multiple repositories]
+*** xref:send-data-to-smart-tests:record-builds/run-under-restricted-networks.adoc[Run under restricted networks]
+*** xref:send-data-to-smart-tests:record-builds/deal-with-shallow-clones.adoc[Deal with shallow clones]
+** xref:send-data-to-smart-tests:record-sessions/record-sessions.adoc[Record sessions]
+** xref:send-data-to-smart-tests:subset/subset-predictive-test-selection.adoc[Subset for Predictive test selection]
+** xref:send-data-to-smart-tests:record-test-results/record-test-results.adoc[Record test results]
+*** xref:send-data-to-smart-tests:record-test-results/convert-test-reports-to-junit-format.adoc[Convert test reports to JUnit format]
+*** xref:send-data-to-smart-tests:record-test-results/ensure-record-tests-always-runs.adoc[Ensure record tests always runs]
+*** xref:send-data-to-smart-tests:record-test-results/manage-complex-test-session-layouts.adoc[Manage complex test session layouts]
+*** xref:send-data-to-smart-tests:record-test-results/use-flavors-to-run-the-best-tests-for-an-environment.adoc[Use 'flavors' to run the best tests for an environment]
+*** xref:send-data-to-smart-tests:record-test-results/separate-out-test-suites.adoc[Separate out test suites]
+*** xref:send-data-to-smart-tests:record-test-results/attach-log-files.adoc[Attach log files]
+
+.Features
+* xref:features:intelligent-test-failure-diagnostics.adoc[Intelligent Test Failure Diagnostics]
+* xref:features:predictive-test-selection.adoc[Predictive Test Selection]
+** xref:features:predictive-test-selection/use-cases-for-predictive-test-selection.adoc[Use cases for Predictive Test Selection]
+** xref:features:predictive-test-selection/observe-subset-behavior.adoc[Observe subset behavior]
+** xref:features:predictive-test-selection/request-and-run-a-subset-of-tests/request-and-run-a-subset-of-tests.adoc[Request and run a subset of tests]
+*** xref:features:predictive-test-selection/request-and-run-a-subset-of-tests/choose-a-subset-optimization-target/choose-a-subset-optimization-target.adoc[Choose a subset optimization target]
+*** xref:features:predictive-test-selection/request-and-run-a-subset-of-tests/subset-with-the-smart-tests-cli/subset-with-the-smart-tests-cli.adoc[Subset with the CLI]
+*** xref:features:predictive-test-selection/request-and-run-a-subset-of-tests/choose-a-subset-optimization-target/smart-subset-optimization-target.adoc[Smart subset optimization targets]
+*** xref:features:predictive-test-selection/request-and-run-a-subset-of-tests/subset-with-the-smart-tests-cli/combine-with-rule-based-test-selection.adoc[Combine with rule-based test selection]
+*** xref:features:predictive-test-selection/request-and-run-a-subset-of-tests/subset-with-the-smart-tests-cli/replace-static-parallel-suites-dynamic-parallel-subset.adoc[Replace static parallel suites with a dynamic parallel subset]
+*** xref:features:predictive-test-selection/request-and-run-a-subset-of-tests/subset-with-the-smart-tests-cli/zero-input-subsetting/zero-input-subsetting.adoc[Zero Input Subsetting]
+*** xref:features:predictive-test-selection/request-and-run-a-subset-of-tests/subset-with-the-smart-tests-cli/zero-input-subsetting/use-groups-to-split-subsets.adoc[Use groups to split subsets]
+** xref:features:predictive-test-selection/smart-tests-extension-for-VS-code.adoc[{PRODUCT} extension for VS code]
+** xref:features:predictive-test-selection/viewing-time-savings.adoc[View time savings]
+** xref:features:predictive-test-selection/how-we-select-tests.adoc[How we select tests]
+** xref:features:predictive-test-selection/faq.adoc[FAQ]
+* xref:features:trends.adoc[Test Suite Trends]
+* xref:features:unhealthy-tests.adoc[Unhealthy Test Insights]
+* xref:features:test-results-and-reports.adoc[Test Reports]
+* xref:features:test-suite-parallelization.adoc[Test Suite Parallelization]
+** xref:features:test-suite-parallelization/parallelize-your-test-suite-with-the-smart-tests-cli.adoc[Parallelize your test suite with the {PRODUCT} CLI]
+* xref:features:test-notifications.adoc[Test Notifications]
+** xref:features:test-notifications/github-app-for-test-sessions.adoc[Github app for test sessions]
+** xref:features:test-notifications/test-notifications-via-slack.adoc[Test Notifications via Slack]
+
+.Concepts
+* xref:concepts:object-model.adoc[Object model]
+* xref:concepts:organization.adoc[Organization]
+* xref:concepts:workspace.adoc[Workspace]
+* xref:concepts:build.adoc[Build]
+* xref:concepts:test-session.adoc[Test Session]
+* xref:concepts:subset.adoc[Subset]
+* xref:concepts:insight.adoc[Insight]
+* xref:concepts:branch.adoc[Branch]
+* xref:concepts:test-suite.adoc[Test Suite]
+
+.Resources
+* xref:resources:onboarding-guide.adoc[{PRODUCT} Onboarding guide]
+* xref:resources:cli-reference.adoc[CLI reference]
+* xref:resources:integrations.adoc[Integrations]
+** xref:resources:integrations/adb.adoc[Android Debug Bridge (adb)]
+** xref:resources:integrations/ant.adoc[Ant]
+** xref:resources:integrations/bazel.adoc[Bazel]
+** xref:resources:integrations/behave.adoc[Behave]
+** xref:resources:integrations/ctest.adoc[CTest]
+** xref:resources:integrations/cucumber.adoc[cucumber]
+** xref:resources:integrations/cypress.adoc[Cypress]
+** xref:resources:integrations/dotnet-test.adoc[dotnet test]
+** xref:resources:integrations/use-the-generic-file-based-runner-integration.adoc['file' profile for unsupported test runners]
+** xref:resources:integrations/go-test.adoc[Go Test]
+** xref:resources:integrations/googletest.adoc[GoogleTest]
+** xref:resources:integrations/gradle.adoc[Gradle]
+** xref:resources:integrations/jest.adoc[Jest]
+** xref:resources:integrations/karma.adoc[Karma]
+** xref:resources:integrations/maven.adoc[Maven]
+** xref:resources:integrations/minitest.adoc[minitest]
+** xref:resources:integrations/playwright.adoc[Playwright]
+** xref:resources:integrations/prove.adoc[prove for Perl]
+** xref:resources:integrations/pytest.adoc[pytest]
+** xref:resources:integrations/raw.adoc['raw' profile for custom test runners]
+** xref:resources:integrations/robot.adoc[Robot]
+** xref:resources:integrations/rspec.adoc[RSpec]
+* xref:resources:supported-languages.adoc[Supported languages]
+** xref:resources:supported-languages/c-plus-plus.adoc[C++]
+** xref:resources:supported-languages/dotnet.adoc[.NET]
+** xref:resources:supported-languages/go.adoc[Go]
+** xref:resources:supported-languages/java.adoc[Java]
+** xref:resources:supported-languages/javascript.adoc[JavaScript]
+** xref:resources:supported-languages/perl.adoc[Perl]
+** xref:resources:supported-languages/python.adoc[Python]
+** xref:resources:supported-languages/ruby.adoc[Ruby]
+* xref:resources:supported-test-frameworks.adoc[Supported test frameworks]
+** xref:resources:supported-test-frameworks/appium.adoc[Appium]
+** xref:resources:supported-test-frameworks/cucumber.adoc[Cucumber]
+** xref:resources:supported-test-frameworks/googletest.adoc[GoogleTest]
+** xref:resources:supported-test-frameworks/jest.adoc[Jest]
+** xref:resources:supported-test-frameworks/junit.adoc[JUnit]
+** xref:resources:supported-test-frameworks/minitest.adoc[minitest]
+** xref:resources:supported-test-frameworks/nunit.adoc[NUnit]
+** xref:resources:supported-test-frameworks/prove.adoc[prove for Perl]
+** xref:resources:supported-test-frameworks/robot.adoc[Robot]
+** xref:resources:supported-test-frameworks/rspec.adoc[RSpec]
+** xref:resources:supported-test-frameworks/selenium.adoc[Selenium]
+** xref:resources:supported-test-frameworks/testng.adoc[TestNG]
+* xref:resources:ci-tool-integrations.adoc[CI tool integrations]
+** xref:resources:ci-tool-integrations/github-actions.adoc[GitHub Actions]
+* xref:resources:policies.adoc[Policies]
+** xref:resources:policies/data-privacy-and-protection.adoc[Data privacy and protection]
+** xref:resources:policies/data-examples.adoc[Data examples]
+** xref:resources:policies/security-policies.adoc[Security policies]
+* xref:resources:troubleshooting.adoc[Troubleshoot]

smart_tests_cli-2.6.0/smart_tests/docs/modules/ROOT/pages/getting-started.adoc

@@ -0,0 +1,9 @@
+include::ROOT:partial$abbr.adoc[]
+:slug: getting-started
+= Getting Started
+
+After reviewing the xref:ROOT:index.adoc[Product Overview], you can sign up for a {PRODUCT} account at https://app.launchableinc.com/signup[https://app.launchableinc.com/signup].
+
+After creating your user account and verifying your email address (if necessary), you'll be prompted to create an xref:concepts:organization.adoc[Organization].or your company and a xref:concepts:workspace.adoc[Workspace].or your test suite.
+
+Then you can start sending data. For more information, refer to xref:send-data-to-smart-tests:send-data-to-smart-tests.adoc[Send data to {PRODUCT}].