Improve CI (#261)

github-actions[bot] · web-flow · commit 713e8ffa9341 · 2022-04-08T13:03:36.000+09:00
* test: assert only the specific achiv. * selenium: run tests concurrently from femiwiki/.github@10c783c Co-authored-by: femiwiki-bot <femiwiki-bot@users.noreply.github.com> Co-authored-by: Lens0021 <lorentz0021@gmail.com>
diff --git a/.github/workflows/create-pr-updating-extension-test.yml b/.github/workflows/create-pr-updating-extension-test.yml
@@ -0,0 +1,28 @@
+# If you see this message on 'femiwiki/.github' repository, please keep in mind that all changes of
+# this workflow file is for being copied to other repositories. If you see this message on any other
+# repositories, DO NOT EDIT this file itself. You should edit
+# https://github.com/femiwiki/.github/blob/main/workflow-templates/.github/workflows/create-pr-updating-extension-test.yml
+# Instead of this.
+
+name: Create PR updating extension test
+
+on:
+  push:
+    branches:
+      - '*-update-extension-test'
+
+jobs:
+  create-pr:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - run: |
+          echo 'CREATE_PR_BASE='$(echo "${{ github.ref_name }}" | cut -d'-' -f1 ) >> $GITHUB_ENV
+      - name: Create Pull Request
+        uses: repo-sync/pull-request@v2
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          pr_title: Update extension test workflow on ${{ env.CREATE_PR_BASE }} branch
+          destination_branch: ${{ env.CREATE_PR_BASE }}
diff --git a/.github/workflows/extension-test.yml b/.github/workflows/extension-test.yml
@@ -1,8 +1,8 @@
 # If you see this message on 'femiwiki/.github' repository, please keep in mind that all changes of
-# this workflow file is for being copied to other repositories.
-# If you see this message on any other repositories, DO NOT EDIT this file itself. You should
-# edit https://github.com/femiwiki/.github/blob/main/workflows-template/extension-test.yml Instead
-# of this.
+# this workflow file is for being copied to other repositories. If you see this message on any other
+# repositories, DO NOT EDIT this file itself. You should edit
+# https://github.com/femiwiki/.github/blob/main/workflow-templates/.github/workflows/extension-test.yml
+# Instead of this.
 
 name: Quibble and Phan
 
@@ -18,7 +18,8 @@ env:
   DOCKER_REGISTRY: docker-registry.wikimedia.org
   DOCKER_ORG: releng
   QUIBBLE_DOCKER_IMAGE: quibble-buster-php74
-  COVERAGE_DOCKER_IMAGE: quibble-coverage
+  # There is no quibble-buster-php74-coverage yet
+  COVERAGE_DOCKER_IMAGE: quibble-buster-php73-coverage
   PHAN_DOCKER_IMAGE: mediawiki-phan-php74
 
 jobs:
@@ -44,11 +45,21 @@ jobs:
 
       # /home/runner/cache/                               Cache
       # /home/runner/src/                                 Mediawiki installation
-      # /home/runner/src/extensions/EXTENSION_NAME/       Clone of the extension repository
+      # /home/runner/src/<TYPE>s/<EXTENSION_NAME>/        Clone of the extension repository
       # /home/runner/docker-images/                       Docker images which exported with docker-save command
-      # $GITHUB_WORKSPACE/.github/workflows/dependencies  Used by actions/cache
+      # $GITHUB_WORKSPACE/.github/workflows/dependencies  Dependency extensions and skins
       - name: Set up
         run: |
+          if [ -e skin.json ]; then
+            echo "TYPE=skin" >> $GITHUB_ENV
+            echo "EXTENSION_NAME=$(cat skin.json |
+              python3 -c 'import json;import sys;print(json.loads("".join(sys.stdin.readlines()))["name"])')" >> $GITHUB_ENV
+          else
+            echo "TYPE=extension" >> $GITHUB_ENV
+            echo "EXTENSION_NAME=$(cat extension.json |
+              python3 -c 'import json;import sys;print(json.loads("".join(sys.stdin.readlines()))["name"])')" >> $GITHUB_ENV
+          fi
+
           # Export the target version of MediaWiki
           # An example of GITHUB_REF: refs/heads/feature-branch-1
           BRANCH_NAME=$(echo "$GITHUB_REF" | cut -d'/' -f3 | cut -d'-' -f1)
