neoload 1.3.19.dev2__tar.gz → 1.3.19.dev3__tar.gz

{neoload-1.3.19.dev2/neoload.egg-info → neoload-1.3.19.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: neoload
-Version: 1.3.19.dev2
+Version: 1.3.19.dev3
 Summary: A command-line native utility for launching and observing NeoLoad performance tests
 Home-page: https://github.com/Neotys-Labs/neoload-cli
 Author: Neotys
@@ -13,6 +13,7 @@ Requires-Dist: pyconfig
 Requires-Dist: appdirs
 Requires-Dist: requests>=2.25.1
 Requires-Dist: jsonschema
+Requires-Dist: regex
 Requires-Dist: PyYAML>=5
 Requires-Dist: junit_xml
 Requires-Dist: termcolor
@@ -28,6 +29,8 @@ Requires-Dist: pyparsing
 Requires-Dist: simplejson
 Requires-Dist: colorama
 Requires-Dist: importlib-resources
+Requires-Dist: cryptography>=40
+Requires-Dist: asn1crypto>=1.5
 Dynamic: author
 Dynamic: description
 Dynamic: description-content-type
@@ -227,10 +230,12 @@ neoload checkvu default.yaml
 neoload checkvu -u myUser default.yaml
 ```
  - `PROJECT_FILE` is a path to an as-code yaml file. The CLI validates it against the as-code schema first (same as `neoload validate`), using `-s, --as-code-schema` to override the default schema.
- - `-e, --engine-jar <path-or-url>` resolves the CheckVU JAR: a local file path or a download URL. If omitted, a previously cached JAR is reused, otherwise a default URL is used to download the latest JAR.
- - `-j, --java` selects the java executable; by default `JAVA_HOME/bin/java` then `java` on the PATH. Java 21+ is required and verified before running.
+ - `--play-think-time` plays think times defined on pages and delays marked as think time. Disabled by default (same as the CheckVU advanced setting).
+ - `-e, --engine-jar, --jar <path-or-url>` skips the JAR resolution below and runs a local patched file (hotfix) or an explicit download URL. If omitted: reuse the single cached JAR if one exists (no network call); otherwise detect the OS, call `redirect.php` (`version=latest`), follow the 302 to `files.tricentis.com`, and cache the JAR under the filename from the final `Content-Disposition` (e.g. `neoload-checkvu-cli-2026.3.0-linux.jar`). Clear the cache directory to force a fresh download after a new CheckVU release.
+ - `-j, --java` selects the java executable; by default `JAVA_HOME/bin/java` then `java` on the PATH. Java 21+ is required and verified before running. The JAR is launched with `-XX:TieredStopAtLevel=1 -Xms256m -Xmx512m -XX:+UseSerialGC` to keep startup short, and `JAVA_TOOL_OPTIONS` is emptied for that process so these options always apply and do not reach the Load Generator it spawns. Prefer a JDK over JRE so that the CLI can check the JAR's integrity, or bypass checks using `--unsafe-skip-jar-verification`
+ - `-o, --output <path>` sets the directory that receives `checkvu-result.json` and the `checkvu-content/` request and response dump. When omitted, nothing is written to disk and only the console output is produced. Relative paths resolve from the current directory, not from `PROJECT_FILE`. The dump is not redacted, so treat it as confidential.
  - `-w, --work-dir <path>` sets the directory used for engine files and logs. Defaults to a temporary directory deleted afterwards unless `--keep-temp-work-dir` is set; a directory you supply yourself is never deleted.
- - `--app-proxy`, `--app-proxy-username` and `--app-proxy-bypass` configure the proxy used for application traffic. The proxy password is set with `NEOLOAD_CHECK_VU_APP_PROXY_PASSWORD` environment variable instead so it never shows up in the process list or CI logs.
+ - `--app-proxy`, `--app-proxy-username` and `--app-proxy-bypass` configure the proxy used for application traffic. The proxy password is set with `CHECKVU_CLI_APP_PROXY_PASSWORD` environment variable instead so it never shows up in the process list or CI logs.
  - `--controller-properties` and `--load-generator-properties` are advanced options to merge a `.properties` file into the JAR's embedded `controller.properties` / `agent.properties`.
 
 ## Reporting
@@ -418,9 +423,14 @@ The configuration lets you customize the CLI's behavior. For now, it is only use
 
 ### As-Code Demo Project
 
-[`examples/as-code-demo`](examples/as-code-demo) contains a NeoLoad As-Code YAML project that works out-of-the-box:
-no NeoLoad Web project, no manual scenario setup - just point NeoLoad at
-[`default.yaml`](examples/as-code-demo/default.yaml) and run.
+Create a starter NeoLoad As-Code YAML project with:
+
+```
+neoload project create DemoWebShop
+```
+
+This scaffolds `DemoWebShop/default.yaml` from the bundled Demo Web Shop template —
+no NeoLoad Web project, no manual scenario setup.
 
 Target: [Tricentis Demo Web Shop](https://demowebshop.tricentis.com/) (nopCommerce demo).
 
@@ -437,14 +447,16 @@ It uses two variables (`product_id`, `quantity`) and a single population (`Guest
 
 Run CheckVU against the project:
 ```
-neoload checkvu examples/as-code-demo/default.yaml
+neoload project create DemoWebShop
+neoload checkvu DemoWebShop/default.yaml
 ```
 
 Run the full test:
 ```
+neoload project create DemoWebShop
 neoload login $NLW_TOKEN \
      test-settings --zone defaultzone --lgs 1 createorpatch DemoWebShopTest \
-     project --path examples/as-code-demo/default.yaml upload DemoWebShopTest \
+     project --path DemoWebShop/default.yaml upload DemoWebShopTest \
      run --scenario DemoWebShop
 ```
 

neoload-1.3.19.dev2/PKG-INFO → neoload-1.3.19.dev3/README.md

@@ -1,42 +1,3 @@
-Metadata-Version: 2.4
-Name: neoload
-Version: 1.3.19.dev2
-Summary: A command-line native utility for launching and observing NeoLoad performance tests
-Home-page: https://github.com/Neotys-Labs/neoload-cli
-Author: Neotys
-Author-email: 
-License: Apache 2.0
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: click>=7
-Requires-Dist: pyconfig
-Requires-Dist: appdirs
-Requires-Dist: requests>=2.25.1
-Requires-Dist: jsonschema
-Requires-Dist: PyYAML>=5
-Requires-Dist: junit_xml
-Requires-Dist: termcolor
-Requires-Dist: coloredlogs
-Requires-Dist: gitignorefile
-Requires-Dist: jinja2
-Requires-Dist: python-dateutil
-Requires-Dist: tqdm
-Requires-Dist: requests_toolbelt
-Requires-Dist: urllib3>=1.26.5
-Requires-Dist: docker
-Requires-Dist: pyparsing
-Requires-Dist: simplejson
-Requires-Dist: colorama
-Requires-Dist: importlib-resources
-Dynamic: author
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license
-Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: summary
-
 # NeoLoad CLI [![Python package](https://github.com/Neotys-Labs/neoload-cli/actions/workflows/python-package.yml/badge.svg?branch=master)](https://github.com/Neotys-Labs/neoload-cli/actions/workflows/python-package.yml)
 
 ## Overview
@@ -227,10 +188,12 @@ neoload checkvu default.yaml
 neoload checkvu -u myUser default.yaml
 ```
  - `PROJECT_FILE` is a path to an as-code yaml file. The CLI validates it against the as-code schema first (same as `neoload validate`), using `-s, --as-code-schema` to override the default schema.
- - `-e, --engine-jar <path-or-url>` resolves the CheckVU JAR: a local file path or a download URL. If omitted, a previously cached JAR is reused, otherwise a default URL is used to download the latest JAR.
- - `-j, --java` selects the java executable; by default `JAVA_HOME/bin/java` then `java` on the PATH. Java 21+ is required and verified before running.
+ - `--play-think-time` plays think times defined on pages and delays marked as think time. Disabled by default (same as the CheckVU advanced setting).
+ - `-e, --engine-jar, --jar <path-or-url>` skips the JAR resolution below and runs a local patched file (hotfix) or an explicit download URL. If omitted: reuse the single cached JAR if one exists (no network call); otherwise detect the OS, call `redirect.php` (`version=latest`), follow the 302 to `files.tricentis.com`, and cache the JAR under the filename from the final `Content-Disposition` (e.g. `neoload-checkvu-cli-2026.3.0-linux.jar`). Clear the cache directory to force a fresh download after a new CheckVU release.
+ - `-j, --java` selects the java executable; by default `JAVA_HOME/bin/java` then `java` on the PATH. Java 21+ is required and verified before running. The JAR is launched with `-XX:TieredStopAtLevel=1 -Xms256m -Xmx512m -XX:+UseSerialGC` to keep startup short, and `JAVA_TOOL_OPTIONS` is emptied for that process so these options always apply and do not reach the Load Generator it spawns. Prefer a JDK over JRE so that the CLI can check the JAR's integrity, or bypass checks using `--unsafe-skip-jar-verification`
+ - `-o, --output <path>` sets the directory that receives `checkvu-result.json` and the `checkvu-content/` request and response dump. When omitted, nothing is written to disk and only the console output is produced. Relative paths resolve from the current directory, not from `PROJECT_FILE`. The dump is not redacted, so treat it as confidential.
  - `-w, --work-dir <path>` sets the directory used for engine files and logs. Defaults to a temporary directory deleted afterwards unless `--keep-temp-work-dir` is set; a directory you supply yourself is never deleted.
- - `--app-proxy`, `--app-proxy-username` and `--app-proxy-bypass` configure the proxy used for application traffic. The proxy password is set with `NEOLOAD_CHECK_VU_APP_PROXY_PASSWORD` environment variable instead so it never shows up in the process list or CI logs.
+ - `--app-proxy`, `--app-proxy-username` and `--app-proxy-bypass` configure the proxy used for application traffic. The proxy password is set with `CHECKVU_CLI_APP_PROXY_PASSWORD` environment variable instead so it never shows up in the process list or CI logs.
  - `--controller-properties` and `--load-generator-properties` are advanced options to merge a `.properties` file into the JAR's embedded `controller.properties` / `agent.properties`.
 
 ## Reporting
@@ -418,9 +381,14 @@ The configuration lets you customize the CLI's behavior. For now, it is only use
 
 ### As-Code Demo Project
 
-[`examples/as-code-demo`](examples/as-code-demo) contains a NeoLoad As-Code YAML project that works out-of-the-box:
-no NeoLoad Web project, no manual scenario setup - just point NeoLoad at
-[`default.yaml`](examples/as-code-demo/default.yaml) and run.
+Create a starter NeoLoad As-Code YAML project with:
+
+```
+neoload project create DemoWebShop
+```
+
+This scaffolds `DemoWebShop/default.yaml` from the bundled Demo Web Shop template —
+no NeoLoad Web project, no manual scenario setup.
 
 Target: [Tricentis Demo Web Shop](https://demowebshop.tricentis.com/) (nopCommerce demo).
 
@@ -437,14 +405,16 @@ It uses two variables (`product_id`, `quantity`) and a single population (`Guest
 
 Run CheckVU against the project:
 ```
-neoload checkvu examples/as-code-demo/default.yaml
+neoload project create DemoWebShop
+neoload checkvu DemoWebShop/default.yaml
 ```
 
 Run the full test:
 ```
+neoload project create DemoWebShop
 neoload login $NLW_TOKEN \
      test-settings --zone defaultzone --lgs 1 createorpatch DemoWebShopTest \
-     project --path examples/as-code-demo/default.yaml upload DemoWebShopTest \
+     project --path DemoWebShop/default.yaml upload DemoWebShopTest \
      run --scenario DemoWebShop
 ```
 

{neoload-1.3.19.dev2 → neoload-1.3.19.dev3}/neoload/commands/checkvu.py

@@ -5,27 +5,36 @@ import click
 
 from neoload_cli_lib import checkvu_runner, cli_exception
 import neoload_cli_lib.schema_validation as schema_validation
-from neoload_cli_lib.schema_validation import __default_schema_url
 
 __yaml_extensions = (".yaml", ".yml")
 
 @click.command()
-@click.option('-e', '--engine-jar',
-              help="CheckVU engine JAR to run: a local file, for air-gapped or pinned setups, or a download URL. "
-                   "Defaults to the cached JAR, otherwise the release URL for this version.",
+@click.option('-e', '--engine-jar', '--jar',
+              help="Skip the latest-JAR download and run this CheckVU engine: a local patched file "
+                   "(hotfix / air-gapped) or a download URL. If omitted, the latest JAR for this OS "
+                   "is downloaded and cached.",
               metavar="PATH|URL")
 @click.option('-j', '--java', help="Path to the java executable to use. "
                             "Defaults to JAVA_HOME/bin/java, then java on the PATH.", metavar="PATH")
 @click.option('-u', '--user-path', help="Run only the specified user path. If omitted, all user paths in the file "
                                   "are executed sequentially. An unknown name fails and lists the user paths "
                                   "found in the file.", metavar="NAME")
-@click.option('-s', '--as-code-schema', default=__default_schema_url, show_default=True,
-              help="NeoLoad as-code schema (URL or local path) to validate PROJECT_FILE "
-                   "against. Defaults to the schema published for this release on Github.",
+@click.option('--play-think-time', is_flag=True, default=False,
+              help="Play think times defined on pages and delays marked as think time. "
+                   "Disabled by default. Equivalent to setting CHECKVU_CLI_PLAY_THINK_TIME=1.")
+@click.option('-s', '--as-code-schema', default=None,
+              help="NeoLoad as-code schema (URL or local path) to validate PROJECT_FILE against. "
+                   "When omitted, download schemas/v<schemaVersion>/as-code.schema.json from neoload-models (v3). "
+                   "If schemaVersion is absent, use schemas/v3.0/as-code.schema.json.",
               metavar="PATH|URL")
 @click.option('--ssl-cert', default="",
               help="Path to SSL certificate or write False to disable certificate checking. "
                    "Used both for schema validation and the JAR download.")
+@click.option('--unsafe-skip-jar-verification', is_flag=True, default=False,
+              help="Unsafe. Run the CheckVU JAR without checking that it is signed by Tricentis. "
+                   "Intended for development, and for runtimes that ship no jarsigner "
+                   "(jarsigner is in the JDK, not the JRE, and the check requires it) "
+                   "when running a local JAR that has already been verified.")
 @click.option('--controller-properties',
               help="Advanced. Path to controller.properties file merged additively into the Controller "
                    "configuration; only the keys you set are overridden, other embedded values are kept.",
@@ -42,12 +51,18 @@ __yaml_extensions = (".yaml", ".yml")
               metavar="HOST:PORT")
 @click.option('--app-proxy-username',
               help="Username for --app-proxy authentication (optional). The password is read from environment "
-                   "variable NEOLOAD_CHECK_VU_APP_PROXY_PASSWORD; there is no flag for it, so it is never "
+                   "variable CHECKVU_CLI_APP_PROXY_PASSWORD; there is no flag for it, so it is never "
                    "exposed in the process list or CI logs.",
               metavar="USERNAME")
 @click.option('--app-proxy-bypass',
               help="Comma-separated hosts that bypass --app-proxy (e.g. localhost,internal.corp).",
               metavar="HOSTS")
+@click.option('-o', '--output',
+              help="Directory that receives checkvu-result.json and the checkvu-content/ request and response "
+                   "dump. When omitted, nothing is written to disk and the console output is unchanged. "
+                   "Relative paths resolve from the current directory, not from PROJECT_FILE. The dump is not "
+                   "redacted: treat it as confidential.",
+              metavar="PATH")
 @click.option('-w', '--work-dir',
               help="Directory for engine scratch files and logs. Defaults to a temporary directory. "
                    "A directory you supply is never deleted.",
@@ -57,20 +72,24 @@ __yaml_extensions = (".yaml", ".yml")
                    "Equivalent to setting CHECKVU_CLI_KEEP_TEMP_WORK_DIR=1. "
                    "Has no effect when --work-dir is already set, since that directory is never auto-deleted.")
 @click.argument('project_file')
-def cli(engine_jar, java, user_path, as_code_schema, ssl_cert,
+def cli(engine_jar, java, user_path, play_think_time, as_code_schema, ssl_cert, unsafe_skip_jar_verification,
         controller_properties, load_generator_properties,
-        app_proxy, app_proxy_username, app_proxy_bypass, work_dir, keep_temp_work_dir,
+        app_proxy, app_proxy_username, app_proxy_bypass, output, work_dir, keep_temp_work_dir,
         project_file):
     """  Validate the User Paths of a NeoLoad as-code Project locally.
 
     Runs each User Path once against the application and reports whether
     it completes without blocking errors. This is not a load test: no
     Population, no Scenario, no Result. Exits 0 when every User Path passes, 1
-    otherwise, and always writes a JSON output.
+    otherwise. Use --output to also write checkvu-result.json and the full
+    request and response dump to a directory.
 
     PROJECT_FILE is the as-code Project YAML file. Its parent directory is the
     Project root; colocated assets such as CSV files must live under that
     root.
+
+    A java executable is required to run the checkVU. Prefer a JDK over JRE so
+    that the CLI can check the JAR's integrity
     """
     if not project_file.lower().endswith(__yaml_extensions):
         raise cli_exception.CliException("Project file must be a yaml (\".yaml\", \".yml\") file: " + project_file)
@@ -81,16 +100,19 @@ def cli(engine_jar, java, user_path, as_code_schema, ssl_cert,
     java_executable = checkvu_runner.resolve_java(java)
     checkvu_runner.check_java_version(java_executable)
 
-    resolved_jar = checkvu_runner.resolve_jar(engine_jar, ssl_cert)
+    resolved_jar = checkvu_runner.resolve_jar(engine_jar, ssl_cert, java_executable,
+                                              verify_signature=not unsafe_skip_jar_verification)
 
     command = checkvu_runner.build_command(
         java_executable, resolved_jar, project_file,
         user_path=user_path,
+        play_think_time=play_think_time,
         controller_properties=controller_properties,
         load_generator_properties=load_generator_properties,
         app_proxy=app_proxy,
         app_proxy_username=app_proxy_username,
         app_proxy_bypass=app_proxy_bypass,
+        output=output,
         work_dir=work_dir,
         keep_temp_work_dir=keep_temp_work_dir,
     )

{neoload-1.3.19.dev2 → neoload-1.3.19.dev3}/neoload/commands/project.py

@@ -4,18 +4,30 @@ import click
 import urllib.parse as urlparse
 from commands import test_settings
 from pathlib import Path
-from neoload_cli_lib import user_data, tools, rest_crud, neoLoad_project
+from neoload_cli_lib import user_data, tools, rest_crud, neoLoad_project, cli_exception, resources
+
+__template_namespace = 'resources.templates'
+__template_filename = 'default.yaml'
+__project_yaml_name = 'default.yaml'
 
 
 @click.command()
-@click.argument("command", required=True, type=click.Choice(['up', 'upload', 'meta']))
+@click.argument("command", required=True, type=click.Choice(['create', 'up', 'upload', 'meta']))
 @click.option("--path", "-p", type=click.Path(exists=True), default=os.getcwd(),
               help="Path of project folder, zip or yml file. . is default value")
 @click.option("--save", "-s", type=click.Path(exists=False),
               help="Path to a (non-existent) file ending in .zip to preserve what was uploaded")
 @click.argument("name_or_id", type=str, required=False)
 def cli(command, name_or_id, path, save):
-    """Upload and list scenario from settings"""
+    """
+    create # Create a local as-code project folder from the demo yaml template.
+    upload # Upload a project to NeoLoad Web test settings (alias: up)        .
+    meta   # Display project metadata from the current test settings          .
+    """
+    if command == "create":
+        create_local_project(name_or_id)
+        return
+
     rest_crud.set_current_command()
     if not name_or_id or name_or_id == "cur":
         name_or_id = user_data.get_meta(test_settings.meta_key)
@@ -75,3 +87,35 @@ def meta_data(setting_id):
 
 def get_endpoint(settings_id: str):
     return rest_crud.base_endpoint_with_workspace() + '/tests/' + settings_id + "/project"
+
+
+def create_local_project(project_name):
+    if project_name is None:
+        raise cli_exception.CliException("Missing project name. Usage: neoload project create <project-name>")
+    project_name = project_name.strip()
+    if not project_name or project_name in ('.', '..'):
+        raise cli_exception.CliException(f"Invalid project name: '{project_name}'.")
+    if os.path.sep in project_name or (os.path.altsep and os.path.altsep in project_name):
+        raise cli_exception.CliException(
+            f"Invalid project name: '{project_name}'. Use a single folder name, not a path."
+        )
+
+    if os.path.exists(project_name):
+        raise cli_exception.CliException(
+            f"Cannot create project '{project_name}': path already exists."
+        )
+
+    yaml_path = os.path.join(project_name, __project_yaml_name)
+    try:
+        template = resources.get_resource_as_string(__template_namespace, __template_filename)
+        os.mkdir(project_name)
+        with open(yaml_path, 'w', encoding='utf-8') as yaml_file:
+            yaml_file.write(template)
+    except OSError as err:
+        raise cli_exception.CliException(f"Failed to create project '{project_name}': {err}") from err
+
+    print(f"Project '{project_name}' created successfully.")
+    print(f"  {yaml_path}")
+    print()
+    print("Next step: verify your project with CheckVU:")
+    print(f"  neoload checkvu {yaml_path}")

{neoload-1.3.19.dev2 → neoload-1.3.19.dev3}/neoload/commands/report.py

@@ -8,7 +8,7 @@ import statistics
 import math
 import time
 
-from neoload_cli_lib import tools, rest_crud, user_data, displayer, cli_exception
+from neoload_cli_lib import tools, rest_crud, user_data, displayer, cli_exception, resources
 from dateutil.relativedelta import relativedelta
 
 import logging
@@ -165,19 +165,6 @@ def parse_filter_spec(filter_spec):
     return ret
 
 
-def get_resource_as_string(namespace, file):
-    try:
-        import importlib.resources as pkg_resources
-    except ImportError:
-        # Try backported to PY<37 `importlib_resources`.
-        import importlib_resources as pkg_resources
-
-    logging.debug({'namespace': namespace, 'file': file})
-    if hasattr(pkg_resources, 'files'):  # files is present from Python 3.9
-        return pkg_resources.files(namespace).joinpath(file).read_text()
-    return pkg_resources.read_text(namespace, file)
-
-
 def split_path(path):
     sep = os.path.sep
     if sep not in path: sep = '/'  # try internal posix style
@@ -1131,11 +1118,11 @@ def unique(seq, idfun=None):
 
 
 def get_builtin_template_transaction_csv():
-    return get_resource_as_string('resources.jinja', 'builtin_transactions_csv.j2').strip()
+    return resources.get_resource_as_string('resources.jinja', 'builtin_transactions_csv.j2').strip()
 
 
 def get_builtin_template_console_summary():
-    return get_resource_as_string('resources.jinja', 'builtin_console_summary.j2').strip()
+    return resources.get_resource_as_string('resources.jinja', 'builtin_console_summary.j2').strip()
 
 
 def print_extended_help():

{neoload-1.3.19.dev2 → neoload-1.3.19.dev3}/neoload/commands/validate.py

@@ -1,11 +1,11 @@
 import click
 import neoload_cli_lib.schema_validation as schema_validation
-from neoload_cli_lib.schema_validation import __default_schema_url
 
 @click.command()
 @click.option('-s', '--as-code-schema', default=None,
               help="NeoLoad as-code schema (URL or local path) to validate FILE against. "
-                   "Defaults to the schema published for this release on Github.",
+                   "When omitted, download schemas/v<schemaVersion>/as-code.schema.json from neoload-models (v3). "
+                   "If schemaVersion is absent, use schemas/v3.0/as-code.schema.json.",
               metavar="PATH|URL")
 @click.option('--schema-url', 'schema_url', default=None, hidden=True,
               help="Deprecated alias for --as-code-schema, kept for backward compatibility.")
@@ -15,5 +15,5 @@ from neoload_cli_lib.schema_validation import __default_schema_url
 def cli(file, refresh, as_code_schema, schema_url, ssl_cert):
     """Verify that the yaml FILE matches the neoload as-code file format"""
     # -s/--as-code-schema (new) takes priority over --schema-url (deprecated alias)
-    resolved_schema = as_code_schema or schema_url or __default_schema_url
+    resolved_schema = as_code_schema or schema_url
     print(schema_validation.validate_path(file, resolved_schema, ssl_cert))