Merge branch 'alexy_ck_job_5' into alexy_ck_job_6

Author: ayefimov-1

roles/telemetry_chargeback/README.md

@@ -36,32 +36,12 @@ These variables can be overridden when importing the role or set at the play lev
 | Variable | Default Value | Description |
 |----------|---------------|-------------|
 | `openstack_cmd` | `openstack` | The command used to execute OpenStack CLI calls. This can be customized if the binary is not in the standard PATH. |
-| `cloudkitty_debug` | `false` | Enable debug mode for the role. |
+| `cloudkitty_debug` | `false` | Enable debug mode for CloudKitty database dumps. |
 | `logs_dir_zuul` | `{{ ansible_env.HOME }}/ci-framework-data/logs` | Directory for log files. |
-| `artifacts_dir_zuul` | `{{ ansible_env.HOME }}/ci-framework-data/artifacts` | Directory for generated artifacts. |
-| `cert_dir` | `{{ ansible_user_dir }}/ck-certs` | Local directory for extracted ingest/query certs. |
-| `local_cert_dir` | `{{ ansible_env.HOME }}/ci-framework-data/flush_certs` | Local directory for flush certs (removed by cleanup_ck.yml after the run). |
-| `remote_cert_dir` | `osp-certs` | Directory inside the OpenStack pod for certs. |
-| `cert_secret_name` | `cert-cloudkitty-client-internal` | OpenShift secret name for client certificates. |
-| `client_secret` | `secret/cloudkitty-lokistack-gateway-client-http` | Secret for flush client certs. |
-| `ca_configmap` | `cm/cloudkitty-lokistack-ca-bundle` | ConfigMap for CA bundle. |
-| `logql_query` | `{service="cloudkitty"}` (overridable via `loki_query`) | LogQL query for Loki. |
-| `cloudkitty_namespace` | `openstack` | OpenShift namespace for Cloudkitty/Loki resources. |
-| `openstackpod` | `openstackclient` | OpenStack client pod name for exec/cp. |
-| `lookback` | `6` | Days lookback for Loki query time range. |
-| `limit` | `50` | Limit for Loki query results. |
-| `cloudkitty_test_scenarios` | `[]` | List of test scenario files to run (default: auto-discover all `test_*.yml` files). |
-
-**Example: Overriding variables when importing the role**
-```yaml
-- name: "Run chargeback tests"
-  ansible.builtin.import_role:
-    name: telemetry_chargeback
-  vars:
-    cloudkitty_namespace: "my-custom-namespace"
-    lookback: 10
-    cloudkitty_debug: true
-```
+| `artifacts_dir_zuul` | `{{ ansible_env.HOME }}/ci-framework-data/artifacts` | Directory for generated artifacts and test output. |
+| `cert_dir` | `{{ ansible_user_dir }}/ck-certs` | Directory for CloudKitty client certificates. |
+| `local_cert_dir` | `{{ ansible_env.HOME }}/ci-framework-data/flush_certs` | Local directory for certificate extraction. |
+| `cloudkitty_namespace` | `openstack` | Kubernetes namespace where CloudKitty is deployed. |
 
 How It Works
 ------------
@@ -71,7 +51,7 @@ The role executes the following workflow:
 1. **CloudKitty Validation** - Enables the hashmap rating module and sets its priority to 100.
 2. **Loki Environment Setup** - Extracts Loki route information and certificates from the OpenShift cluster.
 3. **Admin Credentials** - Retrieves admin project ID and user ID for test data generation.
-4. **Scenario Discovery** - Finds all `test_*.yml` scenario files in the scenario directory (unless overridden by `cloudkitty_test_scenarios`).
+4. **Scenario Discovery** - Finds all `test_*.yml` scenario files in the scenario directory.
 5. **Scenario Loop** - For each scenario file found (exposed as `{{ scenario_name }}`):
    - Generates synthetic Loki log data based on the scenario configuration
    - Calculates expected chargeback metrics from the generated data
@@ -80,72 +60,33 @@ The role executes the following workflow:
 
 The role uses `{{ scenario_name }}` as the loop variable when processing multiple test scenarios, making it easy to track which scenario is currently being executed.
 
