Merge pull request #241717 from OPNA2608/init/lomiri/lomiri-ui-toolkit

{ stdenvNoCC

, lib

, fetchFromGitLab

, gitUpdater

, gtk3

, hicolor-icon-theme

, ubuntu-themes

}:

stdenvNoCC.mkDerivation (finalAttrs: {

  pname = "suru-icon-theme";

  version = "20.05.1";

  src = fetchFromGitLab {

    owner = "ubports";

    repo = "development/core/suru-icon-theme";

    rev = finalAttrs.version;

    hash = "sha256-jJ6J+SjSABZCgnCF9cIFBpeSXX2LMnV+nPLPpoXQv30=";

  };

  strictDeps = true;

  nativeBuildInputs = [

    gtk3 # gtk-update-icon-cache

    hicolor-icon-theme # theme setup hook

  ];

  propagatedBuildInputs = [

    ubuntu-themes

  ];

  dontConfigure = true;

  dontBuild = true;

  installPhase = ''

    runHook preInstall

    mkdir -p $out/share/icons

    cp -r suru $out/share/icons/

    gtk-update-icon-cache $out/share/icons/suru

    runHook postInstall

  '';

  dontDropIconThemeCache = true;

  passthru.updateScript = gitUpdater { };

  meta = with lib; {

    description = "Suru Icon Theme for Lomiri Operating Environment";

    homepage = "https://gitlab.com/ubports/development/core/suru-icon-theme";

    license = licenses.cc-by-sa-30;

    maintainers = teams.lomiri.members;

    platforms = platforms.all;

  };

})

  in {

    #### Data

    lomiri-schemas = callPackage ./data/lomiri-schemas { };

    suru-icon-theme = callPackage ./data/suru-icon-theme { };

    #### Development tools / libraries

    cmake-extras = callPackage ./development/cmake-extras { };

    #### QML / QML-related

    lomiri-settings-components = callPackage ./qml/lomiri-settings-components { };

    lomiri-ui-toolkit = callPackage ./qml/lomiri-ui-toolkit { };

    #### Services

    biometryd = callPackage ./services/biometryd { };

From 243477a2bd6e315c77ebaf5b2ed4a9c9c4e1e22a Mon Sep 17 00:00:00 2001

From: OPNA2608 <christoph.neidahl@gmail.com>

Date: Sat, 25 Nov 2023 10:49:32 +0100

Subject: [PATCH] Mark problematic tests

- ShapeMaterial requires a Qt OpenGL context, doesn't work in our sandbox

- SignalSpy on QML shaders compilers don't see changes

- Scaling value from environment not picked up properly since Qt 5.15.11

  https://gitlab.com/ubports/development/core/lomiri-ui-toolkit/-/issues/34

- TypeError on some properties with Qt 5.15

  https://gitlab.com/ubports/development/core/lomiri-ui-toolkit/-/issues/9

---

 tests/checkresults.sh | 89 ++++++++++++++++++++++++++++++++++++++++---

 1 file changed, 83 insertions(+), 6 deletions(-)

diff --git a/tests/checkresults.sh b/tests/checkresults.sh

index fc498985e..730b9d406 100755

--- a/tests/checkresults.sh

+++ b/tests/checkresults.sh

@@ -22,6 +22,7 @@ ERRORS_PATTERN='<failure'

 FAILURES=0

 FATAL_WARNINGS=0

+EXCEPTED_FAILURES=0

 EXCEPTED=0

 for _XML in $*; do

     _TESTNAME=$(basename $_XML | sed -r 's@(.+)\.xml@\1@' -)

@@ -31,7 +32,72 @@ for _XML in $*; do

       exit 1

     fi

-    EXCEPTIONS='components_benchmark \

+    ERROR_EXCEPTIONS='\

+                tst_actionbar.13.qml \

+                tst_actionlist.13.qml \

+                tst_adaptivepagelayout.13.qml \

+                tst_adaptivepagelayout_configuration.13.qml \

+                tst_combobutton.11.qml \

+                tst_combobutton.13.qml \

+                tst_contextual_actions.13.qml \

+                tst_focus.13.qml \

+                tst_header.13.qml \

+                tst_hide_chrome.11.qml \

+                tst_listitem.12.qml \

+                tst_listitem.13.qml \

+                tst_listitem_actions_breaks_selectmode.12.qml \

+                tst_listitem_extras.13.qml \

+                tst_listitem_focus.13.qml \

+                tst_listitem_horizontal_navigation.13.qml \

+                tst_listitem_selectmode.12.qml \

+                tst_listitem_selectmode.13.qml \

+                tst_listitems_itemselector.11.qml \

+                tst_listitems_standard.11.qml \

+                tst_listitems_standard.13.qml \

+                tst_lomirilistview.11.qml \

+                tst_lomiritestcase.qml \

+                tst_multicolumnheader.13.qml \

+                tst_optionselector.11.qml \

+                tst_optionselector.13.qml \

+                tst_page_with_header.13.qml \

+                tst_pagehead_back_action.13.qml \

+                tst_pagehead_contents_width.13.qml \

+                tst_pagehead_sections.13.qml \

+                tst_pagehead_visible.13.qml \

+                tst_pageheader.13.qml \

+                tst_pagestack.13.qml \

+                tst_pagestack.DEPRECATED_APPHEADER_TABS.13.qml \

+                tst_picker.11.qml \

+                tst_picker.13.qml \

+                tst_popover.12.qml \

+                tst_popover.13.qml \

+                tst_popups_dialog.13.qml \

+                tst_popups_pagestack.13.qml \

+                tst_pulltorefresh_pagestack_topmargin.13.qml \

+                tst_slider.11.qml \

+                tst_slider.13.qml \

+                tst_switch_bug1510919.13.qml \

+                tst_tabs.11.qml \

+                tst_tabs.13.qml \

+                tst_tabs.DEPRECATED_TOOLBAR.11.qml \

+                tst_textarea.11.qml \

+                tst_textarea_in_flickable.11.qml \

+                tst_textfield.11.qml \

+                tst_textinput_common.12.qml \

+                tst_textinput_common.13.qml \

+                tst_toggles.13.qml \

+                inversemousearea \

+                layouts \

+                recreateview \

+                subtheming \

+                swipearea \

+                tst_icon.11.qml \

+                tst_icon.13.qml \

+                dpr1 \

+                '

+

+    EXCEPTIONS='\

+                components_benchmark \

                 tst_tabbar.11.qml \

                 tst_datepicker.bug1567840.SEGFAULT.12.qml \

                 tst_datepicker.bug1567840.SEGFAULT.13.qml \

@@ -49,22 +115,28 @@ for _XML in $*; do

                 inversemousearea \

                 tst_listitem_focus_bug.13.qml \

                 tst_shortcuts.13.qml \

+                tst_pagestack.DEPRECATED_TOOLBAR.11.qml \

                 '

     WARNINGS=$(grep -c -P "$WARNINGS_PATTERN" $_XML)

     ERRORS=$(grep -c -P "$ERRORS_PATTERN" $_XML)

     if [ $ERRORS -ne 0 ]; then

-      FAILURES_FILES="${FAILURES_FILES}  ${_TESTNAME}\n"

-      ((FAILURES+=$ERRORS))

+      if [[ $ERROR_EXCEPTIONS == *" $_TESTNAME "* ]]; then

+        EXCEPTED_FAILURES_FILES="${EXCEPTED_FAILURES_FILES}  ${_TESTNAME}\n"

+        ((EXCEPTED_FAILURES+=$ERRORS))

+      else

+        FAILURES_FILES="${FAILURES_FILES}  ${_TESTNAME}\n"

+        ((FAILURES+=$ERRORS))

+      fi

     elif [ $WARNINGS -ne 0 ]; then

-      if [[ $EXCEPTIONS == *$_TESTNAME* ]]; then

+      if [[ $EXCEPTIONS == *" $_TESTNAME "* ]]; then

         EXCEPTED_FILES="${EXCEPTED_FILES}  ${_TESTNAME}\n"

         ((EXCEPTED+=$WARNINGS))

       else

         FATAL_WARNINGS_FILES="${FATAL_WARNINGS_FILES}  ${_TESTNAME}\n"

         ((FATAL_WARNINGS+=$WARNINGS))

       fi

-    elif [[ $EXCEPTIONS == *$_TESTNAME* ]]; then

+    elif [[ $ERROR_EXCEPTIONS == *" $_TESTNAME "* || $EXCEPTIONS == *" $_TESTNAME "* ]]; then

       WOOT_FILES="${WOOT_FILES}  ${_TESTNAME}\n"

     fi

 done

@@ -82,6 +154,11 @@ if [ -n "$FATAL_WARNINGS_FILES" ]; then

     echo -e "$FATAL_WARNINGS_FILES"

 fi

+if [ -n "$EXCEPTED_FAILURES_FILES" ]; then

+    echo The following tests issued $EXCEPTED_FAILURES expected failures:

+    echo -e "$EXCEPTED_FAILURES_FILES"

+fi

+

 if [ -n "$EXCEPTED_FILES" ]; then

     echo The following tests issued $EXCEPTED expected warnings:

     echo -e "$EXCEPTED_FILES"

@@ -89,7 +166,7 @@ fi

 if [ -n "$WOOT_FILES" ]; then

     echo Woot! Known problematic tests passed!

-    echo Consider removing these from EXCEPTIONS in ${0#$(pwd)/}!

+    echo Consider removing these from ERROR_EXCEPTIONS/EXCEPTIONS in ${0#$(pwd)/}!

     echo -e "$WOOT_FILES"

 fi

-- 

2.40.1

{ stdenv

, lib

, fetchFromGitLab

, fetchpatch

, gitUpdater

, testers

, dbus-test-runner

, dpkg

, gdb

, glib

, lttng-ust

, perl

, pkg-config

, python3

, qmake

, qtbase

, qtdeclarative

, qtfeedback

, qtgraphicaleffects

, qtpim

, qtquickcontrols2

, qtsvg

, qtsystems

, suru-icon-theme

, wrapQtAppsHook

, xvfb-run

}:

let

  listToQtVar = suffix: lib.makeSearchPathOutput "bin" suffix;

  qtPluginPaths = listToQtVar qtbase.qtPluginPrefix [ qtbase qtpim qtsvg ];

  qtQmlPaths = listToQtVar qtbase.qtQmlPrefix [ qtdeclarative qtfeedback qtgraphicaleffects ];

in

stdenv.mkDerivation (finalAttrs: {

  pname = "lomiri-ui-toolkit";

  version = "1.3.5011";

  src = fetchFromGitLab {

    owner = "ubports";

    repo = "development/core/lomiri-ui-toolkit";

    rev = finalAttrs.version;

    hash = "sha256-z/EEmC9LjQtBx5MRDLeImxpRrzH4w6v6o+NmqX+L4dw=";

  };

  outputs = [ "out" "dev" ];

  patches = [

    # Upstreaming effort for these two patches: https://gitlab.com/ubports/development/core/lomiri-ui-toolkit/-/merge_requests/44

    (fetchpatch {

      name = "0001-lomiri-ui-toolkit-fix-tests-on-qt-5.15.4.patch";

      url = "https://salsa.debian.org/ubports-team/lomiri-ui-toolkit/-/raw/1ad650c326ba9706d549d1dbe8335c70f6b382c8/debian/patches/0001-fix-tests-on-qt-5.15.4.patch";

      hash = "sha256-Y5HVvulR2760DBzlmYkImbJ/qIeqMISqPpUppbv8xJA=";

    })

    (fetchpatch {

      name = "0002-lomiri-ui-toolkit-fix-tests-on-qt-5.15.5.patch";

      url = "https://salsa.debian.org/ubports-team/lomiri-ui-toolkit/-/raw/03bcafadd3e4fda34bcb5af23454f4b202cf5517/debian/patches/0002-fix-tests-on-qt-5.15.5.patch";

      hash = "sha256-x8Zk7+VBSlM16a3V1yxJqIB63796H0lsS+F4dvR/z80=";

    })

    # Small fixes to statesaver & tst_imageprovider.11.qml tests

    # Remove when version > 1.3.5011

    (fetchpatch {

      name = "0003-lomiri-ui-toolkit-tests-Minor-fixes.patch";

      url = "https://gitlab.com/ubports/development/core/lomiri-ui-toolkit/-/commit/a8324d670b813a48ac7d48aa0bc013773047a01d.patch";

      hash = "sha256-W6q3LuQqWmUVSBzORcJsTPoLfbWwytABMDR6JITHrDI=";

    })

    # Fix Qt 5.15.11 compatibility

    # Remove when version > 1.3.5011

    (fetchpatch {

      name = "0004-lomiri-ui-toolkit-Fix-compilation-with-Qt-5.15.11.patch";

      url = "https://gitlab.com/ubports/development/core/lomiri-ui-toolkit/-/commit/4f999077dc6bc5591bdfede64fd21cb3acdcaac1.patch";

      hash = "sha256-5VCQFOykxgspNBxH94XYuBpdHsH9a3+8FwV6xQE55Xc=";

    })

    ./2001-Mark-problematic-tests.patch

  ];

  postPatch = ''

    patchShebangs documentation/docs.sh tests/

    substituteInPlace tests/tests.pro \

      --replace "\''$\''$PYTHONDIR" "$dev/${python3.sitePackages}"

    for subproject in po app-launch-profiler lomiri-ui-toolkit-launcher; do

      substituteInPlace $subproject/$subproject.pro \

        --replace "\''$\''$[QT_INSTALL_PREFIX]" "$out" \

        --replace "\''$\''$[QT_INSTALL_LIBS]" "$out/lib"

    done

    # Install apicheck tool into bin

    substituteInPlace apicheck/apicheck.pro \

      --replace "\''$\''$[QT_INSTALL_LIBS]/lomiri-ui-toolkit" "$out/bin"

    # Causes redefinition error with our own fortify hardening

    sed -i '/DEFINES += _FORTIFY_SOURCE/d' features/lomiri_common.prf

    # Reverse dependencies (and their reverse dependencies too) access the function patched here to register their gettext catalogues,

    # so hardcoding any prefix here will make only catalogues in that prefix work. APP_DIR envvar will override this, but with domains from multiple derivations being

    # used in a single application (lomiri-system-settings), that's of not much use either.

    # https://gitlab.com/ubports/development/core/lomiri-ui-toolkit/-/blob/dcb3a523c56a400e5c3c163c2836cafca168767e/src/LomiriToolkit/i18n.cpp#L101-129

    #

    # This could be solved with a reference to the prefix of whoever requests the domain, but the call happens via some automatic Qt / QML callback magic,

    # I'm not sure what the best way of injecting that there would be.

    # https://gitlab.com/ubports/development/core/lomiri-ui-toolkit/-/blob/dcb3a523c56a400e5c3c163c2836cafca168767e/src/LomiriToolkit/i18n_p.h#L34

    #

    # Using /run/current-system/sw/share/locale instead of /usr/share/locale isn't a great

    # solution, but at least it should get us working localisations

    substituteInPlace src/LomiriToolkit/i18n.cpp \

      --replace "/usr" "/run/current-system/sw"

    # The code here overrides the regular QML import variables so the just-built modules are found & used in the tests

    # But we need their QML dependencies too, so put them back in there

    substituteInPlace export_qml_dir.sh \

      --replace '_IMPORT_PATH=$BUILD_DIR/qml' '_IMPORT_PATH=$BUILD_DIR/qml:${qtQmlPaths}'

    # These tests try to load Suru theme icons, but override XDG_DATA_DIRS / use full paths to load them

    substituteInPlace \

      tests/unit/visual/tst_visual.cpp \

      tests/unit/visual/tst_icon.{11,13}.qml \

      tests/unit/visual/tst_imageprovider.11.qml \

      --replace '/usr/share' '${suru-icon-theme}/share'

  '';

  # With strictDeps, QMake only picks up Qt dependencies from nativeBuildInputs

  strictDeps = false;

  nativeBuildInputs = [

    perl

    pkg-config

    python3

    qmake

    wrapQtAppsHook

  ];

  buildInputs = [

    glib

    lttng-ust

    qtbase

    qtdeclarative

    qtpim

    qtquickcontrols2

    qtsystems

  ];

  propagatedBuildInputs = [

    qtfeedback

    qtgraphicaleffects

    qtsvg

  ];

  nativeCheckInputs = [

    dbus-test-runner

    dpkg # `dpkg-architecture -qDEB_HOST_ARCH` response decides how tests are run

    gdb

    xvfb-run

  ];

  qmakeFlags = [

    # docs require Qt5's qdoc, which we don't have before https://github.com/NixOS/nixpkgs/pull/245379

    "CONFIG+=no_docs"

    # Ubuntu UITK compatibility, for older / not-yet-migrated applications

    "CONFIG+=ubuntu-uitk-compat"

    "QMAKE_PKGCONFIG_PREFIX=${placeholder "out"}"

  ];

  doCheck = stdenv.buildPlatform.canExecute stdenv.hostPlatform;

  # Explicitly not parallel-safe, large parts are always run in series and at least qquick_image_extension fails with parallelism

  enableParallelChecking = false;

  checkPhase = ''

    runHook preCheck

    export HOME=$PWD

    # XDG_RUNTIME_DIR with wrong permissions causes warnings that are interpreted as errors in the test suite

    export XDG_RUNTIME_DIR=$PWD/runtime-dir

    mkdir -p $XDG_RUNTIME_DIR

    chmod -R 700 $XDG_RUNTIME_DIR

    # Tests need some Qt plugins

    # Many tests try to load Suru theme icons via XDG_DATA_DIRS

    export QT_PLUGIN_PATH=${qtPluginPaths}

    export XDG_DATA_DIRS=${suru-icon-theme}/share

    tests/xvfb.sh make check ''${enableParallelChecking:+-j''${NIX_BUILD_CORES}}

    runHook postCheck

  '';

  preInstall = ''

    # wrapper script calls qmlplugindump, crashes due to lack of minimal platform plugin

    # Could not find the Qt platform plugin "minimal" in ""

    # Available platform plugins are: wayland-egl, wayland, wayland-xcomposite-egl, wayland-xcomposite-glx.

    export QT_PLUGIN_PATH=${qtPluginPaths}

    # Qt-generated wrapper script lacks QML paths to dependencies

    for qmlModule in Components PerformanceMetrics Test; do

      substituteInPlace src/imports/$qmlModule/wrapper.sh \

        --replace 'QML2_IMPORT_PATH=' 'QML2_IMPORT_PATH=${qtQmlPaths}:'

    done

  '';

  postInstall = ''

    # Code loads Qt's qt_module.prf, which force-overrides all QMAKE_PKGCONFIG_* variables except PREFIX for QMake-generated pkg-config files

    for pcFile in Lomiri{Gestures,Metrics,Toolkit}.pc; do

      substituteInPlace $out/lib/pkgconfig/$pcFile \

        --replace "${lib.getLib qtbase}/lib" "\''${prefix}/lib" \

        --replace "${lib.getDev qtbase}/include" "\''${prefix}/include"

    done

    # These are all dev-related tools, but declaring a bin output also moves around the QML modules

    moveToOutput "bin" "$dev"

  '';

  postFixup = ''

    for qtBin in $dev/bin/{apicheck,lomiri-ui-toolkit-launcher}; do

      wrapQtApp $qtBin

    done

  '';

  passthru = {

    tests.pkg-config = testers.testMetaPkgConfig finalAttrs.finalPackage;

    updateScript = gitUpdater { };

  };

  meta = with lib; {

    description = "QML components to ease the creation of beautiful applications in QML";

    longDescription = ''

      This project consists of a set of QML components to ease the creation of beautiful applications in QML for Lomiri.

      QML alone lacks built-in components for basic widgets like Button, Slider, Scrollbar, etc, meaning a developer has

      to build them from scratch.

      This toolkit aims to stop this duplication of work, supplying beautiful components ready-made and with a clear and

      consistent API.

      These components are fully themeable so the look and feel can be easily customized. Resolution independence

      technology is built in so UIs are scaled to best suit the display.

      Other features:

        - localisation through gettext

    '';

    homepage = "https://gitlab.com/ubports/development/core/lomiri-ui-toolkit";

    license = with licenses; [ gpl3Only cc-by-sa-30 ];

    maintainers = teams.lomiri.members;

    platforms = platforms.linux;

    pkgConfigModules = [

      "LomiriGestures"

      "LomiriMetrics"

      "LomiriToolkit"

    ];

  };

})