openharmony: add servoshell for ohos (servo#33295)

* openharmony: add servoshell for ohos

Signed-off-by: Mukilan Thiyagarajan <[email protected]>

* ohos: handle missing signing config on forks

Signed-off-by: Mukilan Thiyagarajan <[email protected]>

---------

Signed-off-by: Mukilan Thiyagarajan <[email protected]>

Author: mukilan

.gitattributes

@@ -1,5 +1,6 @@
 * text=auto eol=lf
 tests/wpt/** linguist-vendored
+support/openharmony/**/*.ets linguist-language=ts
 
 # Denote all files that are truly binary and should not be modified.
 *.png binary

.github/workflows/main.yml

@@ -57,6 +57,7 @@ jobs:
     uses: ./.github/workflows/ohos.yml
     with:
       profile: "release"
+    secrets: inherit
 
   build-result:
     name: Result

.github/workflows/ohos.yml

@@ -55,9 +55,32 @@ jobs:
         uses: openharmony-rs/[email protected]
         with:
           version: "4.1"
+          components: "native;toolchains;ets;js;previewer"
+          fixup-path: true
+      - name: Install node for hvigor
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+      - name: Install hvigor modules
+        run: |
+          mkdir ~/hvigor-installation
+          cd ~/hvigor-installation
+          echo "@ohos:registry=https://repo.harmonyos.com/npm/" > .npmrc
+          npm install "@ohos/hvigor@5" "@ohos/hvigor-ohos-plugin@5"
+          echo "HVIGOR_PATH=$PWD" >> $GITHUB_ENV
+      - name: "Setup HAP signing config"
+        env:
+          SIGNING_MATERIAL: ${{ secrets.SERVO_OHOS_SIGNING_MATERIAL }}
+        if: ${{ env.SIGNING_MATERIAL != '' }} # Allows the build to pass on forks.
+        run: |
+          cd ~
+          echo "${SIGNING_MATERIAL}" | base64 -d > servo-ohos-material.zip
+          unzip servo-ohos-material.zip
+          echo "SERVO_OHOS_SIGNING_CONFIG=${PWD}/servo-ohos-material/signing-configs.json" >> $GITHUB_ENV
       - name: Build (arch ${{ matrix.arch }} profile ${{ inputs.profile }})
         env:
           OHOS_SDK_NATIVE: ${{ steps.setup_sdk.outputs.ohos_sdk_native }}
+          OHOS_BASE_SDK_HOME: ${{ steps.setup_sdk.outputs.ohos-base-sdk-home }}
         run: |
           python3 ./mach build --locked --target ${{ matrix.arch }} --${{ inputs.profile }}
           cp -r target/cargo-timings target/cargo-timings-ohos-${{ matrix.arch }}
@@ -67,3 +90,15 @@ jobs:
           name: cargo-timings-ohos-${{ matrix.arch }}
           # Using a wildcard here ensures that the archive includes the path.
           path: target/cargo-timings-*
+      - name: Upload signed HAP artifact
+        if: ${{ env.SERVO_OHOS_SIGNING_CONFIG != '' }} # Build output has different name if not signed.
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ inputs.profile }}-binary-ohos-${{ matrix.arch }}
+          path: target/openharmony/${{ matrix.arch }}/${{ inputs.profile }}/entry/build/default/outputs/default/servoshell-default-signed.hap
+      - name: Upload unsigned HAP artifact
+        if: ${{ env.SERVO_OHOS_SIGNING_CONFIG == '' }} # Build output has different name if not signed.
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ inputs.profile }}-binary-ohos-${{ matrix.arch }}
+          path: target/openharmony/${{ matrix.arch }}/${{ inputs.profile }}/entry/build/default/outputs/default/servoshell-default-unsigned.hap

python/servo/command_base.py

@@ -297,6 +297,7 @@ def resolverelative(category, key):
 
         self.config.setdefault("build", {})
         self.config["build"].setdefault("android", False)
+        self.config["build"].setdefault("ohos", False)
         self.config["build"].setdefault("mode", "")
         self.config["build"].setdefault("debug-assertions", False)
         self.config["build"].setdefault("debug-mozjs", False)
