feat(3266): functional tests for banner API

[VonnyJap]

Context

The Banner API has been enhanced to support scope and scopeId in its payload, as implemented in the following PRs.
screwdriver-cd/data-schema#586
screwdriver-cd/models#639

Objective

To validate the functionality of the updated Banner API and ensure it performs as expected, we plan to introduce additional functional tests.

References

#3266

License

I confirm that this contribution is made under a BSD license and that I have the authority necessary to make this contribution on behalf of its copyright owner.

[coveralls]

coverage: 95.313%. remained the same
when pulling 2be258d on banner-scope
into d893362 on master.

[sagar1312]

Can we also ensure that scope is immutable?

[VonnyJap]

added

screwdriver/features/banner.feature

Line 25 in ffe197d

And banner is "not updated" when they update the banner with "scope" "PIPELINE"

[sagar1312]

Should we check that only screwdriver admins can create/update banner?

Suggested change

	# And "calvin" has Screwdriver admin permission
	And "calvin" has Screwdriver admin permission

[sagar1312]

Can we add scenarios to ensure, non-admins cannot create/update/delete banner?

[VonnyJap]

We don't have such headless user right now for the purpose of this test. In order to achieve this, new user needs to be created, so asking that we test this manually as of now and I have verified that only admins can create banner.

[sagar1312]

Can we add tests for below scenario

1. Non SD admin user, having access to pipeline repo can read pipeline banner
2. Non SD admin user, not having access to pipeline repo cannot read that pipeline banner
3. When one or more GLOBAL and PIPELINE banner exists, user can selectively get banners for a specific pipeline

[VonnyJap]

@sagar1312 - 1 and 2 scenarios will require a different user to login for testing purpose and we do not have such user handy right now, we need to create an extra user for this purpose. So asking to drop this request for now and do the tests manually, which I have done and ensured that only admin users can create banners.

[VonnyJap]

@sagar1312 - for item 3, I think you were referring to have a test to be able to filter banner by scope and scopeId, so I added a test for that.

screwdriver/features/step_definitions/banner.js

Lines 138 to 150 in ffe197d

	Then(/^they can get the banner associated to that pipeline$/, { timeout: TIMEOUT }, function step() {
	return request({
	url: `${this.instance}/${this.namespace}/banners?scopeId=${this.pipelineId}&scope=PIPELINE`,
	method: 'GET',
	context: {
	token: this.jwt
	}
	}).then(resp => {
	Assert.equal(resp.statusCode, 200);
	Assert.equal(resp.body.length, 1);
	Assert.equal(resp.body[0].scopeId, this.pipelineId);
	});
	});