Check non-public API usage

[swift-kim]

Check if any undocumented API is used by the engine or the embedder
binary (wearable only).

Contributes to #89.

Related to flutter-tizen/flutter-tizen#21.

The content of the check_symbols.py file pre-installed to the CI server is as follows:

#!/usr/bin/env python3
import os
import subprocess
import sys

class Symbol:
  def __init__(self, line):
    self.text = line
    self.address = line[:8].strip()
    self.type = line[9] # See `man nm` for details.
    self.name = line[11:].strip()

  def __str__(self):
    return self.text

def main():
  if len(sys.argv) < 2:
    print('Insufficient arguments.')
    exit(1)
  sopath = sys.argv[1]

  allowlist = []
  scriptdir = os.path.dirname(__file__)
  with open(f'{scriptdir}/4.0.0_native_whitelist_wearable_v12.txt', 'r') as f:
    allowlist = [line.rstrip() for line in f]
  if not allowlist:
    print('The allowlist is empty.')
    exit(1)

  if not os.path.exists(sopath):
    print(f'File not found: {sopath}')
    exit(1)

  symbols_raw = subprocess.run(
    f'nm -gDC {sopath}', shell=True, encoding='utf-8', stdout=subprocess.PIPE).stdout
  symbols = []
  for line in symbols_raw.splitlines():
    symbols.append(Symbol(line))

  exit_code = 0
  for sym in symbols:
    if sym.address:
      continue
    if sym.name in allowlist or sym.name.startswith('FlutterEngine'):
      continue
    print(f'{sym.name}[{os.path.basename(sopath)}]')
    exit_code = 1
  
  exit(exit_code)

if __name__ == '__main__':
  main()

[bwikbs]

👍 Wow It's pretty GOOD!

[WonyoungChoi]

Great! How about making a docker project for the CI environment? I think it needs to be managed like code.

[swift-kim]

@WonyoungChoi I found it really complicated to use Docker along with Azure Pipelines when I was initially setting up the CI. I can't exactly remember why I thought in that way at the time. You may search for the "container" keyword in the YAML schema documentation.

[WonyoungChoi]

@swift-kim How about using GitHub Actions instead? It's a free for public repositories.

[swift-kim]

@WonyoungChoi The difference between GitHub Actions and Azure Pipelines is that GitHub Actions only supports stateless build while Azure Pipelines supports both stateless and stateful (incremental, self-hosted) builds. I initially tried to use GitHub Actions for engine build but it couldn't even download a Docker image (https://github.com/flutter-tizen/tizen_tools/pull/3) because of the storage limit, and even if it could have downloaded the image, every build would have taken more than 60 minutes. So using GitHub Actions or anything similar to it was not a feasible option.

I had three options when I was choosing the CI system that supports stateful (self-hosted) build.

• Jenkins
• JetBrains TeamCity
• Azure Pipelines

You probably know why I chose Azure Pipelines out of these.