@@ -328,12 +329,6 @@ def rust_toolchain(self):
     def get_top_dir(self):
         return self.context.topdir
 
-    def get_apk_path(self, build_type: BuildType):
-        base_path = util.get_target_dir()
-        base_path = path.join(base_path, "android", self.target.triple())
-        apk_name = "servoapp.apk"
-        return path.join(base_path, build_type.directory_name(), apk_name)
-
     def get_binary_path(self, build_type: BuildType, asan: bool = False):
         base_path = util.get_target_dir()
         if asan or self.target.is_cross_build():
@@ -551,7 +546,12 @@ def common_command_arguments(build_configuration=False, build_type=False, binary
                 CommandArgument(
                     '--android', default=None, action='store_true',
                     help='Build for Android. If --target is not specified, this '
-                         'will choose a default target architecture.',
+                         f'will choose the default target architecture ({AndroidTarget.DEFAULT_TRIPLE}).',
+                ),
+                CommandArgument(
+                    '--ohos', default=None, action='store_true',
+                    help='Build for OpenHarmony. If --target is not specified, this '
+                         f'will choose a default target architecture ({OpenHarmonyTarget.DEFAULT_TRIPLE}).',
                 ),
                 CommandArgument('--win-arm64', action='store_true', help="Use arm64 Windows target"),
                 CommandArgumentGroup('Feature Selection'),
@@ -646,6 +646,7 @@ def target_configuration_decorator(self, *args, **kwargs):
             self.configure_build_target(kwargs, suppress_log=True)
             kwargs.pop('target', False)
             kwargs.pop('android', False)
+            kwargs.pop('ohos', False)
             return original_function(self, *args, **kwargs)
 
         return target_configuration_decorator
@@ -686,15 +687,28 @@ def configure_build_target(self, kwargs: Dict[str, Any], suppress_log: bool = Fa
             return
 
         android = kwargs.get('android') or self.config["build"]["android"]
+        ohos = kwargs.get('ohos') or self.config["build"]["ohos"]
         target_triple = kwargs.get('target')
 
+        if android and ohos:
+            print("Cannot build both android and ohos targets simultaneously.")
+            sys.exit(1)
+
         if android and target_triple:
             print("Please specify either --target or --android.")
             sys.exit(1)
 
         #  Set the default Android target
         if android and not target_triple:
-            target_triple = "aarch64-linux-android"
+            target_triple = AndroidTarget.DEFAULT_TRIPLE
+
+        if ohos and target_triple:
+            print("Please specify either --target or --ohos.")
+            sys.exit(1)
+
+        #  Set the default OpenHarmony target
+        if ohos and not target_triple:
+            target_triple = OpenHarmonyTarget.DEFAULT_TRIPLE
 
         self.target = BuildTarget.from_triple(target_triple)
 
@@ -705,6 +719,9 @@ def configure_build_target(self, kwargs: Dict[str, Any], suppress_log: bool = Fa
     def is_android(self):
         return isinstance(self.target, AndroidTarget)
 
+    def is_openharmony(self):
+        return isinstance(self.target, OpenHarmonyTarget)
+
     def is_media_enabled(self, media_stack: Optional[str]):
         """Determine whether media is enabled based on the value of the build target
            platform and the value of the '--media-stack' command-line argument.

python/servo/package_commands.py

@@ -35,6 +35,7 @@
     archive_deterministically,
     BuildNotFound,
     cd,
+    check_output,
     CommandBase,
     is_windows,
 )
@@ -124,6 +125,10 @@ class PackageCommands(CommandBase):
                      default=None,
                      action='store_true',
                      help='Package Android')
+    @CommandArgument('--ohos',
+                     default=None,
+                     action='store_true',
+                     help='Package OpenHarmony')
     @CommandArgument('--target', '-t',
                      default=None,
                      help='Package for given target platform')
@@ -178,6 +183,55 @@ def package(self, build_type: BuildType, flavor=None, with_asan=False):
             except subprocess.CalledProcessError as e:
                 print("Packaging Android exited with return value %d" % e.returncode)
                 return e.returncode
+        elif self.is_openharmony():
+            # hvigor doesn't support an option to place output files in a specific directory
+            # so copy the source files into the target/openharmony directory first.
+            ohos_app_dir = path.join(self.get_top_dir(), "support", "openharmony")
+            build_mode = build_type.directory_name()
+            ohos_target_dir = path.join(
+                self.get_top_dir(), "target", "openharmony", self.target.triple(), build_mode)
+            if path.exists(ohos_target_dir):
+                print("Cleaning up from previous packaging")
+                delete(ohos_target_dir)
+            shutil.copytree(ohos_app_dir, ohos_target_dir)
+
+            # Map non-debug profiles to 'release' buildMode HAP.
+            if build_type.is_custom():
+                build_mode = "release"
+
+            hvigor_command = ["--no-daemon", "assembleHap", "-p", "product=default", "-p", f"buildMode={build_mode}"]
+            # Detect if PATH already has hvigor, or else fallback to npm installation
+            # provided via HVIGOR_PATH
+            if "HVIGOR_PATH" not in env:
+                try:
+                    with cd(ohos_target_dir):
+                        version = check_output(["hvigorw", "--version", "--no-daemon"])
+                    print(f"Found `hvigorw` with version {str(version, 'utf-8').strip()} in system PATH")
+                    hvigor_command[0:0] = ["hvigorw"]
+                except FileNotFoundError:
+                    print("Unable to find `hvigor` tool. Please either modify PATH to include the"
+                          "path to hvigorw or set the HVIGOR_PATH environment variable to the npm"
+                          "installation containing `node_modules` directory with hvigor modules.")
+                    sys.exit(1)
+            else:
+                env["NODE_PATH"] = env["HVIGOR_PATH"] + "/node_modules"
+                hvigor_script = f"{env['HVIGOR_PATH']}/node_modules/@ohos/hvigor/bin/hvigor.js"
+                hvigor_command[0:0] = ["node", hvigor_script]
+
+            abi_string = self.target.abi_string()
+            ohos_libs_dir = path.join(ohos_target_dir, "entry", "libs", abi_string)
+            os.makedirs(ohos_libs_dir)
+            # The libservoshell.so binary that was built needs to be copied
+            # into the app folder heirarchy where hvigor expects it.
+            print(f"Copying {binary_path} to {ohos_libs_dir}")
+            shutil.copy(binary_path, ohos_libs_dir)
+            try:
+                with cd(ohos_target_dir):
+                    print("Calling", hvigor_command)
+                    subprocess.check_call(hvigor_command, env=env)
+            except subprocess.CalledProcessError as e:
+                print("Packaging OpenHarmony exited with return value %d" % e.returncode)
+                return e.returncode
         elif 'darwin' in self.target.triple():
             print("Creating Servo.app")
             dir_to_dmg = path.join(target_dir, 'dmg')
@@ -347,6 +401,9 @@ def package(self, build_type: BuildType, flavor=None, with_asan=False):
     @CommandArgument('--android',
                      action='store_true',
                      help='Install on Android')
+    @CommandArgument('--ohos',
+                     action='store_true',
+                     help='Install on OpenHarmony')
     @CommandArgument('--emulator',
                      action='store_true',
                      help='For Android, install to the only emulated device')
@@ -376,7 +433,7 @@ def install(self, build_type: BuildType, emulator=False, usb=False, with_asan=Fa
                 return 1
 
         if self.is_android():
-            pkg_path = self.get_apk_path(build_type)
+            pkg_path = self.target.get_package_path(build_type.directory_name())
             exec_command = [self.android_adb_path(env)]
             if emulator and usb:
                 print("Cannot install to both emulator and USB at the same time.")
@@ -386,6 +443,10 @@ def install(self, build_type: BuildType, emulator=False, usb=False, with_asan=Fa
             if usb:
                 exec_command += ["-d"]
             exec_command += ["install", "-r", pkg_path]
+        elif self.is_openharmony():
+            pkg_path = self.target.get_package_path(build_type.directory_name())
+            hdc_path = path.join(env["OHOS_SDK_NATIVE"], "../", "toolchains", "hdc")
+            exec_command = [hdc_path, "install", "-r", pkg_path]
         elif is_windows():
             pkg_path = path.join(path.dirname(binary_path), 'msi', 'Servo.msi')
             exec_command = ["msiexec", "/i", pkg_path]

python/servo/platform/build_target.py

@@ -21,6 +21,7 @@
 from typing import Any, Dict, Optional
 
 import servo.platform
+import servo.util as util
 
 
 class BuildTarget(object):
@@ -61,6 +62,8 @@ def is_cross_build(self) -> bool:
 
 
 class AndroidTarget(CrossBuildTarget):
+    DEFAULT_TRIPLE = "aarch64-linux-android"
+
     def ndk_configuration(self) -> Dict[str, str]:
         target = self.triple()
         config = {}
@@ -237,8 +240,16 @@ def is_cross_build(self) -> bool:
     def needs_packaging(self) -> bool:
         return True
 
+    def get_package_path(self, build_type_directory: str) -> str:
+        base_path = util.get_target_dir()
+        base_path = path.join(base_path, "android", self.triple())
+        apk_name = "servoapp.apk"
+        return path.join(base_path, build_type_directory, apk_name)
+
 
 class OpenHarmonyTarget(CrossBuildTarget):
+    DEFAULT_TRIPLE = "aarch64-unknown-linux-ohos"
+
     def configure_build_environment(self, env: Dict[str, str], config: Dict[str, Any], topdir: pathlib.Path):
         # Paths to OpenHarmony SDK and build tools:
         # Note: `OHOS_SDK_NATIVE` is the CMake variable name the `hvigor` build-system
@@ -370,3 +381,17 @@ def binary_name(self) -> str:
 
     def needs_packaging(self) -> bool:
         return True
+
+    def get_package_path(self, build_type_directory: str) -> str:
+        base_path = util.get_target_dir()
+        base_path = path.join(base_path, "openharmony", self.triple())
+        hap_name = "servoshell-default-signed.hap"
+        build_output_path = path.join("entry", "build", "default", "outputs", "default")
+        return path.join(base_path, build_type_directory, build_output_path, hap_name)
+
+    def abi_string(self) -> str:
+        abi_map = {
+            "aarch64-unknown-linux-ohos": "arm64-v8a",
+            "x86_64-unknown-linux-ohos": "x86_64"
+        }
+        return abi_map[self.triple()]

support/openharmony/AppScope/app.json5

@@ -0,0 +1,10 @@
+{
+  "app": {
+    "bundleName": "org.servo.servoshell",
+    "vendor": "example",
+    "versionCode": 1000000,
+    "versionName": "1.0.0",
+    "icon": "$media:servo_64",
+    "label": "$string:app_name"
+  }
+}

support/openharmony/AppScope/resources/base/element/string.json

@@ -0,0 +1,8 @@
+{
+  "string": [
+    {
+      "name": "app_name",
+      "value": "Servo Shell"
+    }
+  ]
+}

support/openharmony/AppScope/resources/base/media/servo_64.png

@@ -0,0 +1 @@
+../../../../../../resources/servo_64.png

support/openharmony/build-profile.json5

@@ -0,0 +1,44 @@
+{
+  "app": {
+    "products": [
+      {
+        "name": "default",
+        "signingConfig": "default",
+        "compileSdkVersion": 11,
+        "compatibleSdkVersion": 11,
+        "targetSdkVersion": 11,
+        "runtimeOS": "OpenHarmony"
+      },
+      {
+        "name": "harmonyos",
+        "signingConfig": "default",
+        "compatibleSdkVersion": "4.1.0(11)",
+        "targetSdkVersion": "4.1.0(11)",
+        "runtimeOS": "HarmonyOS"
+      }
+    ],
+    "buildModeSet": [
+      {
+        "name": "debug"
+      },
+      {
+        "name": "release"
+      }
+    ]
+  },
+  "modules": [
+    {
+      "name": "servoshell",
+      "srcPath": "./entry",
+      "targets": [
+        {
+          "name": "default",
+          "applyToProducts": [
+            "default",
+            "harmonyos"
+          ]
+        }
+      ]
+    }
+  ]
+}