Commit 65ca8502 authored by sagnowski's avatar sagnowski
Browse files

Update branch 

- Update wrt main
- Other fixes and improvements
parent 3a32e84c

.gitignore

+1 −0
Original line number Diff line number Diff line
@@ -56,6 +56,7 @@ scripts/testv/stvOMASA_*.met 
scripts/testv/stvOMASA_*.csv

scripts/testv/stvOMASA_2ISM_1MASA1TC48c.wav

scripts/testv/stvOMASA_3ISM_1MASA1TC48c.wav

scripts/testv/stvO*

# default reference binary name

IVAS_cod_ref*

IVAS_dec_ref*

.gitlab-ci-custom.yml

+1 −1
Original line number Diff line number Diff line 
include:

  - project: $CUSTOM_CI_PROJECT

    ref: $CUSTOM_CI_REF

    ref: isar-lc3plus

    file: $CUSTOM_CI_FILE

.gitlab-ci.yml

+145 −18
Original line number Diff line number Diff line
@@ -21,6 +21,7 @@ variables: 
      - 'test-be-release'

      - 'test-long-self-test'

      - 'ivas-conformance'

      - 'ivas-conformance-linux'

  GIT_CLEAN_FLAGS: -ffdxq

  TESTCASE_TIMEOUT_STV_SANITIZERS: 180

  TESTCASE_TIMEOUT_LTV_SANITIZERS: 1200
@@ -58,6 +59,10 @@ workflow: 
      variables:

        IVAS_PIPELINE_NAME: 'Draft IVAS Conformance test: $CI_COMMIT_BRANCH'        

    - if: $CI_PIPELINE_SOURCE == 'trigger'

    - if: $CI_PIPELINE_SOURCE == 'web' && $MANUAL_PIPELINE_TYPE == 'ivas-conformance-linux'

      variables:

        IVAS_PIPELINE_NAME: 'Draft IVAS Conformance test -- Linux: $CI_COMMIT_BRANCH'        

    



stages:

  - .pre
@@ -201,7 +206,23 @@ stages: 
    - make clean

    - make -j CLANG=$CLANG_NUM

    - testcase_timeout=$SELFTEST_SANITY_TIMEOUT

    - UBSAN_OPTIONS=suppressions=scripts/ubsan.supp,report_error_type=1 python3 -m pytest $SELF_TEST_PRM_FILE -v --update_ref 1 -m create_ref --html=report.html --self-contained-html --junit-xml=report-junit.xml --testcase_timeout=$testcase_timeout --ref_encoder_path ./IVAS_cod --ref_decoder_path ./IVAS_dec

    - export UBSAN_OPTIONS=suppressions=scripts/ubsan.supp,report_error_type=1



    - exit_code20=0

    - exit_code10=0

    - exit_code5=0



    - if [ $CLANG_NUM -eq 1 ]; then sanitizer_type="MemorySanitizer"; elif [ $CLANG_NUM -eq 2 ]; then sanitizer_type="AddressSanitizer"; elif [ $CLANG_NUM -eq 3 ]; then sanitizer_type="UndefinedBehaviorSanitizer"; else echo "Wrong CLANG_NUM $CLANG_NUM given!"; exit 1; fi



    # run encoder and decoder with 20ms renderer framesize first, use reference creation mode

    - python3 -m pytest $SELF_TEST_PRM_FILE -v --update_ref 1 -m create_ref --html=report-20ms.html --self-contained-html --junit-xml=report-junit-20ms.xml --testcase_timeout=$testcase_timeout --ref_encoder_path ./IVAS_cod --ref_decoder_path ./IVAS_dec || exit_code20=$?

    # for 10ms and 5ms renderer framesize, we only need to run the decoder part as renderer framesize is a decoder-only option

    # set tolerance very high do ignore any BE differences due to the different renderer framesizes, those can appear due to the limiter being active

    # we are only interested in runtime errors from the sanitizers and ignore the diffs

    - python3 -m pytest $SELF_TEST_PRM_FILE -v --html=report-5ms.html --self-contained-html --junit-xml=report-junit-5ms.xml --dut_fr 5 --decoder_only --abs_tol 100000 || exit_code5=$?

    - python3 -m pytest $SELF_TEST_PRM_FILE -v --html=report-10ms.html --self-contained-html --junit-xml=report-junit-10ms.xml --dut_fr 10 --decoder_only --abs_tol 100000 || exit_code10=$?



    - if [ $exit_code20 -ne 0 ] || [ $exit_code10 -ne 0 ] || [ $exit_code5 -ne 0 ]; then exit 1; fi





