Added integration tests by Sharpz7 · Pull Request #481 · openstack-exporter/openstack-exporter

Sharpz7 · 2025-09-03T03:42:59Z

This should help make trusting new changes easier.

Sharpz7 · 2025-09-03T03:44:33Z

This is copying a significant amount of code from https://github.com/gophercloud/gophercloud/tree/main/internal/acceptance. I am going to create a ticket there about potentially trying to expose this code out instead of copying it.

Copilot

Pull request overview

This PR introduces comprehensive integration tests for the OpenStack exporter, enabling automated testing against live OpenStack services (Ironic, Nova, Neutron, Glance, Keystone, Placement) via DevStack in CI. The tests validate that the exporter correctly generates Prometheus metrics from real OpenStack resources.

Key Changes

Added integration test infrastructure with helper packages for creating test resources and clients
Created service-specific integration test suites (baremetal, compute, networking, images, identity, placement)
Set up GitHub Actions workflows to run integration tests on pull requests using DevStack

Reviewed changes

Copilot reviewed 28 out of 28 changed files in this pull request and generated 18 comments.

Show a summary per file

File	Description
script/stackenv	Bash script to prepare DevStack testing environment with required resources and environment variables
script/integration-suites/*	Individual test runner scripts for each OpenStack service integration test suite
script/collectlogs	Utility script to collect diagnostic logs after integration test failures
integration/utils.go	Core integration test utilities for starting the OpenStack exporter
integration/tools/tools.go	Helper functions for waiting, random generation, and resource printing in tests
integration/tools/pkg.go	Build tags and package documentation for test tools
integration/funcs/compute.go	Helper functions for creating and managing compute resources in tests
integration/funcs/baremetal.go	Helper functions for creating and managing baremetal nodes in tests
integration/funcs/pkg.go	Build tags and package documentation for test resource functions
integration/clients/clients.go	OpenStack service client creation functions for various services
integration/clients/conditions.go	Test skip conditions for different OpenStack configurations and features
integration/clients/http.go	HTTP round tripper with request/response logging and header redaction
integration/*_test.go	Integration test files validating exporter metrics for each OpenStack service
.github/workflows/integration-*.yaml	GitHub Actions workflows for running integration tests in CI
.github/workflows/ci.yaml	Updated to exclude integration tests from unit test runs

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

CI Fixes Fixing more lint errors Tried to make tests more specific Fixed issues Fixes Fixes More fixes Trying more Test Fix Testing Testing Changes Removing placement Trying things out More changes Testing Trying things Fixes Fixes chore(deps): bump actions/checkout from 4 to 6 Bumps [actions/checkout](https://github.com/actions/checkout) from 4 to 6. - [Release notes](https://github.com/actions/checkout/releases) - [Commits](actions/checkout@v4...v6) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: '6' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Update integration/funcs/compute.go Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Update script/stackenv Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> chore(deps): bump reviewdog/action-actionlint from 1.66.1 to 1.69.0 Bumps [reviewdog/action-actionlint](https://github.com/reviewdog/action-actionlint) from 1.66.1 to 1.69.0. - [Release notes](https://github.com/reviewdog/action-actionlint/releases) - [Commits](reviewdog/action-actionlint@e37e2ca...437bbe9) --- updated-dependencies: - dependency-name: reviewdog/action-actionlint dependency-version: 1.69.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>

Sharpz7 · 2025-12-02T05:27:39Z

Service	Test Name	Coverage
Baremetal (Ironic)	`TestBaremetalIntegration`	`openstack_ironic_node` metric with labels (console_enabled, deploy_kernel, deploy_ramdisk, id, maintenance, name, power_state, provision_state, resource_class, retired, retired_reason); `openstack_ironic_up` metric; metric metadata (HELP and TYPE comments)
Compute (Nova)	`TestComputeIntegration`	`openstack_nova_server_status` metric for specific server; `openstack_nova_total_vms` metric; `openstack_nova_server_local_gb` metric; availability_zone label on server status; `openstack_nova_quota_instances` for admin tenant; `openstack_nova_quota_key_pairs` limit for admin tenant
Identity (Keystone)	`TestIdentityIntegration`	`openstack_identity_up` metric with value 1; metric metadata (HELP and TYPE comments); core metrics presence (`openstack_identity_projects`, `openstack_identity_users`, `openstack_identity_domains`); `openstack_identity_project_info` line format with labels (id, name, domain_id, enabled, parent_id)
Image (Glance)	`TestImagesIntegration`	`openstack_glance_up` metric with value 1; metric metadata (HELP and TYPE comments); core metrics presence (`openstack_glance_images`, `openstack_glance_image_bytes`, `openstack_glance_image_created_at`); `openstack_glance_image_bytes` line format; `openstack_glance_image_created_at` line format with labels (hidden, id, name, status, tenant_id, visibility)
Network (Neutron)	`TestNetworkingIntegration`	`openstack_neutron_up` metric with value 1; metric metadata (HELP and TYPE comments); core metrics presence (`openstack_neutron_networks`, `openstack_neutron_ports`, `openstack_neutron_subnets`, `openstack_neutron_router`); `openstack_neutron_network` line format with labels (id, name, is_external, is_shared, provider_network_type)

Sharpz7 · 2025-12-02T05:28:13Z

I think the main thing to not is BASIS_OPS for ironic is false. For some reason, this makes the tests pass, where they didn't before

Sharpz7 · 2025-12-04T19:17:19Z

@vooon - I'd appreciate your feedback on this in any capacity

vooon

@Sharpz7 here are a few notes.

Also might be helpful to setup slog to show debug.

Sharpz7 · 2025-12-05T23:15:08Z

@vooon appreciate this. Thank you!

…ack-exporter into integration-tests

ClifHouck

I mostly skimmed this. It looks fine on the surface, you can always disable it later or correct things if there's flakiness.

Sharpz7 · 2026-04-06T20:21:42Z

@vooon @ClifHouck I'll merge after a final approval from either of you, I think this in its present state is better than nothing

vooon

Maybe better to parse prom text and then validate lables/metrics that way instead of simple "contains" in body?
But overall looks good.

vooon · 2026-04-07T09:49:00Z

        run: |
-          go test -v -covermode=atomic -coverprofile=coverage.out ./...
+          mapfile -t packages < <(go list ./... | grep -v '/integration')
+          go test -v -covermode=atomic -coverprofile=coverage.out "${packages[@]}"


Why not to use something like that in integration tests?

//go:build acceptance

vooon · 2026-04-07T11:03:45Z

+sudo journalctl -o short-precise --no-pager &> "$LOG_DIR/journal.log"
+# shellcheck disable=SC2024
+sudo systemctl status "devstack@*" &> "$LOG_DIR/devstack-services.txt"
+for service in $(systemctl list-units --output json devstack@* | jq -r '.[].unit | capture("devstack@(?<svc>[a-z\\-]+).service") | '.svc'')


Single quotes around .svc ambiguous and maybe unneeded.

vooon · 2026-04-07T11:09:56Z

+EOL
+
+if _=$(openstack service list | grep container-infra); then
+    _MAGNUM_IMAGE_ID=$(openstack image list --format value -c Name -c ID | grep coreos | cut -d ' ' -f 1)


You can use filter by property or tag:

openstack image list --property os_distro=fedora-coreos

Sharpz7 · 2026-04-08T17:40:19Z

Honestly @vooon I ripped all of this from gophercloud - if it is good enough for them, its good enough for me. I will note these comments for future work in #548

Sharpz7 · 2026-04-08T17:57:17Z

@mnaser @niedbalski I intend to merge on or after 14th April. If I don't hear from either of you, I will self merge this

WizardBit · 2026-04-30T20:01:18Z

Just a bump if this will get merged as the month is ending.

Sharpz7 · 2026-05-06T17:35:53Z

@WizardBit pushed

Sharpz7 added the priority Priority PR or Issue to help with tracking. label Sep 3, 2025

Sharpz7 mentioned this pull request Sep 3, 2025

Expose internal/acceptance/clients, tools and functions gophercloud/gophercloud#3501

Open

Sharpz7 removed the priority Priority PR or Issue to help with tracking. label Sep 3, 2025

Sharpz7 marked this pull request as draft September 3, 2025 04:18

This was referenced Oct 30, 2025

Fix Nova Pain-Points #500

Open

Port to gophercloud v2 #505

Open

Sharpz7 marked this pull request as ready for review December 2, 2025 04:43

Sharpz7 force-pushed the integration-tests branch from 6a71182 to 1b6d7ae Compare December 2, 2025 04:45

Sharpz7 requested a review from Copilot December 2, 2025 04:48

Copilot started reviewing on behalf of Sharpz7 December 2, 2025 04:48 View session

Copilot finished reviewing on behalf of Sharpz7 December 2, 2025 04:50

Copilot AI reviewed Dec 2, 2025

View reviewed changes

openstack-exporter deleted a comment from Copilot AI Dec 2, 2025

Sharpz7 force-pushed the integration-tests branch from 7a9117f to 35eba72 Compare December 2, 2025 05:10

openstack-exporter deleted a comment from Copilot AI Dec 2, 2025

Merge branch 'main' into integration-tests

affa4ef

vooon reviewed Dec 5, 2025

View reviewed changes

Comment thread .github/workflows/integration-baremetal.yml Outdated

Comment thread integration/baremetal_test.go Outdated

Comment thread integration/baremetal_test.go Outdated

Comment thread integration/clients/clients.go Outdated

Comment thread integration/clients/http.go Outdated

Sharpz7 and others added 3 commits March 3, 2026 20:40

Merge branch 'main' into integration-tests

4883879

Suggested changes from voom

ca3c716

Merge branch 'integration-tests' of https://github.com/Sharpz7/openst…

207a845

…ack-exporter into integration-tests

ClifHouck approved these changes Mar 24, 2026

View reviewed changes

Comment thread integration/funcs/compute.go

Sharpz7 added the needs-more-reviews label Mar 25, 2026

Sharpz7 and others added 3 commits March 25, 2026 11:43

Merge branch 'main' into integration-tests

aeaaeb8

Removing unused

4aafa8f

Added back requirelong

cf9ae60

Sharpz7 requested review from ClifHouck and vooon April 6, 2026 20:21

Sharpz7 mentioned this pull request Apr 6, 2026

Placement Parallel Speedup #546

Open

ClifHouck approved these changes Apr 7, 2026

View reviewed changes

vooon approved these changes Apr 7, 2026

View reviewed changes

Sharpz7 mentioned this pull request Apr 8, 2026

Integration Test Improvements #548

Open

Sharpz7 mentioned this pull request Apr 13, 2026

feat: add support for additional labels on metrics #536

Open

Sharpz7 merged commit e64dc81 into openstack-exporter:main May 6, 2026
11 checks passed

Uh oh!

Conversation

Sharpz7 commented Sep 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Sharpz7 commented Sep 3, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Key Changes

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Sharpz7 commented Dec 2, 2025

Uh oh!

Sharpz7 commented Dec 2, 2025

Uh oh!

Sharpz7 commented Dec 4, 2025

Uh oh!

vooon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Sharpz7 commented Dec 5, 2025

Uh oh!

ClifHouck left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Sharpz7 commented Apr 6, 2026

Uh oh!

vooon left a comment

Choose a reason for hiding this comment

Uh oh!

vooon Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

vooon Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

vooon Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Sharpz7 commented Apr 8, 2026

Uh oh!

Sharpz7 commented Apr 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

WizardBit commented Apr 30, 2026

Uh oh!

Uh oh!

Sharpz7 commented May 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Sharpz7 commented Sep 3, 2025 •

edited

Loading

Sharpz7 commented Apr 8, 2026 •

edited

Loading