[api] fix trigger route behaviour

[adrianschroeter]

• fail when wrong operation type is used (instead of executing the token operation)
• allow to use /trigger without specifing the operation type (is defined by the token)
• verify given project/package parameter with possible token package
• fix triggering rebuilds and releases of entire projects
• improve test coverage and api docu
  • A preview of the changes in the api documentation can be seen with the review-app here.

[eduardoj]

This would require changes in the current API documentation...

[dirkmueller]

@eduardoj are you saying src/api/public/apidocs/paths/trigger_operation.yaml needs to be modified?

[eduardoj]

@eduardoj are you saying src/api/public/apidocs/paths/trigger_operation.yaml needs to be modified?

@dirkmueller, yes. Either we modify that file or we split that file in three:

• src/api/public/apidocs/paths/trigger_rebuild.yaml
• src/api/public/apidocs/paths/trigger_release.yaml
• src/api/public/apidocs/paths/trigger_runservice.yaml

Not only that, a new endpoint has been introduced: POST /trigger. This should also be documented, most likely in a new file named src/api/public/apidocs/paths/trigger.yaml.

[adrianschroeter]

I just renamed it now, given that the new endpoint is just a different name without the so far missing operation type check.

[obs-bot]

Review app will appear here: http://obs-reviewlab.opensuse.org/adrianschroeter-fix_trigger_operations

[eduardoj]

I just renamed it now, given that the new endpoint is just a different name without the so far missing operation type check.

@adrianschroeter, I see you added changes to the current documentation. Thanks.

But renaming the src/api/public/apidocs/paths/trigger_operation.yaml to the src/api/public/apidocs/paths/trigger.yaml file makes Swagger-UI not able to find that file. See the OBS-v2.10.50.yaml file:

open-build-service/src/api/public/apidocs/OBS-v2.10.50.yaml

Lines 503 to 504 in 929e967

	/trigger/{operation}:
	$ref: 'paths/trigger_operation.yaml'

I can imagine solving this issue using one of these two options:

1. Renaming back the file to src/api/public/apidocs/paths/trigger_operation.yaml. This is fine because we define the {operation} path parameter as "not required".
2. Keep the file renaming. We should change the reference to the file from $ref: 'paths/trigger_operation.yaml' to $ref: 'paths/trigger.yaml'

I prefer the first option, renaming back the file to src/api/public/apidocs/paths/trigger_operation.yaml.. I recognize this contradicts with my first comment: Not only that, a new endpoint has been introduced: POST /trigger. This should also be documented, most likely in a new file named src/api/public/apidocs/paths/trigger.yaml.. This solution you propose convinces my. Sorry if my first comment was misleading.

[adrianschroeter]

okay, will rename the docu file back to origin name.

[eduardoj]

I added a commit to fix the RuboCop offenses. Let's see if the previous changes make some other fail.

[eduardoj]

The following specs must be adapted:

• spec/controllers/person/token_controller_spec.rb
• spec/controllers/trigger_controller_spec.rb
• spec/controllers/webui/users/token_triggers_controller_spec.rb

[adrianschroeter]

@eduardoj can you update the specs please? I do not have currently an environment to run these.

[eduardoj]

I added a commit to get rid of the codeclimate complaint.

I'll try to adapt the failing tests:

• spec/controllers/person/token_controller_spec.rb
• spec/controllers/trigger_controller_spec.rb
• spec/controllers/webui/users/token_triggers_controller_spec.rb
• spec/controllers/trigger_workflow_controller_spec.rb

[hennevogel]

Superseded by #15261