Player testing: Add Player Testing framework

[rolandkakonyi]

Description

To enable writing Player Tests, we need to introduce a framework that enables writing such tests without much boilerplate.

Changes

I introduced a set of APIs in ./playertesting to enable writing player tests. See available APIs here.
The test host app was extended with index.test.js as the entrypoint for the tests.
There is a single test right now in exampleSpec.ts.

More tests will be added in current sprint!

Tests can be run via the following commands:

• Run on iOS:

  yarn integration-test test:ios

• Run on Android:

  yarn integration-test test:android

(Instructions are shown and logged to the console when simply running the app)

Checklist

• 🗒 CHANGELOG entry

[rolandkakonyi]

I added this new key here, to enable setting the license key easily for tests.
This can be later used for CI as well.

[matamegger]

Pretty neat, I have some suggestions, but generally well done 💪

[matamegger]

This does not look like proper UUID generation 😄
I guess though we should have no problems in the testing with that. Still we might consider using an dependency for handling this.

[rolandkakonyi]

Fixed in 150bc5e

[matamegger]

While I do like such a concept in the case of people who handle the framework on a daily basis, I think having such alias makes it quite hard for contributors to grasp what is happening, and may slow them down when writing own tests.

I am fine though with an alias that's more descriptive e.g. S -> EventSequence (dropping the `Expectationz)

[rolandkakonyi]

fixed in fe5f4ea

[matamegger]

Suggested change

	export class R extends RepeatedEventExpectation {}
	export function RepeatedEvent(
	singleExpectationConvertible: SingleEventExpectation | EventType,
	count: number
	): EventSequenceExpectation {
	return new RepeatedEventExpectation(singleExpectationConvertible, count);
	}

[rolandkakonyi]

fixed in fe5f4ea

[rolandkakonyi]

added variadic parameters for easier usage in a4c62d7 and 9cf03b2

[matamegger]

As discussed, the test is not a good example to showcase. Here is a suggestion.. if applied please also update the markdown file with one of these examples.

Suggested change

	import { TestScope } from 'cavy';
	import { loadSourceConfig, playFor, startPlayerTest } from '../playertesting';
	import { SourceType } from 'bitmovin-player-react-native';
	export default (spec: TestScope) => {
	spec.describe('cavy', () => {
	spec.it('works', async () => {
	await new Promise((resolve) => setTimeout(resolve, 1000));
	spec.describe('player', () => {
	spec.it('loads source and plays for 5 seconds', async () => {
	await startPlayerTest({}, async () => {
	await loadSourceConfig({
	url: 'https://bitmovin-a.akamaihd.net/content/MI201109210084_1/m3u8s/f08e80da-bf1d-4e3d-8899-f0f6155f6efa.m3u8',
	type: SourceType.HLS,
	});
	await playFor(5);
	});
	});
	});
	};
	import { TestScope } from 'cavy';
	import {
	callPlayerAndExpectEvents,
	EventSequence,
	EventType,
	expectEvents,
	loadSourceConfig,
	RepeatedEvent,
	startPlayerTest,
	} from '../playertesting';
	import { SourceType } from 'bitmovin-player-react-native';
	export default (spec: TestScope) => {
	spec.describe('calling play when a source is loaded', () => {
	spec.it('emits a Play and Playing event', async () => {
	await startPlayerTest({}, async () => {
	await loadSourceConfig({
	url: 'https://bitmovin-a.akamaihd.net/content/MI201109210084_1/m3u8s/f08e80da-bf1d-4e3d-8899-f0f6155f6efa.m3u8',
	type: SourceType.HLS,
	});
	await callPlayerAndExpectEvents((player) => {
	player.play();
	}, EventSequence(EventType.Play, EventType.Playing));
	});
	});
	});
	spec.describe('playing a source', () => {
	spec.it('emits TimeChanged events', async () => {
	await startPlayerTest({}, async () => {
	await loadSourceConfig({
	url: 'https://bitmovin-a.akamaihd.net/content/MI201109210084_1/m3u8s/f08e80da-bf1d-4e3d-8899-f0f6155f6efa.m3u8',
	type: SourceType.HLS,
	});
	await callPlayerAndExpectEvents((player) => {
	player.play();
	}, EventSequence(EventType.Play, EventType.Playing));
	await expectEvents(RepeatedEvent(EventType.TimeChanged, 5));
	});
	});
	});
	};

[rolandkakonyi]

Added your changes in 23323d3

[rolandkakonyi]

also updated CONTRIBUTING.md here 3742d68

[matamegger]

Unfortunate that we can not get rid of those await keywords in front of (basically) every line of the test.
At least we discussed that there is no simple/nice way to do this to our knowledge.

[matamegger]

Super 👏

[rolandkakonyi]

@matamegger I renamed PlayerWorld to PlayerTestWorld in 0d97cc6 as we discussed before.