@@ -94,7 +105,7 @@ jobs:
           fi
 
       - name: Cache docker image
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: /home/runner/docker-images/${{ env.DOCKER_IMAGE }}
           key: ${{ env.DOCKER_IMAGE }}:${{ env.DOCKER_LATEST_TAG }}
@@ -104,7 +115,7 @@ jobs:
             docker pull "${DOCKER_REGISTRY}/${DOCKER_ORG}/${DOCKER_IMAGE}:${DOCKER_LATEST_TAG}"
       - name: Cache quibble docker image
         if: ${{ matrix.stage == 'coverage' || matrix.stage == 'phan' }}
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: /home/runner/docker-images/${{ env.QUIBBLE_DOCKER_IMAGE }}
           key: ${{ env.QUIBBLE_DOCKER_IMAGE }}:${{ env.QUIBBLE_DOCKER_LATEST_TAG }}
@@ -115,10 +126,10 @@ jobs:
             docker pull "${DOCKER_REGISTRY}/${DOCKER_ORG}/${QUIBBLE_DOCKER_IMAGE}:${QUIBBLE_DOCKER_LATEST_TAG}"
 
       - name: Cache MediaWiki installation
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: /home/runner/src
-          key: ${{ runner.os }}-${{ env.MEDIAWIKI_VERSION }}-b42e1abf-${{ hashFiles('.github/workflows/dependencies') }}
+          key: ${{ runner.os }}-${{ env.MEDIAWIKI_VERSION }}-${{ hashFiles('.github/workflows/dependencies') }}
       - name: Download MediaWiki and extensions
         run: |
           cd /home/runner
@@ -132,7 +143,7 @@ jobs:
           git -C src/ log -n 1 --format="%H"
 
       - name: Cache dependencies (composer and npm)
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: /home/runner/cache
           key: ${{ runner.os }}-${{ env.MEDIAWIKI_VERSION }}-${{ hashFiles('**/*.lock') }}
@@ -141,26 +152,43 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: '7.4'
-          tools: composer:v2
       - name: Composer install
         if: ${{ matrix.stage == 'phan' }}
         run: |
           composer install --prefer-dist --no-progress --no-interaction # $GITHUB_WORKSPACE
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v2
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+      - uses: actions/cache@v2
+        id: yarn-cache
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: ${{ runner.os }}-yarn-
+
+      - name: Run npm because Quibble is not compatible with yarn.
+        run: |
+          if [ -f yarn.lock ]; then
+            npm install
+          fi
 
       - name: Main Test
         run: |
           cd /home/runner
-          # Move our extension
-          sudo cp -r "${GITHUB_WORKSPACE}" src/extensions/
-          mkdir -p cache cover
+          # Move our repository
+          mkdir -p cache cover src/skins src/extensions
+          sudo cp -r "${GITHUB_WORKSPACE}" "src/${{ env.TYPE }}s/${{ env.EXTENSION_NAME }}"
           chmod 777 src cache cover
-          # chown cache/ https://github.com/femiwiki/.github/issues/3
+          # https://github.com/femiwiki/.github/issues/3
           sudo chown -R nobody:nogroup src cache
           sudo chown $(id -u):$(id -g) src cache
           # Composer install
           if [ "${{ matrix.stage }}" == 'phan' ] || [ "${{ matrix.stage }}" == 'coverage' ]; then
             docker run \
