Refactor cdi api

[elezar]

The original CDI spec generation API was focussed on NVML device specifically. Since then we have replaced the more specific functions (for GPU and MIG devices) in the API with more generally applicable functions based on mode and device IDs.

This organic growth of APIs also means that for the NVML case specifically we had multiple different implementations of CDI spec generation making keeping things consistent more difficult.

Thes changes remove the redundant functions in the nvcdi.Interface allowing devices to be requested by ID across all use cases. It also refactors the CDI spec generation for NVML devices to ensure that the same generation logic is used for all cases.

[coveralls]

Pull Request Test Coverage Report for Build 16072906327

Details

• 119 of 260 (45.77%) changed or added relevant lines in 12 files are covered.
• 9 unchanged lines in 5 files lost coverage.
• Overall coverage increased (+0.9%) to 34.054%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
pkg/nvcdi/lib-wsl.go	0	3	0.0%
pkg/nvcdi/gds.go	0	4	0.0%
pkg/nvcdi/lib-imex.go	41	45	91.11%
pkg/nvcdi/management.go	0	4	0.0%
pkg/nvcdi/mofed.go	0	4	0.0%
pkg/nvcdi/wrapper.go	12	17	70.59%
pkg/nvcdi/lib.go	3	9	33.33%
pkg/nvcdi/lib-csv.go	0	10	0.0%
pkg/nvcdi/full-gpu-nvml.go	11	31	35.48%
pkg/nvcdi/mig-device-nvml.go	15	36	41.67%

Files with Coverage Reduction	New Missed Lines	%
pkg/nvcdi/lib-wsl.go	1	0.0%
pkg/nvcdi/mig-device-nvml.go	1	25.42%
pkg/nvcdi/lib-imex.go	2	82.76%
pkg/nvcdi/wrapper.go	2	70.21%
pkg/nvcdi/lib-nvml.go	3	43.23%

Totals
Change from base Build 16054869452:	0.9%
Covered Lines:	4491
Relevant Lines:	13188

---

💛 - Coveralls

[ArangoGutierrez]

LGTM

updated commit

[ArangoGutierrez]

LGTM
Thanks for this Evan, this is a great refactor of the API

updated commit

[Copilot]

Pull Request Overview

This PR refactors the nvcdi API to unify CDI spec generation across all modes by introducing a factory-based generator pattern and removing redundant, mode-specific methods.

• Introduce deviceSpecGeneratorFactory and DeviceSpecGenerator to replace multiple Interface methods.
• Refactor NVML path to create and combine per-device generators with init/shutdown hooks.
• Deprecate GetAllDeviceSpecs and route calls through GetDeviceSpecsByID("all").

Reviewed Changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.

File	Description
pkg/nvcdi/wrapper.go	Replaced direct Interface embedding with a factory for generating specs
pkg/nvcdi/lib-nvml.go	Switched NVML path to return generators and unified init/shutdown logic
pkg/nvcdi/api.go	Updated Interface to use new SpecGenerator types and deprecated legacy methods

Comments suppressed due to low confidence (2)

pkg/nvcdi/lib-nvml.go:80

• [nitpick] The variable name DeviceSpecGenerators shadows the type name and begins with an uppercase letter. Rename it to a lowercase, distinct name like generators or dsgs.

	var DeviceSpecGenerators DeviceSpecGenerators

pkg/nvcdi/wrapper.go:78

• Add unit tests for GetDeviceSpecsByID (and GetAllDeviceSpecs) on the wrapper to ensure correct behavior across all factory implementations.

func (l *wrapper) GetDeviceSpecsByID(devices ...string) ([]specs.Device, error) {

[Copilot]

[nitpick] Remove or resolve the TODO comment by renaming deviceSpecGeneratorFactory to a more descriptive name (e.g., SpecFactory).

Suggested change

	// TODO: Rename this type
	type deviceSpecGeneratorFactory interface {
	// SpecFactory is responsible for creating device spec generators and retrieving common edits.
	type SpecFactory interface {

[ArangoGutierrez]

LGTM