Proof of Concept - Playwright

[cbeach47]

Checklist

• the individual contributor license agreement is signed
• commit message follows commit guidelines
• tests are included
• documentation is changed or added

Description of change

Proof of concept for Playwright test harness integration into uPortal-start.

Initial round of tests focus on an upcoming feature in uPortal, the portal-list api.

Near team goals:

• Align on overall Playwright integration Gradle tasks / flow
• Ensure tests are repeatable and can be run in parallel
• Install Playwright and run tests as part of the PR and main branch CI flows

[ChristianMurphy]

Error showing in CI right now is also happening on master, and appears to be unrelated to these changes

Caused by: org.gradle.api.UncheckedIOException: java.io.IOException: Unable to delete file 'D:\a\uPortal-start\uPortal-start\.gradle\tomcat\logs\catalina.2022-06-13.log'

https://github.com/uPortal-Project/uPortal-start/runs/6866142583?check_suite_focus=true#step:8:381

[ChristianMurphy]

Is this at a point where we could add part (or all of this) to continuous integration (GitHub actions)?

[ChristianMurphy]

do we also want/need to declare the version of node, like:

uPortal-start/overlays/uPortal/build.gradle

Lines 17 to 20 in 9f24791

	node {
	version = nodejsVersion
	download = true
	}

[cbeach47]

need? no (at least not yet). When we bump up to the next version of the node plugin, we may want to control the version.

[ChristianMurphy]

It looks like the node versions between:
uPortal-start's current

uPortal-start/gradle.properties

Line 47 in 10e2921

nodejsVersion=12.16.1

and the gradle plugin are several major apart https://github.com/node-gradle/gradle-node-plugin/blob/1330dc94ce8cc5b2a64d77e4fd38c0792946378d/src/main/kotlin/com/github/gradle/node/NodeExtension.kt#L134

I do think uPortal-start's probably can be upgraded to 16, and this may be fine for now.
Just something to be aware of.

[cbeach47]

Is this at a point where we could add part (or all of this) to continuous integration (GitHub actions)?

Not yet, since the portlet-list API has not yet been merged into the main branch of uPortal.

[ChristianMurphy]

Not yet, since the portlet-list API has not yet been merged into the main branch of uPortal.

The tsc, type-coverage, and eslint steps are generic enough for that to not matter? 🤔
But I take your point that we can't run playwright itself on the (unmerged) API yet.

[cbeach47]

Not yet, since the portlet-list API has not yet been merged into the main branch of uPortal.

The tsc, type-coverage, and eslint steps are generic enough for that to not matter? 🤔 But I take your point that we can't run playwright itself on the (unmerged) API yet.

Good point - Setting up the test harness has nothing to do with the unmerged APIs, so that's not a blocker.

We can also stand up a quick login / logout test so something is run.

[cbeach47]

This PR no longer is dependent on the portlet-lists api. It has a small number of page (ux) and api tests.

[ChristianMurphy]

Could we include some of these tests as part of CI/CD?
Somewhere in/around

uPortal-start/.github/workflows/CI.yml

Lines 33 to 50 in 40ff401

	- name: Build
	run: ./gradlew -i -S build
	- name: Tomcat Install
	run: ./gradlew -i -S tomcatInstall
	- name: Start Tomcat
	run: ./gradlew -i -S tomcatStart
	- name: Stop Tomcat
	run: ./gradlew -i -S tomcatStop
	- name: Clear Logs Tomcat
	run: ./gradlew -i -S tomcatClearLogs
	- name: Start Database
	run: ./gradlew -i -S hsqlStart
	- name: Init Data
	run: ./gradlew -i -S dataInit
	- name: Stop Database
	run: ./gradlew -i -S hsqlStop
	- name: Generate Skin
	run: ./gradlew -i -S skinGenerate -DskinName=test

Also could we look into the merge conflict?

[cbeach47]

merge conflict is now fixed.

I'll add playwrightRun into the CI flow.

[cbeach47]

hmm the tests are not finding the expected data. taking a look...

[cbeach47]

Setting aside the effort to include playwright in the CI flow for now. Tracked via #574 .

[ChristianMurphy]

LGTM, thanks @cbeach47!