-              -e ZUUL_PROJECT=mediawiki/extensions/"${{ github.event.repository.name }}" \
+              --entrypoint quibble-with-supervisord \
+              -e "ZUUL_PROJECT=mediawiki/${{ env.TYPE }}s/${{ env.EXTENSION_NAME }}" \
               -v "$(pwd)"/cache:/cache \
               -v "$(pwd)"/src:/workspace/src \
               "${DOCKER_REGISTRY}/${DOCKER_ORG}/${QUIBBLE_DOCKER_IMAGE}:${QUIBBLE_DOCKER_LATEST_TAG}" \
@@ -173,26 +201,35 @@ jobs:
 
           if [ "${{ matrix.stage }}" == 'phan' ]; then
             docker run \
-              -e THING_SUBNAME=extensions/"${{ github.event.repository.name }}" \
+              -e "THING_SUBNAME=${{ env.TYPE }}s/${{ env.EXTENSION_NAME }}" \
               -v "$(pwd)"/src:/mediawiki \
               "${DOCKER_REGISTRY}/${DOCKER_ORG}/${DOCKER_IMAGE}:${DOCKER_LATEST_TAG}" \
               --color
           elif [ "${{ matrix.stage }}" == 'coverage' ]; then
-            # MW1.35 requires PHP7.3 but quibble-coverage is not.
-            if [ "${MEDIAWIKI_VERSION}" == master ]; then
-              docker run \
-                -e ZUUL_PROJECT=mediawiki/extensions/"${{ github.event.repository.name }}" \
-                -v "$(pwd)"/cache:/cache \
-                -v "$(pwd)"/src:/workspace/src \
-                -v "$(pwd)"/cover:/workspace/cover \
-                "${DOCKER_REGISTRY}/${DOCKER_ORG}/${DOCKER_IMAGE}:${DOCKER_LATEST_TAG}" \
-                --skip-zuul \
-                --skip-deps \
-                -c mwext-phpunit-coverage
+            if [ -d tests/phpunit ]; then
+              # MW1.35+ requires PHP7.3 but quibble-coverage is not.
+              if [ "${MEDIAWIKI_VERSION}" == 'master' ]; then
+                if [ "${TYPE}" == 'skin' ]; then
+                  COMMEND=mwskin-phpunit-coverage
+                else
+                  COMMEND=mwext-phpunit-coverage
+                fi
+                docker run \
+                  --entrypoint quibble-with-supervisord \
+                  -e "ZUUL_PROJECT=mediawiki/${{ env.TYPE }}s/${{ env.EXTENSION_NAME }}" \
+                  -v "$(pwd)"/cache:/cache \
+                  -v "$(pwd)"/src:/workspace/src \
+                  -v "$(pwd)"/cover:/workspace/cover \
+                  "${DOCKER_REGISTRY}/${DOCKER_ORG}/${DOCKER_IMAGE}:${DOCKER_LATEST_TAG}" \
+                  --skip-zuul \
+                  --skip-deps \
+                  -c "${COMMEND}"
+              fi
             fi
           else
             docker run \
-              -e ZUUL_PROJECT=mediawiki/extensions/"${{ github.event.repository.name }}" \
+              --entrypoint quibble-with-supervisord \
+              -e "ZUUL_PROJECT=mediawiki/${{ env.TYPE }}s/${{ env.EXTENSION_NAME }}" \
               -v "$(pwd)"/cache:/cache \
               -v "$(pwd)"/src:/workspace/src \
               "${DOCKER_REGISTRY}/${DOCKER_ORG}/${DOCKER_IMAGE}:${DOCKER_LATEST_TAG}" \
@@ -211,7 +248,7 @@ jobs:
       - name: Tear down
         run: |
           cd /home/runner
-          sudo rm -rf src/extensions/"${{ github.event.repository.name }}"
+          sudo rm -rf "src/${{ env.TYPE }}s/${{ env.EXTENSION_NAME }}"
           # See https://doc.wikimedia.org/quibble/index.html#remove-localsettings-php-between-runs
           rm "$(pwd)"/src/LocalSettings.php || true
           mkdir -p docker-images
diff --git a/tests/phpunit/integration/AchieveTest.php b/tests/phpunit/integration/AchieveTest.php
@@ -13,7 +13,6 @@
  * @group Database
  *
  * @covers \MediaWiki\Extension\AchievementBadges\Achievement