# ---------------------------------------------------------------
@@ -227,6 +248,8 @@ stages: 
      when: never

    - if: $MANUAL_PIPELINE_TYPE == 'ivas-conformance'

      when: never      

    - if: $MANUAL_PIPELINE_TYPE == 'ivas-conformance-linux'

      when: never      

    - when: on_success



.rules-merge-request:
@@ -283,12 +306,18 @@ stages: 
    expire_in: 1 week

    when: always

    paths:

      - report-junit.xml

      - report.html

      - report-junit-20ms.xml

      - report-junit-10ms.xml

      - report-junit-5ms.xml

      - report-20ms.html

      - report-10ms.html

      - report-5ms.html

    expose_as: "Sanitizer selftest results"

    reports:

      junit:

        - report-junit.xml

        - report-junit-20ms.xml

        - report-junit-10ms.xml

        - report-junit-5ms.xml



.sanitizer-selftest-ltv:

  stage: test
@@ -299,12 +328,18 @@ stages: 
    expire_in: 2 week

    when: always

    paths:

      - report-junit.xml

      - report.html

      - report-junit-20ms.xml

      - report-junit-10ms.xml

      - report-junit-5ms.xml

      - report-20ms.html

      - report-10ms.html

      - report-5ms.html

    expose_as: "Sanitizer selftest results"

    reports:

      junit:

        - report-junit.xml

        - report-junit-20ms.xml

        - report-junit-10ms.xml

        - report-junit-5ms.xml



# ---------------------------------------------------------------

# .pre jobs for setting up things
@@ -344,6 +379,17 @@ branch-is-up-to-date-with-main-pre: 
    - echo $commits_behind_count

    - if [ $commits_behind_count -eq 0 ]; then exit 0; else echo "Your branch is behind main, run 'git merge origin/main' to update."; exit 1; fi;



check-self-test-names-pre:

  extends:

    - .rules-merge-request

  stage: prevalidate

  needs: []

  tags:

    - ivas-linux

  script:

    - python3 ci/check_self_test_names.py scripts/config/self_test.prm 135





branch-is-up-to-date-with-main-post:

  extends:

    - .rules-merge-request
@@ -388,6 +434,7 @@ build-codec-instrumented-linux: 
  timeout: "10 minutes"

  script:

    - *print-common-info

    - *activate-Werror-linux

    - ./scripts/prepare_instrumentation.sh

    - make -j -C scripts/c-code_instrument
@@ -500,6 +547,8 @@ codec-smoke-test: 
codec-msan:

  extends:

    - .sanitizer-selftest-on-mr

  tags:

    - ivas-linux-fast

  before_script:

    - CLANG_NUM=1

    - SELFTEST_SANITY_TIMEOUT=$TESTCASE_TIMEOUT_STV_SANITIZERS
@@ -520,6 +569,8 @@ codec-asan: 
codec-usan:

  extends:

    - .sanitizer-selftest-on-mr

  tags:

    - ivas-linux-fast

  before_script:

    - CLANG_NUM=3

    - SELFTEST_SANITY_TIMEOUT=$TESTCASE_TIMEOUT_STV_SANITIZERS
@@ -1300,21 +1351,17 @@ ivas-conformance: 
  timeout: "60 minutes"

  rules:

    - if: ($CI_PIPELINE_SOURCE == 'web' || $CI_PIPELINE_SOURCE == 'trigger') && $MANUAL_PIPELINE_TYPE == 'ivas-conformance'

