build-support/php: DRY improvements (#419094) (6ab71ddb) · Commits · nix / nixpkgs

pkgs/build-support/php/builders/v2/hooks/composer-install-hook.sh

+37 −34

Original line number	Diff line number	Diff line
		declare -g version
		# shellcheck shell=bash

		declare -g out
		declare -g pname
		declare -g composerVendor
		declare -g -i composerStrictValidation="${composerStrictValidation:-0}"
		@@ -8,6 +10,7 @@ preBuildHooks+=(composerInstallBuildHook)
		preCheckHooks+=(composerInstallCheckHook)
		preInstallHooks+=(composerInstallInstallHook)

		# shellcheck source=/dev/null
		source @phpScriptUtils@

		composerInstallConfigureHook() {
		@@ -20,10 +23,10 @@ composerInstallConfigureHook() {
		exit 1
		fi

		install -Dm644 ${composerVendor}/composer.json .
		install -Dm644 "${composerVendor}"/composer.json .

		if [[ -f "${composerVendor}/composer.lock" ]]; then
		install -Dm644 ${composerVendor}/composer.lock .
		install -Dm644 "${composerVendor}"/composer.lock .
		fi

		if [[ -f "composer.lock" ]]; then
		@@ -52,7 +55,7 @@ composerInstallCheckHook() {
		composerInstallInstallHook() {
		echo "Executing composerInstallInstallHook"

		cp -ar ${composerVendor}/* .
		cp -ar "${composerVendor}"/* .

		# Copy the relevant files only in the store.
		mkdir -p "$out"/share/php/"${pname}"

pkgs/build-support/php/builders/v2/hooks/composer-vendor-hook.sh

+88 −83

Original line number	Diff line number	Diff line
		# shellcheck shell=bash

		# shellcheck source=/dev/null
		source @phpScriptUtils@

		declare -g out
		declare -g composerLock
		declare -g composerNoDev="${composerNoDev:+--no-dev}"
		declare -g composerNoPlugins="${composerNoPlugins:+--no-plugins}"
		declare -g composerNoScripts="${composerNoScripts:+--no-scripts}"
		@@ -20,7 +25,7 @@ composerVendorConfigureHook() {

		if [[ -e "$composerLock" ]]; then
		echo -e "\e[32mUsing user provided \`composer.lock\` file from \`$composerLock\`\e[0m"
		install -Dm644 $composerLock ./composer.lock
		install -Dm644 "$composerLock" ./composer.lock
		fi

		if [[ ! -f "composer.lock" ]]; then
		@@ -30,13 +35,13 @@ composerVendorConfigureHook() {
		--no-interaction \
		--no-progress \
		--optimize-autoloader \
		${composerNoDev} \
		${composerNoPlugins} \
		${composerNoScripts} \
		"${composerNoDev}" \
		"${composerNoPlugins}" \
		"${composerNoScripts}" \
		update

		if [[ -f "composer.lock" ]]; then
		install -Dm644 composer.lock -t $out/
		install -Dm644 composer.lock -t "$out"/

		echo
		echo -e "\e[31mERROR: No composer.lock found\e[0m"
		@@ -74,9 +79,9 @@ composerVendorBuildHook() {
		--no-interaction \
		--no-progress \
		--optimize-autoloader \
		${composerNoDev} \
		${composerNoPlugins} \
		${composerNoScripts} \
		"${composerNoDev}" \
		"${composerNoPlugins}" \
		"${composerNoScripts}" \
		install

		echo "Finished composerVendorBuildHook"
		@@ -93,27 +98,27 @@ composerVendorCheckHook() {
		composerVendorInstallHook() {
		echo "Executing composerVendorInstallHook"

		mkdir -p $out
		mkdir -p "$out"

		cp -ar composer.json $(composer config vendor-dir) $out/
		cp -ar composer.json "$(composer config vendor-dir)" "$out"/
		mapfile -t installer_paths < <(jq -r -c 'try((.extra."installer-paths") \| keys[])' composer.json)

		for installer_path in "${installer_paths[@]}"; do
		# Remove everything after {$name} placeholder
		installer_path="${installer_path/\{\$name\}*/}";
		out_installer_path="$out/${installer_path/\{\$name\}*/}";
		installer_path="${installer_path/\{\$name\}*/}"
		out_installer_path="$out/${installer_path/\{\$name\}*/}"
		# Copy the installer path if it exists
		if [[ -d "$installer_path" ]]; then
		mkdir -p $(dirname "$out_installer_path")
		mkdir -p "$(dirname "$out_installer_path")"
		echo -e "\e[32mCopying installer path $installer_path to $out_installer_path\e[0m"
		cp -ar "$installer_path" "$out_installer_path"
		# Strip out the git repositories
		find $out_installer_path -name .git -type d -prune -print -exec rm -rf {} ";"
		find "$out_installer_path" -name .git -type d -prune -print -exec rm -rf {} ";"
		fi
		done

		if [[ -f "composer.lock" ]]; then
		cp -ar composer.lock $out/
		cp -ar composer.lock "$out"/
		fi

		echo "Finished composerVendorInstallHook"

pkgs/build-support/php/builders/v2/hooks/php-script-utils.bash

+58 −68

Original line number	Diff line number	Diff line
		# shellcheck shell=bash

		declare -g version
		declare -g -i composerStrictValidation="${composerStrictValidation:-0}"

		@@ -18,7 +20,6 @@ setComposerEnvVariables() {
		checkComposerValidate() {
		command="composer validate --strict --quiet --no-interaction --no-check-all --no-check-lock"
		if ! $command; then
		if [[ "${composerStrictValidation}" == "1" ]]; then
		echo
		echo -e "\e[31mERROR: composer files validation failed\e[0m"
		echo
		@@ -29,17 +30,13 @@ checkComposerValidate() {
		echo -e '\e[31m 1. File an issue in the project'\''s issue tracker with detailed information, and apply any available remote patches as a temporary solution '$'with fetchpatch'$'.\e[0m'
		echo -e '\e[31m 2. If an immediate fix is needed or if reporting upstream isn'\''t suitable, develop a temporary local patch.\e[0m'
		echo
		exit 1
		else
		echo
		echo -e "\e[33mWARNING: composer files validation failed\e[0m"

		if [[ "${composerStrictValidation}" == "1" ]]; then
		echo
		echo -e '\e[33mThe validation of the composer.json failed.\e[0m'
		echo -e '\e[33mMake sure that the file composer.json is valid.\e[0m'
		echo -e '\e[33mThis check is blocking, set the attribute composerStrictValidation to false to make it not blocking.\e[0m'
		echo
		echo -e '\e[33mTo address the issue efficiently, follow one of these steps:\e[0m'
		echo -e '\e[33m 1. File an issue in the project'\''s issue tracker with detailed information, and apply any available remote patches as a temporary solution with '$'with fetchpatch'$'.\e[0m'
		echo -e '\e[33m 2. If an immediate fix is needed or if reporting upstream isn'\''t suitable, develop a temporary local patch.\e[0m'
		exit 1
		else
		echo
		echo -e '\e[33mThis check is not blocking, but it is recommended to fix the issue.\e[0m'
		echo
		@@ -48,7 +45,6 @@ checkComposerValidate() {

		command="composer validate --strict --no-ansi --no-interaction --quiet --no-check-all --check-lock"
		if ! $command; then
		if [[ "${composerStrictValidation}" == "1" ]]; then
		echo
		echo -e "\e[31mERROR: composer files validation failed\e[0m"
		echo
		@@ -61,19 +57,13 @@ checkComposerValidate() {
		echo -e '\e[31m 1. File an issue in the project'\''s issue tracker with detailed information '$'run '\''composer update --lock --no-install'\'' to fix the issue'$', and apply any available remote patches as a temporary solution with '$'with fetchpatch'$'.\e[0m'
		echo -e '\e[31m 2. If an immediate fix is needed or if reporting upstream isn'\''t suitable, develop a temporary local patch.\e[0m'
		echo
		exit 1
		else
		echo
		echo -e "\e[33mWARNING: composer files validation failed\e[0m"
		echo
		echo -e '\e[33mThe validation of the composer.json and composer.lock failed.\e[0m'
		echo -e '\e[33mMake sure that the file composer.lock is consistent with composer.json.\e[0m'

		if [[ "${composerStrictValidation}" == "1" ]]; then
		echo
		echo -e '\e[33mThis often indicates an issue with the upstream project, which can typically be resolved by reporting the issue to the relevant project maintainers.\e[0m'
		echo -e '\e[33mThis check is blocking, set the attribute composerStrictValidation to false to make it not blocking.\e[0m'
		echo
		echo -e '\e[33mTo address the issue efficiently, follow one of these steps:\e[0m'
		echo -e '\e[33m 1. File an issue in the project'\''s issue tracker with detailed information '$'run '\''composer update --lock --no-install'\'' to fix the issue'$', and apply any available remote patches as a temporary solution with '$'with fetchpatch'$'.\e[0m'
		echo -e '\e[33m 2. If an immediate fix is needed or if reporting upstream isn'\''t suitable, develop a temporary local patch.\e[0m'
		exit 1
		else
		echo
		echo -e '\e[33mThis check is not blocking, but it is recommended to fix the issue.\e[0m'
		echo

Admin message