- * @covers \MediaWiki\Extension\AchievementBadges\Achievement
  */
 class AchieveTest extends MediaWikiIntegrationTestCase {
 
@@ -23,22 +22,25 @@ protected function setUp(): void {
 	}
 
 	/**
-	 * @param int $num
+	 * @param bool $earned
 	 * @param User $user
-	 * @param string $type
+	 * @param string $key
 	 * @param string $msg
-	 * @return int
+	 * @return void
 	 */
-	private function assertNotificationNumber( $num, $user, $type, $msg ) {
+	private function assertNotificationForAchievement( $earned, $user, $key, $msg ) {
 		$notifMapper = new EchoNotificationMapper();
 		$limit = 50;
-		$notifs = $notifMapper->fetchUnreadByUser( $user, $limit, '', [ $type ] );
-		$texts = [];
-		foreach ( $notifs as $noti ) {
-			$event = $noti->getEvent();
-			$texts[] = $event . '(' . implode( ', ', array_values( $event->getExtra() ) ) . ')';
+		$notifs = $notifMapper->fetchUnreadByUser( $user, $limit, null, [ Constants::EVENT_KEY_EARN ] );
+		$eventKeys = array_map( static function ( $notif ) {
+			return $notif->getEvent()->getExtra()['key'];
+		}, $notifs );
+		if ( $earned ) {
+			$this->assertContains( $key, $eventKeys,
+				"$msg: $key not found in " . implode( ', ', $eventKeys ) );
+		} else {
+			$this->assertNotContains( $key, $eventKeys, $msg );
 		}
-		$this->assertCount( $num, $notifs, "$msg (" . implode( ', ', $texts ) . ')' );
 	}
 
 	private function assertEarnedAchievement( $num, $user, $key ) {
@@ -77,15 +79,15 @@ public function testAchieveEditPages() {
 		// Edit a page
 		$this->editPage( 'Edit Test', str_repeat( 'lorem', $ct++ ), '', NS_MAIN, $user );
 		$this->assertSame( 1, $user->getEditCount() );
-		$this->assertNotificationNumber( 1, $user, Constants::EVENT_KEY_EARN,
+		$this->assertNotificationForAchievement( true, $user, Constants::ACHV_KEY_EDIT_PAGE . '-0',
 			"edit-page-0 should be achieved (edit count: {$user->getEditCount()})" );
 		$this->assertEarnedAchievement( 1, $user, Constants::ACHV_KEY_EDIT_PAGE );
 
 		// Edit another page
 		$this->editPage( 'Edit Test', str_repeat( 'lorem', $ct++ ), '', NS_MAIN, $user );
 		$this->assertSame( 2, $user->getEditCount() );
-		$this->assertNotificationNumber( 2, $user, Constants::EVENT_KEY_EARN,
-			"Only edit-page-0 should be achieved (edit count: {$user->getEditCount()})" );
+		$this->assertNotificationForAchievement( true, $user, Constants::ACHV_KEY_EDIT_PAGE . '-1',
+			"edit-page-0 should be achieved (edit count: {$user->getEditCount()})" );
 		$this->assertEarnedAchievement( 2, $user, Constants::ACHV_KEY_EDIT_PAGE );
 	}
 
@@ -108,14 +110,14 @@ public function testAchieveCreatePages() {
 		$ct = 1;
 		// Create a page
 		$this->editPage( 'Creation test' . $ct++, 'ipsum', '', NS_MAIN, $user );
-		$this->assertNotificationNumber( 1, $user, Constants::EVENT_KEY_EARN,
+		$this->assertNotificationForAchievement( true, $user, Constants::ACHV_KEY_CREATE_PAGE . '-0',
 			"create-page-0 should be achieved" );
 		$this->assertEarnedAchievement( 1, $user, Constants::ACHV_KEY_CREATE_PAGE );
 
 		// Create another page
 		$this->editPage( 'Creation test' . $ct++, 'ipsum', '', NS_MAIN, $user );
-		$this->assertNotificationNumber( 2, $user, Constants::EVENT_KEY_EARN,
-			"Only create-page-0 should be achieved" );
+		$this->assertNotificationForAchievement( true, $user, Constants::ACHV_KEY_CREATE_PAGE . '-1',
+			"create-page-0 should be achieved" );
 		$this->assertEarnedAchievement( 2, $user, Constants::ACHV_KEY_CREATE_PAGE );
 	}
 
@@ -132,13 +134,13 @@ public function testAchieveEditSize() {
 		] );
 
 		$this->editPage( 'Size test', str_repeat( 'ipsum', 10 ), '', NS_MAIN, $user );
-		$this->assertNotificationNumber( 1, $user, Constants::EVENT_KEY_EARN,
+		$this->assertNotificationForAchievement( true, $user, Constants::ACHV_KEY_EDIT_SIZE . '-0',
 			"edit-size-0 should be achieved" );
 		$this->assertEarnedAchievement( 1, $user, Constants::ACHV_KEY_EDIT_SIZE );
 
 		$this->editPage( 'Size test', str_repeat( 'ipsum', 30 ), '', NS_MAIN, $user );
-		$this->assertNotificationNumber( 2, $user, Constants::EVENT_KEY_EARN,
-			"Only edit-size-0 should be achieved" );
+		$this->assertNotificationForAchievement( true, $user, Constants::ACHV_KEY_EDIT_SIZE . '-1',
+			"edit-size-0 should be achieved" );
 		$this->assertEarnedAchievement( 2, $user, Constants::ACHV_KEY_EDIT_SIZE );
 	}
 
@@ -160,7 +162,7 @@ public function testAchieveEditSizeExist() {
 		$user->addToDatabase();
 
 		$this->editPage( $titleText, $content . 'dolor', '', NS_MAIN, $user );
-		$this->assertNotificationNumber( 0, $user, Constants::EVENT_KEY_EARN,
+		$this->assertNotificationForAchievement( false, $user, Constants::ACHV_KEY_EDIT_SIZE . '-0',
 			"edit-size-0 should not be achieved" );
 		$this->assertEarnedAchievement( 0, $user, Constants::ACHV_KEY_EDIT_SIZE );
 	}
@@ -182,8 +184,11 @@ public function testAchieveManyEditSize() {
 			] );
 
 		$this->editPage( __METHOD__, str_repeat( 'ipsum', 30 ), '', NS_MAIN, $user );
-		$this->assertNotificationNumber( 5, $user, Constants::EVENT_KEY_EARN,
-			"All edit-size should be achieved" );
+
+		$this->assertNotificationForAchievement( true, $user, Constants::ACHV_KEY_EDIT_SIZE . '-0',
+			"All edit-size-0 should be achieved" );
+		$this->assertNotificationForAchievement( true, $user, Constants::ACHV_KEY_EDIT_SIZE . '-4',
+			"All edit-size-4 should be achieved" );
 		$this->assertEarnedAchievement( 5, $user, Constants::ACHV_KEY_EDIT_SIZE );
 	}
 
@@ -198,7 +203,7 @@ public function testLongUserPage() {
 		$longText = str_repeat( 'lorem ipsum dolor amat', 40 );
 
 		$this->editPage( $user->getName(), $longText, '', NS_USER, $user );
-		$this->assertNotificationNumber( 1, $user, Constants::EVENT_KEY_EARN,
+		$this->assertNotificationForAchievement( true, $user, Constants::ACHV_KEY_LONG_USER_PAGE,
 			'Should be achieved long-user-page' );
 		$this->assertEarnedAchievement( 1, $user, Constants::ACHV_KEY_LONG_USER_PAGE );
 	}
diff --git a/tests/selenium/wdio.conf.js b/tests/selenium/wdio.conf.js
@@ -9,4 +9,5 @@ exports.config = {
   //
   // Example:
   // logLevel: 'info',
+  maxInstances: 4,
 };
