feat(mexp): Onboarding Modelexperiments

[paul-sffrth]

Description

This is the onboarding PR for integration STACKIT Modelexperiments into the STACKIT Terraform Provider.

It adds for customer the ability to:

• Create, Read, Update and Delete Modelexperiments Instances
• Create, Read, Update and Delete Mdelexperiments Instance Tokens

Checklist

• Issue was linked above
• Code format was applied: make fmt
• Examples were added / adjusted (see examples/ directory)
• Docs are up-to-date: make generate-docs (will be checked by CI)
• Unit tests got implemented or updated
• Acceptance tests got implemented or updated (see e.g. here)
• Unit tests are passing: make test (will be checked by CI)
• No linter issues: make lint (will be checked by CI)

[github-actions]

This PR was marked as stale after 7 days of inactivity and will be closed after another 7 days of further inactivity. If this PR should be kept open, just add a comment, remove the stale label or push new commits to it.

[Fyusel]

After those comments are resolved I will start to run the acceptance tests and manual testing

[marceljk]

check if instance == nil is missing. Potential nil pointer exception

[marceljk]

check is still missing

[marceljk]

something like this

Suggested change

	if instance.Id == "" {
	return fmt.Errorf("instance id not present")
	}
	if instance == nil || instance.Id == "" {
	return fmt.Errorf("instance or instance id not present")
	}

[marceljk]

nil check for token is missing

[marceljk]

same here, nil check is still missing

[marceljk]

potential nil pointer on token

[marceljk]

still not fixed

[github-actions]

This PR was marked as stale after 7 days of inactivity and will be closed after another 7 days of further inactivity. If this PR should be kept open, just add a comment, remove the stale label or push new commits to it.

[marceljk]

@paul-sffrth I reopened some of my comments from the previous review because they are still not fixed. The nil check should be part of the mapFields function. If you have any questions, feel free to reach out

[paul-sffrth]

I think checking on nil in the map functions don't make sense in that case, since the Instance or Token struct cannot be nil in the response struct returned by the SDK (e.g. the CreateInstanceResponse struct). The API request returns a pointer to the response struct and if the response struct is not nil then the Instance or Token object that gets mapped in the map function cannot be nil. If the response struct is nil, then the nil pointer dereference would already happen when calling the map function (for example here). Therefore I decided to check for nil before calling the map function (for example here)

[marceljk]

Checking if the passed pointer attributes are not nil should be checked in my opinion every time, independent of whether it's checked before calling the function. Someone else could use the function in the future somewhere else, and then it's possible to get a panic because there it's possible to pass a nil pointer.

In our contribution guide we have also nil checks in the mapFields function, so it's the way to go in our provider:

terraform-provider-stackit/.github/docs/contribution-guide/resource.go

Lines 394 to 403 in f5ad219

	func mapFields(barResp *foo.GetBarResponse, model *Model) error {
	if barResp == nil {
	return fmt.Errorf("response input is nil")
	}
	if barResp.Bar == nil {
	return fmt.Errorf("response bar is nil")
	}
	if model == nil {
	return fmt.Errorf("model input is nil")
	}

[Fyusel]

Hi @paul-sffrth,
the acceptance tests are currently failing. Both with this message:

 modelexperiments_acc_test.go:84: Step 1/4 error: Error running apply: exit status 1
        
        Error: Error creating AI Model Experiments instance
        
          with stackit_modelexperiments_instance.example,
          on terraform_plugin_test.tf line 25, in resource "stackit_modelexperiments_instance" "example":
          25: resource "stackit_modelexperiments_instance" "example" {
        
        Waiting for instance to be active: found non-GenericOpenApiError: waiting
        failed. state is impaired
        Trace ID: "54a07214967fd8f9381e2e314c9d8f49"