#    - if: $CI_PIPELINE_SOURCE == 'push' && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH

  allow_failure:

    exit_codes:

      - 123

  script:

    - *print-common-info-windows

    # Prepare reference exec, use tests and scripts from reference

    - $source_branch_commit_sha = $(git rev-parse HEAD)

    - git checkout main # This should be set to a relevant reference

    - python .\scripts\strip_split_rendering.py

    - MSBuild.exe -maxcpucount .\Workspace_msvc\Workspace_msvc.sln /property:Configuration=Debug    

    - cp -force IVAS_cod.exe IVAS_cod_ref.exe

    - cp -force IVAS_dec.exe IVAS_dec_ref.exe

    - cp -force IVAS_rend.exe IVAS_rend_ref.exe

    - git restore .

    - git checkout $source_branch_commit_sha

    

    # Reference creation

    - python tests/create_short_testvectors.py
@@ -1329,12 +1376,16 @@ ivas-conformance: 
    

    # Copy input data and output ref data

    - if (Test-Path testvec) {rm -r -force testvec}

    - if (Test-Path TMP_DEC) {rm -r -force TMP_DEC}

    - if (Test-Path TMP_ENC) {rm -r -force TMP_ENC}    

    - if (Test-Path TMP_JBM) {rm -r -force TMP_JBM}

    - if (Test-Path TMP_REND) {rm -r -force TMP_REND}

    - mkdir testvec

    - mkdir testvec/binauralRenderer_interface

    - mkdir testvec/testv

    - mkdir testvec/testv/renderer

    - mkdir testvec/bin    

    - cp -r -force -ErrorAction Ignore scripts/testv/* testvec/testv

    - cp    -force -ErrorAction Ignore scripts/testv/* testvec/testv

    - cp -r -force -ErrorAction Ignore scripts/ls_layouts testvec

    - cp -r -force -ErrorAction Ignore scripts/switchPaths testvec

    - cp -r -force -ErrorAction Ignore scripts/trajectories testvec
@@ -1372,6 +1423,80 @@ ivas-conformance: 
    reports:

      junit: report-junit.xml



ivas-conformance-linux:

  tags:

    - ivas-linux

  stage: test

  timeout: "60 minutes"

  rules:

    - if: ($CI_PIPELINE_SOURCE == 'web' || $CI_PIPELINE_SOURCE == 'trigger') && $MANUAL_PIPELINE_TYPE == 'ivas-conformance-linux'

  allow_failure:

    exit_codes:

      - 123

  script:

    - *print-common-info

    - make -j

    - cp IVAS_cod IVAS_cod_ref

    - cp IVAS_dec IVAS_dec_ref

    - cp IVAS_rend IVAS_rend_ref

    

    # Reference creation

    - python3 tests/create_short_testvectors.py

    - python3 scripts/prepare_combined_format_inputs.py

    - python3 -m pytest tests/codec_be_on_mr_nonselection -v -n auto --update_ref 1 -m create_ref --keep_files

    - python3 -m pytest tests/codec_be_on_mr_nonselection -v -n auto --update_ref 1 -m create_ref_part2 --keep_files

    - python3 -m pytest tests/renderer/test_renderer.py --create_ref --keep_files



    # Output creation

    - python3 -m pytest tests/codec_be_on_mr_nonselection tests/renderer/test_renderer.py -v -n auto --keep_files --create_cut --html=report_cmd.html --self-contained-html

    - python3 scripts/parse_commands.py report_cmd.html Readme_IVAS.txt

    

    # Copy input data and output ref data

    - rm -rf testvec

    - mkdir testvec

    - mkdir testvec/binauralRenderer_interface

    - mkdir testvec/testv

    - mkdir testvec/testv/renderer

    - mkdir testvec/bin    

    - cp -r scripts/testv/* testvec/testv

    - cp -r scripts/ls_layouts testvec

    - cp -r scripts/switchPaths testvec

    - cp -r scripts/trajectories testvec

    - cp -r scripts/binauralRenderer_interface/binaural_renderers_hrtf_data testvec/binauralRenderer_interface

    - cp -r tests/ref testvec/testv/ref

    - cp -r tests/dut/* testvec/testv/ref

    - cp -r tests/renderer/cut testvec/testv/renderer/ref

    - cp -r tests/conformance-test testvec/

    - cp Readme_IVAS_dec.txt testvec

    - cp Readme_IVAS_enc.txt testvec 

    - cp Readme_IVAS_rend.txt testvec

    - cp Readme_IVAS_JBM_dec.txt testvec

    - cp IVAS_cod testvec/bin

    - cp IVAS_dec testvec/bin

    - cp IVAS_rend testvec/bin

    

    # Test run generated scripts in testvec

    - cd testvec    

    - python3 -m pytest conformance-test/test_26252.py --junit-xml=report-junit.xml --html=report.html --self-contained-html

    - mv report.html ..

    - mv report-junit.xml ..



  artifacts:

    name: "ivas-conformance-linux-$CI_COMMIT_SHORT_SHA"

    expire_in: 1 week

    when: always

    paths:

      - report-junit.xml

      - report.html

      - Readme_IVAS_dec.txt  

      - Readme_IVAS_enc.txt  

      - Readme_IVAS_rend.txt

      - Readme_IVAS_JBM_dec.txt

    expose_as: "Draft IVAS conformance -- Linux"

    reports:

      junit: report-junit.xml





test-long-self-test:

  tags:

    - ivas-linux-fast
@@ -1453,7 +1578,7 @@ ltv-msan: 
    - .sanitizer-selftest-ltv

  rules:

    - if: $SANITIZER_SCHEDULE_E

  timeout: 1 hour

  timeout: 2 hour

  tags:

    - ivas-linux-fast

  before_script:
@@ -1469,10 +1594,10 @@ ltv-asan: 
  rules:

    - if: $SANITIZER_SCHEDULE_E

      when: delayed

      start_in: 1 hours

      start_in: 2 hours

  tags:

    - ivas-linux-fast

  timeout: 1 hour

  timeout: 2 hour

  before_script:

    - CLANG_NUM=2

    - SELFTEST_SANITY_TIMEOUT=$TESTCASE_TIMEOUT_LTV_SANITIZERS
@@ -1486,10 +1611,10 @@ ltv-usan: 
  rules:

    - if: $SANITIZER_SCHEDULE_E

      when: delayed

      start_in: 2 hours

      start_in: 3 hours

  tags:

    - ivas-linux-fast

  timeout: 1 hour

  timeout: 2 hour

  before_script:

    - CLANG_NUM=3

    - SELFTEST_SANITY_TIMEOUT=$TESTCASE_TIMEOUT_LTV_SANITIZERS
@@ -1510,6 +1635,8 @@ ltv-usan: 
    paths:

      - ep_015.g192

      - dly_profile.dat

      - head_rot_traj.csv

      - exof_traj.csv

      - ./LOGS_PLC

      - ./LOGS_noPLC

.gitlab/issue_templates/asan_ltv_error.md

+1 −0
Original line number Diff line number Diff line
@@ -19,6 +19,7 @@ Link to test pipeline: XXX 
Using the [scripts](https://forge.3gpp.org/rep/ivas-codec-pc/ivas-codec/-/wikis/Software-development/pyivastest-howto#how-to-reproduce-tests):

<!--- check correct sanitizer type -->

<!--- add error pattern if needed -->

<!--- copy as needed: -J dly_profile.dat -T head_rot_traj.csv -exof exof_traj.csv -->

```

python3 scripts/IvasBuildAndRunChecks.py --checks CLANG2 -m MODE -p /path/to/my/local/ci_linux_ltv_local.json

```

.gitlab/issue_templates/msan_ltv_error.md

+1 −0
Original line number Diff line number Diff line
@@ -25,6 +25,7 @@ in the `Makefile` at lines 71 and 72. Note that this may increase runtime heavil 
Using the [scripts](https://forge.3gpp.org/rep/ivas-codec-pc/ivas-codec/-/wikis/Software-development/pyivastest-howto#how-to-reproduce-tests):

<!--- check correct sanitizer type -->

<!--- add error pattern if needed -->

<!--- copy as needed: -J dly_profile.dat -T head_rot_traj.csv -exof exof_traj.csv -->



```

python3 scripts/IvasBuildAndRunChecks.py --checks CLANG1 -m MODE -p /path/to/my/local/ci_linux_ltv_local.json