mirror of
https://github.com/keymanapp/keyman.git
synced 2026-10-08 15:07:33 +00:00
1b4e254963
With this change it's possible to build Keyman from the source tarball by running `./build.sh` from the Keyman root directory. When building Keyman as part of the Ubuntu/Debian packaging, we don't use the toplevel `build.sh` file but instead call the build scripts in the subdirectories. This omits building some components that are currently not needed for running Keyman for Linux. The `dist.sh` script only includes the necessary files in this case, distinguished by the `origdist` parameter. This results in a significantly smaller tarball (2.5MB vs 51MB). This change also enhances the `generate_tar_ignore_list` function so that it is now possible to add `build` to the exclude list to ignore all `build` subdirectories. Fixes: #15544 Build-bot: skip Test-bot: skip
382 lines
13 KiB
Bash
Executable file
382 lines
13 KiB
Bash
Executable file
#!/usr/bin/env bash
|
|
# shellcheck disable=2034,1091,2154
|
|
set -eu
|
|
|
|
## START STANDARD BUILD SCRIPT INCLUDE
|
|
# adjust relative paths as necessary
|
|
THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
|
|
. "${THIS_SCRIPT%/*}/../../../resources/build/builder-basic.inc.sh"
|
|
## END STANDARD BUILD SCRIPT INCLUDE
|
|
|
|
. "${KEYMAN_ROOT}/resources/build/test/testing-framework.inc.sh"
|
|
. "${KEYMAN_ROOT}/linux/scripts/package-build.inc.sh"
|
|
|
|
function setup_file() {
|
|
temp_dir="$(mktemp -d)"
|
|
# Create directory structure for testing
|
|
# /
|
|
# /subdir1
|
|
# /build/foo
|
|
# /build.sh
|
|
# /README.md
|
|
# /path1
|
|
# /abc.build
|
|
# /build/foo
|
|
# /build.sh
|
|
# /README.md
|
|
# /x/z.txt
|
|
# /xy/z.txt
|
|
# /path2
|
|
# /build/foo
|
|
# /build.sh
|
|
# /path3
|
|
# /build/foo
|
|
# /build.sh
|
|
# /subdir2
|
|
# /build/foo
|
|
# /build.sh
|
|
# /path1
|
|
# /build/foo
|
|
# /subdir3
|
|
# /build/foo
|
|
# /build.sh
|
|
# /path1
|
|
# /build/foo
|
|
# /path2
|
|
# /build/foo
|
|
# /path3
|
|
# /subdir4
|
|
# /build/foo
|
|
# /build.sh
|
|
# /path1
|
|
# /build.sh
|
|
# /path2
|
|
# /subpath1
|
|
# /build/foo
|
|
# /build.sh
|
|
# /subpath2
|
|
# /build/foo
|
|
# /build.sh
|
|
# /path3
|
|
# /build.sh
|
|
# /build.sh
|
|
# subdir1/path2, subdir2, subdir4/path1, subdir4/path2/subpath1,
|
|
# and subdir4/path3 will be ignored
|
|
# all build/ directories will be ignored with the exception of
|
|
# subdir3/build.
|
|
mkdir -p "${temp_dir}/subdir1/build" # exclude
|
|
touch "${temp_dir}/subdir1/build/foo" # exclude
|
|
mkdir -p "${temp_dir}/subdir1/path1/build"
|
|
touch "${temp_dir}/subdir1/path1/build/foo" # exclude
|
|
mkdir -p "${temp_dir}/subdir1/path1/x"
|
|
touch "${temp_dir}/subdir1/path1/x/z.txt"
|
|
mkdir -p "${temp_dir}/subdir1/path1/xy"
|
|
touch "${temp_dir}/subdir1/path1/xy/z.txt"
|
|
touch "${temp_dir}/subdir1/build.sh" # include
|
|
touch "${temp_dir}/subdir1/README.md" # exclude
|
|
touch "${temp_dir}/subdir1/path1/abc.build"
|
|
touch "${temp_dir}/subdir1/path1/build.sh" # include
|
|
touch "${temp_dir}/subdir1/path1/README.md" # exclude
|
|
mkdir -p "${temp_dir}/subdir1/path2/build"
|
|
touch "${temp_dir}/subdir1/path2/build/foo" # exclude
|
|
touch "${temp_dir}/subdir1/path2/build.sh" # exclude
|
|
mkdir -p "${temp_dir}/subdir1/path3/build"
|
|
touch "${temp_dir}/subdir1/path2/build/foo" # exclude
|
|
touch "${temp_dir}/subdir1/path3/build.sh" # include
|
|
mkdir -p "${temp_dir}/subdir2/build" # exclude
|
|
touch "${temp_dir}/subdir2/build/foo" # exclude
|
|
mkdir -p "${temp_dir}/subdir2/path1/build" # exclude
|
|
touch "${temp_dir}/subdir2/path1/build/foo" # exclude
|
|
touch "${temp_dir}/subdir2/build.sh"
|
|
mkdir -p "${temp_dir}/subdir3/build" # include
|
|
touch "${temp_dir}/subdir3/build/foo" # include
|
|
mkdir -p "${temp_dir}/subdir3/path1" # include
|
|
touch "${temp_dir}/subdir3/build.sh"
|
|
mkdir -p "${temp_dir}/subdir3/path1/build" # exclude
|
|
touch "${temp_dir}/subdir3/path1/build/foo" # exclude
|
|
mkdir -p "${temp_dir}/subdir3/path2" # include
|
|
mkdir -p "${temp_dir}/subdir3/path2/build" # exclude
|
|
touch "${temp_dir}/subdir3/path2/build/foo" # exclude
|
|
mkdir -p "${temp_dir}/subdir3/path3" # include
|
|
mkdir -p "${temp_dir}/subdir4/build" # exclude
|
|
touch "${temp_dir}/subdir4/build/foo" # exclude
|
|
mkdir -p "${temp_dir}/subdir4/path1" # exclude
|
|
touch "${temp_dir}/subdir4/build.sh"
|
|
touch "${temp_dir}/subdir4/path1/build.sh"
|
|
mkdir -p "${temp_dir}/subdir4/path2/subpath1" # exclude
|
|
touch "${temp_dir}/subdir4/path2/subpath1/build.sh"
|
|
mkdir -p "${temp_dir}/subdir4/path2/subpath1/build" # exclude
|
|
touch "${temp_dir}/subdir4/path2/subpath1/build/foo" # exclude
|
|
mkdir -p "${temp_dir}/subdir4/path2/subpath2" # include
|
|
touch "${temp_dir}/subdir4/path2/subpath2/build.sh"
|
|
mkdir -p "${temp_dir}/subdir4/path2/subpath2/build" # exclude
|
|
touch "${temp_dir}/subdir4/path2/subpath2/build/foo" # exclude
|
|
mkdir -p "${temp_dir}/subdir4/path3" # exclude
|
|
touch "${temp_dir}/subdir4/path3/build.sh"
|
|
touch "${temp_dir}/subdir4/path3/other.txt"
|
|
touch "${temp_dir}/build.sh"
|
|
}
|
|
|
|
function teardown_file() {
|
|
rm -rf "${temp_dir}"
|
|
}
|
|
|
|
function test__generate_tar_ignore_list__basic() {
|
|
to_include=(subdir1/path1 subdir1/path3 subdir3 subdir4/path2)
|
|
to_exclude=(subdir1/README.md subdir4/path2/subpath1 subdir4/path2/subpath3)
|
|
|
|
cd "${temp_dir}"
|
|
ignored_files=()
|
|
|
|
# Execute
|
|
generate_tar_ignore_list "./" to_include to_exclude ignored_files test1
|
|
|
|
# Verify
|
|
expected=(
|
|
--tar-ignore=test1/build.sh
|
|
--tar-ignore=test1/subdir1/build
|
|
--tar-ignore=test1/subdir1/build.sh
|
|
--tar-ignore=test1/subdir1/path2
|
|
--tar-ignore=test1/subdir1/README.md
|
|
--tar-ignore=test1/subdir2
|
|
--tar-ignore=test1/subdir4/build
|
|
--tar-ignore=test1/subdir4/build.sh
|
|
--tar-ignore=test1/subdir4/path1
|
|
--tar-ignore=test1/subdir4/path2/subpath1
|
|
--tar-ignore=test1/subdir4/path3
|
|
)
|
|
|
|
assert-equal "${ignored_files[*]}" "${expected[*]}"
|
|
}
|
|
|
|
function test__generate_tar_ignore_list__path_wildcard_in_exclude() {
|
|
# Setup
|
|
to_include=(subdir1/path1 subdir1/path3 subdir3)
|
|
to_exclude=(subdir1/*/README.md subdir4/path2/subpath1 subdir4/path2/subpath3)
|
|
|
|
cd "${temp_dir}"
|
|
ignored_files=()
|
|
|
|
# Execute
|
|
generate_tar_ignore_list "./" to_include to_exclude ignored_files foo
|
|
|
|
# Verify
|
|
expected=(
|
|
--tar-ignore=foo/build.sh # not in include
|
|
--tar-ignore=foo/subdir1/build # not in include
|
|
--tar-ignore=foo/subdir1/build.sh # not in include
|
|
--tar-ignore=foo/subdir1/path1/README.md # in exclude
|
|
--tar-ignore=foo/subdir1/path2 # not in include
|
|
--tar-ignore=foo/subdir1/README.md # not in include
|
|
--tar-ignore=foo/subdir2 # not in include
|
|
--tar-ignore=foo/subdir4 # not in include
|
|
)
|
|
|
|
assert-equal "${ignored_files[*]}" "${expected[*]}"
|
|
}
|
|
|
|
function test__generate_tar_ignore_list__file_wildcard_in_exclude() {
|
|
# Setup
|
|
to_include=(subdir1/path1 subdir1/path3 subdir3)
|
|
to_exclude=(*.sh)
|
|
|
|
cd "${temp_dir}"
|
|
ignored_files=()
|
|
|
|
# Execute
|
|
generate_tar_ignore_list "./" to_include to_exclude ignored_files keyman
|
|
|
|
# Verify
|
|
expected=(
|
|
--tar-ignore=keyman/build.sh # not in include
|
|
--tar-ignore=keyman/subdir1/build # not in include
|
|
--tar-ignore=keyman/subdir1/build.sh # not in include
|
|
--tar-ignore=keyman/subdir1/path1/build.sh # in exclude
|
|
--tar-ignore=keyman/subdir1/path2 # not in include
|
|
--tar-ignore=keyman/subdir1/path3/build.sh # in exclude
|
|
--tar-ignore=keyman/subdir1/README.md # not in include
|
|
--tar-ignore=keyman/subdir2 # not in include
|
|
--tar-ignore=keyman/subdir3/build.sh # in exclude
|
|
--tar-ignore=keyman/subdir4 # not in include
|
|
)
|
|
|
|
assert-equal "${ignored_files[*]}" "${expected[*]}"
|
|
}
|
|
|
|
function test__generate_tar_ignore_list__file_wildcard_in_include() {
|
|
# Setup
|
|
to_include=(subdir1/path1 subdir1/path3 subdir3 subdir4/path3/*.sh)
|
|
to_exclude=(subdir1/README.md subdir4/path2/subpath1 subdir4/path2/subpath3)
|
|
|
|
cd "${temp_dir}"
|
|
ignored_files=()
|
|
|
|
# Execute
|
|
generate_tar_ignore_list "./" to_include to_exclude ignored_files xyz
|
|
|
|
# Verify
|
|
expected=(
|
|
--tar-ignore=xyz/build.sh # not in include
|
|
--tar-ignore=xyz/subdir1/build # not in include
|
|
--tar-ignore=xyz/subdir1/build.sh # not in include
|
|
--tar-ignore=xyz/subdir1/path2 # not in include
|
|
--tar-ignore=xyz/subdir1/README.md # in exclude
|
|
--tar-ignore=xyz/subdir2 # not in include
|
|
--tar-ignore=xyz/subdir4/build # not in include
|
|
--tar-ignore=xyz/subdir4/build.sh # not in include
|
|
--tar-ignore=xyz/subdir4/path1 # not in include
|
|
--tar-ignore=xyz/subdir4/path2 # not in include
|
|
--tar-ignore=xyz/subdir4/path3/other.txt # not in include
|
|
)
|
|
|
|
assert-equal "${ignored_files[*]}" "${expected[*]}"
|
|
}
|
|
|
|
function test__generate_tar_ignore_list__path_wildcard_in_include() {
|
|
# Setup
|
|
to_include=(subdir1/path1 subdir1/path3 subdir3 subdir4/*/subpath2)
|
|
to_exclude=(subdir1/README.md)
|
|
|
|
cd "${temp_dir}"
|
|
ignored_files=()
|
|
|
|
# Execute
|
|
generate_tar_ignore_list "./" to_include to_exclude ignored_files bar
|
|
|
|
# Verify
|
|
expected=(
|
|
--tar-ignore=bar/build.sh # not in include
|
|
--tar-ignore=bar/subdir1/build # not in include
|
|
--tar-ignore=bar/subdir1/build.sh # not in include
|
|
--tar-ignore=bar/subdir1/path2 # not in include
|
|
--tar-ignore=bar/subdir1/README.md # not in include
|
|
--tar-ignore=bar/subdir2 # not in include
|
|
--tar-ignore=bar/subdir4/build # not in include
|
|
--tar-ignore=bar/subdir4/build.sh # not in include
|
|
--tar-ignore=bar/subdir4/path1 # not in include
|
|
--tar-ignore=bar/subdir4/path2/subpath1 # not in include
|
|
--tar-ignore=bar/subdir4/path3 # not in include
|
|
)
|
|
|
|
assert-equal "${ignored_files[*]}" "${expected[*]}"
|
|
}
|
|
|
|
function test__generate_tar_ignore_list__exclude_subsubdir() {
|
|
to_include=(subdir4)
|
|
to_exclude=(subdir4/path2/subpath2)
|
|
|
|
cd "${temp_dir}"
|
|
ignored_files=()
|
|
|
|
# Execute
|
|
generate_tar_ignore_list "./" to_include to_exclude ignored_files baz
|
|
|
|
# Verify
|
|
expected=(
|
|
--tar-ignore=baz/build.sh # not in include
|
|
--tar-ignore=baz/subdir1 # not in include
|
|
--tar-ignore=baz/subdir2 # not in include
|
|
--tar-ignore=baz/subdir3 # not in include
|
|
--tar-ignore=baz/subdir4/path2/subpath2 # in exclude
|
|
)
|
|
|
|
assert-equal "${ignored_files[*]}" "${expected[*]}"
|
|
}
|
|
|
|
function test__generate_tar_ignore_list__exclude_build_Dirs() {
|
|
to_include=(subdir1/path1 subdir1/path3 subdir3 subdir3/build subdir4/path2)
|
|
to_exclude=(subdir1/README.md subdir4/path2/subpath1 subdir4/path2/subpath3 build)
|
|
|
|
cd "${temp_dir}"
|
|
ignored_files=()
|
|
|
|
# Execute
|
|
generate_tar_ignore_list "./" to_include to_exclude ignored_files wildcard
|
|
|
|
# Verify
|
|
expected=(
|
|
--tar-ignore=wildcard/build.sh # not in include
|
|
--tar-ignore=wildcard/subdir1/build # in exclude
|
|
--tar-ignore=wildcard/subdir1/build.sh # not in include
|
|
--tar-ignore=wildcard/subdir1/path1/build # in exclude
|
|
--tar-ignore=wildcard/subdir1/path2 # not in include
|
|
--tar-ignore=wildcard/subdir1/path3/build # in exclude
|
|
--tar-ignore=wildcard/subdir1/README.md # in exclude
|
|
--tar-ignore=wildcard/subdir2 # not in include
|
|
--tar-ignore=wildcard/subdir3/path1/build # in exclude
|
|
--tar-ignore=wildcard/subdir3/path2/build # in exclude
|
|
--tar-ignore=wildcard/subdir4/build # in exclude
|
|
--tar-ignore=wildcard/subdir4/build.sh # not in include
|
|
--tar-ignore=wildcard/subdir4/path1 # not in include
|
|
--tar-ignore=wildcard/subdir4/path2/subpath1 # in exclude
|
|
--tar-ignore=wildcard/subdir4/path2/subpath2/build # in exclude
|
|
--tar-ignore=wildcard/subdir4/path3 # not in include
|
|
)
|
|
|
|
assert-equal "${ignored_files[*]}" "${expected[*]}"
|
|
}
|
|
|
|
function test__generate_tar_ignore_list__exclude_xy() {
|
|
to_include=(subdir1 subdir2 subdir3 subdir4)
|
|
to_exclude=(xy)
|
|
|
|
cd "${temp_dir}"
|
|
ignored_files=()
|
|
|
|
# Execute
|
|
generate_tar_ignore_list "./" to_include to_exclude ignored_files wildcard
|
|
|
|
# Verify
|
|
expected=(
|
|
--tar-ignore=wildcard/build.sh # not in include
|
|
--tar-ignore=wildcard/subdir1/path1/xy # in exclude
|
|
)
|
|
|
|
assert-equal "${ignored_files[*]}" "${expected[*]}"
|
|
}
|
|
|
|
function test__generate_tar_ignore_list__exclude_x_doesnot_exclude_xy() {
|
|
to_include=(subdir1 subdir2 subdir3 subdir4)
|
|
to_exclude=(x)
|
|
|
|
cd "${temp_dir}"
|
|
ignored_files=()
|
|
|
|
# Execute
|
|
generate_tar_ignore_list "./" to_include to_exclude ignored_files wildcard
|
|
|
|
# Verify
|
|
expected=(
|
|
--tar-ignore=wildcard/build.sh # not in include
|
|
--tar-ignore=wildcard/subdir1/path1/x # in exclude
|
|
)
|
|
|
|
assert-equal "${ignored_files[*]}" "${expected[*]}"
|
|
}
|
|
|
|
function test__generate_tar_ignore_list__can_include_toplevel_files() {
|
|
to_include=(subdir1 subdir3 ./build.sh)
|
|
to_exclude=(*.sh)
|
|
|
|
cd "${temp_dir}"
|
|
ignored_files=()
|
|
|
|
# Execute
|
|
generate_tar_ignore_list "./" to_include to_exclude ignored_files top
|
|
|
|
# Verify
|
|
expected=(
|
|
--tar-ignore=top/subdir1/build.sh # in exclude
|
|
--tar-ignore=top/subdir1/path1/build.sh # in exclude
|
|
--tar-ignore=top/subdir1/path2/build.sh # in exclude
|
|
--tar-ignore=top/subdir1/path3/build.sh # in exclude
|
|
--tar-ignore=top/subdir2 # not in include
|
|
--tar-ignore=top/subdir3/build.sh # in exclude
|
|
--tar-ignore=top/subdir4 # not in include
|
|
)
|
|
|
|
assert-equal "${ignored_files[*]}" "${expected[*]}"
|
|
}
|
|
|
|
# shellcheck disable=2119
|
|
run_tests
|