-### Synthetic Data Scripts
-
-**gen_synth_loki_data.py** — Generates Loki-format JSON from a scenario YAML and template.
-
-| Option | Description |
-|--------|--------------|
-| `--tmpl` | Path to the Jinja2 template (e.g. `loki_data_templ.j2`). |
-| `-t`, `--test` | Path to the scenario YAML (e.g. `test_dyn_basic.yml`). |
-| `-o`, `--output` | Path to the output JSON file. |
-| `-p`, `--project-id` | Optional; overrides `groupby.project_id` in every log entry. |
-| `-u`, `--user-id` | Optional; overrides `groupby.user_id` in every log entry. |
-| `--ascending` | Sort timestamps in ascending order (oldest first, newest last). |
-| `--descending` | Sort timestamps in descending order (newest first, oldest last) - **default**. |
-| `--debug` | Enable debug logging to stdout. |
-
-By default, the script generates data in descending order (newest timestamps first), which is the expected format for Loki ingestion.
-
-**gen_db_summary.py** — Parses Loki-style JSON (streams or `data.result`), sorts entries by timestamp, and writes a YAML summary. This script is invoked by the role for **both** synthetic totals (in `gen_synth_loki_data.yml`) and Loki-retrieved totals (in `retrieve_loki_data.yml`). It applies rate calculations with support for `factor`, `offset`, and `mutate` transformations.
-
-| Option | Description |
-|--------|--------------|
-| `-j`, `--json` | Path to the input JSON file (required). |
-| `-o`, `--output` | Path to the output YAML file (default: `<input_stem>_total.yml`). |
-| `--debug` | Enable debug mode (writes `<stem>_diff.txt` with one `[ts,log]` JSON per line). |
-| `--debug_dir` | Directory for debug output files (default: same directory as `-o` output file). |
-
-Output YAML structure:
-
-* **time** — `begin_step` / `end_step`, each with `nanosec` (nanosecond timestamp), `begin`, `end` (ISO window strings from the log payload). The `nanosec` values are used for Loki query time range.
-* **data_summary** — `total_timesteps`, `metrics_per_step`, `log_count`, `total_rating`.
-* **by_type** — `rate` (flat list with `Begin`, `End`, `Qty`, `Rate`, `Type` for each metric type). Rate calculated as `Σ((qty_mutated * factor + offset) * price)` where `qty_mutated` is the quantity after applying the `mutate` transformation.
-
-### Dynamically Set Variables
-
-Set in **main.yml** from the OpenStack CLI (`openstack project show admin` / `openstack user show admin`):
-
-| Variable | Description |
-|----------|-------------|
-| `cloudkitty_project_id` | ID of the OpenStack project named `admin` (empty string if not found). Passed as `-p` to the synthetic data generator when non-empty. |
-| `cloudkitty_user_id` | ID of the OpenStack user named `admin` (empty string if not found). Passed as `-u` to the synthetic data generator when non-empty. |
-
-Set in **gen_synth_loki_data.yml** for each scenario file during the loop:
-
-| Variable | Description |
-|----------|-------------|
-| `cloudkitty_data_file` | Local path for generated JSON data (`{{ artifacts_dir_zuul }}/{{ scenario_name }}-synth_data.json`) |
-| `cloudkitty_synth_totals_file` | Local path for calculated metric totals (`{{ artifacts_dir_zuul }}/{{ scenario_name }}-synth_metrics_summary.yml`) |
-| `cloudkitty_test_file` | Path to the scenario configuration file (`{{ role_path }}/files/{{ scenario_name }}.yml`) |
-
 Scenario Configuration
 ----------------------
-The synthetic data generation is controlled by YAML configuration files in the `files/` directory. Any file matching `test_*.yml` will be automatically discovered and processed. Files whose names start with an underscore (e.g. `_test_*.yml`) are **not** discovered by the role; they can be used as reference or for manual runs.
+The synthetic data generation is controlled by YAML configuration files in the `files/` directory. Any file matching the pattern `test_*.yml` will be automatically discovered and executed.
 
 **Available scenarios:**
+- `test_static.yml` - Static test scenario with predefined values
 - `test_dyn_basic.yml` - Dynamic test scenario with variable values over time
 
 Each scenario file defines:
 
-* **generation** — Time range configuration (days, step_seconds).
-* **log_types** — List of log type definitions. Each entry has **type** (identifier and value in output), unit, description, qty, price, groupby, and metadata. The **groupby** dict typically includes dimension keys (e.g. resource, user, project); the generator merges **date_fields** into groupby at run time.
-* **required_fields** — Top-level keys required for each log type (e.g. type, unit, qty, price, groupby).
-* **date_fields** — Date field names to merge into groupby (week_of_the_year, day_of_the_year, month, year).
-* **loki_stream** — Loki stream configuration (service name).
-
 **groupby.resource** should be consistent by metric type across scenario files so that the same type always uses the same resource identifier.
 
+### Data Generation Script Options
+
+The `gen_synth_loki_data.py` script supports the following options:
+
+* `--tmpl` - Path to the Jinja2 template file (required)
+* `-t, --test` - Path to the scenario YAML file (required)
+* `-o, --output` - Path for the output JSON file (required)
+* `-p, --project-id` - Optional project ID to override the scenario file value
+* `-u, --user-id` - Optional user ID to override the scenario file value
+* `--ascending` - Sort timestamps in ascending order (oldest first, newest last)
+* `--descending` - Sort timestamps in descending order (newest first, oldest last) - **default**
+* `--debug` - Enable debug logging
+
+By default, the script generates data in descending order (newest timestamps first), which is the expected format for Loki ingestion.
+
 Dependencies
 ------------
 This role has no direct hard dependencies on other Ansible roles.

roles/telemetry_chargeback/defaults/main.yml

@@ -28,6 +28,3 @@ openstackpod: "openstackclient"
 # Time window settings
 lookback: 6
 limit: 50
-
-# List of test scenario files to run
-cloudkitty_test_scenarios: []

roles/telemetry_chargeback/files/gen_db_summary.py

@@ -350,13 +350,6 @@ def main() -> None:
     doc = build_summary(pairs)
     write_yaml(out_path, doc)
 
-    if doc["data_summary"]["metrics_per_step"] == "ERROR":
-        per_ts = Counter(ts for ts, _ in pairs)
-        exp = next(iter(per_ts.values()), 0)
-        for ts in sorted(per_ts, key=int):
-            if per_ts[ts] != exp:
-                print(ts, per_ts[ts], file=sys.stdout)
-
 
 if __name__ == "__main__":
     main()

roles/telemetry_chargeback/tasks/gen_synth_loki_data.yml

@@ -27,7 +27,7 @@
       python3 "{{ cloudkitty_summary_script }}"
       -j "{{ cloudkitty_data_file }}"
       -o "{{ cloudkitty_synth_totals_file }}"
-      {% if cloudkitty_debug | bool %}--debug --debug_dir "{{ cloudkitty_debug_dir }}"{% endif %}
+      --debug "{{ cloudkitty_debug_dir }}"
   register: synth_rating_info
   when: not file_preexists.stat.exists | bool
   changed_when: synth_rating_info.rc == 0