filament/test/renderdiff/src/render.py

# Copyright (C) 2024 The Android Open Source Project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import sys
import os
import json
import glob
import shutil
import concurrent.futures
import fnmatch


from utils import execute, ArgParseImpl, mkdir_p, mv_f, important_print

import test_config
from results import RESULT_OK, RESULT_FAILED

def _render_single_model(gltf_viewer, test_json_path, named_output_dir,
                         test_name, backend, model, model_path, opengl_lib, vk_icd):
  # We need to pass along the old environment because it might include set up from vulkansdk.
  env = os.environ.copy()
  if backend == 'opengl' and opengl_lib and os.path.isdir(opengl_lib):
    env |= {
      'LD_LIBRARY_PATH': opengl_lib,
      # for macOS
      'DYLD_LIBRARY_PATH': opengl_lib,
    }

  if backend == 'vulkan' and os.path.exists(vk_icd):
    env |= {
      'VK_ICD_FILENAMES': vk_icd,
      'VK_DRIVER_FILES': vk_icd,
      # Uncomment when there's a problem finding the vk driver
      # 'VK_LOADER_DEBUG': 'all',
    }

  out_name = f'{test_name}.{backend}.{model}'
  test_desc = out_name

  working_dir = f'/tmp/renderdiff/{backend}/{model}'
  mkdir_p(working_dir)

  important_print(f'Rendering {test_desc}')

  out_code, output = execute(
    f'{gltf_viewer} -a {backend} --batch={test_json_path} -e {model_path} --headless',
    cwd=working_dir,
    env=env, capture_output=True
  )

  result = ''
  if out_code == 0:
    result = RESULT_OK
    out_tif_basename = f'{out_name}.tif'
    out_tif_name = f'{named_output_dir}/{out_tif_basename}'
    mv_f(f'{working_dir}/{test_name}0.tif', out_tif_name)
    mv_f(f'{working_dir}/{test_name}0.json', f'{named_output_dir}/{test_name}.json')
    important_print(f'{test_desc} rendering succeeded. output=\n{output}')
  else:
    result = RESULT_FAILED
    important_print(f'{test_desc} rendering failed with error={out_code}output=\n{output}')

  return {
    'name': out_name,
    'result': result,
    'result_code': out_code,
  }

def _render_test_config(gltf_viewer,
            test_config,
            output_dir,
            local_only=False,
            opengl_lib=None,
            vk_icd=None,
            test_filter=None,
            num_threads=None):
  assert os.path.isdir(output_dir), f"output directory {output_dir} does not exist"
  assert os.access(gltf_viewer, os.X_OK)

  named_output_dir = os.path.join(output_dir, test_config.name)
  mkdir_p(named_output_dir)

  gltf_viewer_abs = os.path.abspath(gltf_viewer)

  results = []
  with concurrent.futures.ThreadPoolExecutor(max_workers=num_threads) as executor:
    futures = []
    for test in test_config.tests:
      test_json_path = os.path.abspath(
          f'{named_output_dir}/{test.name}.simplified.json')

      with open(test_json_path, 'w') as f:
        f.write(f'[{test.to_filament_format()}]')

      for backend in test.backends:
        if backend == 'vulkan':
          assert vk_icd, "VK ICD must be specified when testing vulkan backend"
        for model in test.models:
          test_name = f'{test.name}.{backend}.{model}'
          if test_filter and not fnmatch.fnmatch(test_name, test_filter):
            print(f'Skipping {test_name} because it does not match filter')
            continue
          model_path = os.path.abspath(test_config.models[model])
          futures.append(
            executor.submit(_render_single_model, gltf_viewer_abs,
                    test_json_path, named_output_dir,
                    test.name, backend, model, model_path,
                    opengl_lib, vk_icd))

    for future in concurrent.futures.as_completed(futures):
      results.append(future.result())

  return named_output_dir, results

if __name__ == "__main__":
  parser = ArgParseImpl()
  parser.add_argument('--test', help='Configuration of the test', required=True)
  parser.add_argument('--gltf_viewer', help='Path to the gltf_viewer', required=True)
  parser.add_argument('--output_dir', help='Output Directory', required=True)
  parser.add_argument('--opengl_lib', help='Path to the folder containing OpenGL driver lib (for LD_LIBRARY_PATH)')
  parser.add_argument('--vk_icd', help='Path to VK ICD file')
  parser.add_argument('--test_filter', help='Filter for the tests to run')
  parser.add_argument('--num_threads', help='Number of threads to use for rendering', type=int)

  args, _ = parser.parse_known_args(sys.argv[1:])
  test = test_config.parse_from_path(args.test)

  output_dir, results = \
    _render_test_config(args.gltf_viewer,
                        test,
                        args.output_dir,
                        opengl_lib=args.opengl_lib,
                        vk_icd=args.vk_icd,
                        test_filter=args.test_filter,
                        num_threads=args.num_threads)

  with open(f'{output_dir}/render_results.json', 'w') as f:
    f.write(json.dumps(results, indent=2))

  shutil.copy2(args.test, f'{output_dir}/test.json')

  failed = [f"   {k['name']}" for k in results if k['result'] != RESULT_OK]
  success_count = len(results) - len(failed)
  important_print(f'Successfully rendered {success_count} / {len(results)} tests' +
                   ('\nFailed:\n' + ('\n'.join(failed)) if len(failed) > 0 else ''))

  if len(failed) > 0:
    exit(1)