Clarify the 'towhat' inclusion validation message on policy creation.

[coderbydesign]

https://bugzilla.redhat.com/show_bug.cgi?id=1663562

In this resolved bug / #18032, it was found that providing an invalid towhat value in the payload while creating a Policy record via the API would result in an unclear error message. The received message is the default error message for a failed Rails inclusion validation: "Towhat is not included in the list".

This message can be (and was) mistakenly interpreted to mean towhat was not included in the payload structure, when it's actually referring to the inclusion list it's being validated against.

This helps clarify the messaging to specify the list of valid "towhat" values, following established patterns throughout other model validations, such as:

manageiq/app/models/miq_widget.rb

Line 24 in 1db6992

validates_inclusion_of :content_type, :in => VALID_CONTENT_TYPES, :message => "should be one of #{VALID_CONTENT_TYPES.join(", ")}"

by explicitly setting the inclusion whitelist as part of the error message. This will be particularly helpful when making requests against the API.

This also updates a supportive spec which tests the validity of the policy record.

Links

• Rails AR Inclusion Validation
• Original PR for 'towhat' field validation on Policy

Steps for Testing/QA

Send a POST API request to create a Policy by running:

$ tools/rest_api.rb post /api/policies

and entering the following payload (invalid towhat):

{
  "action": "create",  
  "resources": [{
    "name": "Invalid Towhat Policy",
    "description": "Invalid Towhat Policy",
    "mode": "control",
    "towhat": "invalidToWhat",      
    "conditions_ids": [ 2000, 3000 ],
    "policy_contents": [{             
      "event_id": 2,
      "actions": [ {"action_id": 1, "opts": { "qualifier": "failure" } } ]
    }]
  }]
}

Response Before:

{
  "error": {
    "kind": "bad_request",
    "message": "Could not create the new policy - Validation failed: MiqPolicy: Towhat is not included in the list",
    "klass": "Api::BadRequestError"
  }
}

Note the error message: "Towhat is not included in the list"

Response After:

{
  "error": {
    "kind": "bad_request",
    "message": "Could not create the new policy - Validation failed: MiqPolicy: Towhat should be one of ContainerGroup, ContainerImage, ContainerNode, ContainerProject, ContainerReplicator, ExtManagementSystem, Host, PhysicalServer, Vm",
    "klass": "Api::BadRequestError"
  }
}

Note the error message: "Towhat should be one of ContainerGroup, ContainerImage, ContainerNode, ContainerProject, ContainerReplicator, ExtManagementSystem, Host, PhysicalServer, Vm"

[miq-bot]

Checked commit coderbydesign@5f0ae21 with ruby 2.3.3, rubocop 0.52.1, haml-lint 0.20.0, and yamllint 1.10.0
2 files checked, 0 offenses detected
Everything looks fine. ⭐

[bdunne]

👍 LGTM