allow only linux, perldoc 80 chars and send_result activate

Author: MankiratSingh1315

PGBuild/Modules/ABICompCheck.pm

@@ -9,10 +9,10 @@ See accompanying License file for license details
 
 =head1 PGBuild::Modules::ABICompCheck
 
-This module is used for ABI compliance checking of PostgreSQL builds 
-by comparing the latest commit on a stable branch with the most recent
-tag on that branch. This helps detect unintended changes that could
-break compatibility for extensions or client applications.
+This module is used for ABI compliance checking of PostgreSQL builds by
+comparing the latest commit on a stable branch with the most recent tag on that
+branch. This helps detect unintended changes that could break compatibility for
+extensions or client applications.
 
 =head2 EXECUTION FLOW
 
@@ -22,58 +22,75 @@ The module follows these steps to perform an ABI comparison:
 
 =item 1.
 
-The build farm completes its standard build and installation of PostgreSQL for the latest commit on a given stable branch.
+The build farm completes its standard build and installation of PostgreSQL for
+the latest commit on a given stable branch.
 
 =item 2.
 
 The C<install> hook of the ABICompCheck module is triggered.
 
 =item 3.
 
-The module identifies the most recent tag for a particular branch (e.g., REL_16_1) to use as a baseline for comparison against the most recent commit of the branch.
+The module identifies the most recent tag for a particular branch (e.g.,
+REL_16_1) to use as a baseline for comparison against the most recent commit of
+the branch.
 
 =item 4.
 
-It checks if a pre-existing, complete build and ABI dump for this baseline tag exists in its working directory (C<buildroot/abicheck.$animal_name>).
+It checks if a pre-existing, complete build and ABI dump for this baseline tag
+exists in its working directory (C<buildroot/abicheck.$animal_name>).
 
 =item 5.
 
-If the baseline tag's build is missing or incomplete, the module performs a fresh build of that tag:
+If the baseline tag's build is missing or incomplete, the module performs a
+fresh build of that tag:
 	- It checks out the source code for the tag.
-	- It runs C<configure>, C<make>, and C<make install> for the tag in an isolated directory.
-	- It uses C<abidw> to generate XML representations of the ABI for key binaries (like C<postgres>, C<libpq.so>, C<ecpg> - These are the default binaries and can be customised by animal owners) from this tag build. These are stored for future runs.
+	- It runs C<configure>, C<make>, and C<make install> for the tag in an
+	  isolated directory.
+	- It uses C<abidw> to generate XML representations of the ABI for key
+	  binaries (like C<postgres>, C<libpq.so>, C<ecpg> - These are the
+	  default binaries and can be customised by animal owners) from this tag
+	  build. These are stored for future runs.
 
 =item 6.
 
-The module then generates ABI XML files for the same set of key binaries from the main build (the latest commit).
+The module then generates ABI XML files for the same set of key binaries from
+the main build (the latest commit).
 
 =item 7.
 
-Using C<abidiff>, it compares the ABI XML file of each binary from the latest commit against the corresponding file from the baseline tag.
+Using C<abidiff>, it compares the ABI XML file of each binary from the latest
+commit against the corresponding file from the baseline tag.
 
 =item 8.
 
-Any differences detected by C<abidiff> are collected into a log report. If no differences are found, a success message is logged.
+Any differences detected by C<abidiff> are collected into a log report. If no
+differences are found, a success message is logged.
 
 =item 9.
 
-The final report, containing either the ABI differences or "no abi diffs found in this run", is sent to the build farm server as part of the overall build status.
+The final report, containing either the ABI differences or "no abi diffs found
+in this run", is sent to the build farm server as part of the overall build
+status.
 
 =back
 
 =head2 CONFIGURATION OPTIONS
 
-The module supports the following configuration options under `abi_comp_check` key in build-farm.conf:
+The module supports the following configuration options under `abi_comp_check`
+key in build-farm.conf:
 
 =over 4
 
 =item B<abi_compare_root>
 
-Specifies the root directory for ABI comparison data. If not set, defaults to C<buildroot/abicheck.$animal_name>.
+Specifies the root directory for ABI comparison data. If not set, defaults to
+C<buildroot/abicheck.$animal_name>.
 
 =item B<binaries_rel_path>
 
-A hash reference mapping binary names to their relative paths for ABI comparison. Defaults to:
+A hash reference mapping binary names to their relative paths for ABI
+comparison. Defaults to:
 
   {
     'postgres' => 'bin/postgres',
@@ -92,7 +109,8 @@ An array reference containing flags to pass to C<abidw>. Defaults to:
 
 =item B<tag_for_branch>
 
-A hash reference mapping branch names to their corresponding tags for ABI comparison. Defaults to empty hash which means latest tags for all branches:
+A hash reference mapping branch names to their corresponding tags for ABI
+comparison. Defaults to empty hash which means latest tags for all branches:
 
   {}
 
@@ -104,19 +122,23 @@ A hash reference mapping branch names to their corresponding tags for ABI compar
 
 =item *
 
-This module have msvc related duped from run_build.pl script but later I realised C<abidiff> supports only elf binaries. Maybe those functions can be used in future if some other ABI Compliance checking tool supports them.
+This module have msvc related duped from run_build.pl script but later I
+realised C<abidiff> supports only elf binaries. Maybe those functions can be
+used in future if some other ABI Compliance checking tool supports them.
 
 =item *
 
-This module only works for stable branches in compliance with the PostgreSQL ABI policy for minor releases.
+This module only works for stable branches in compliance with the PostgreSQL
+ABI policy for minor releases.
 
 =item *
 
 Debug information is required for build to be able to use this module
 
 =item *
 
-Before using this module, ensure that you have the build-essential, abigail-tools, git installed for your animal.
+Before using this module, ensure that you have the build-essential,
+abigail-tools, git installed for your animal.
 
 =back
 
@@ -139,7 +161,7 @@ package PGBuild::Modules::ABICompCheck;
 use PGBuild::Log;
 use PGBuild::Options;
 use PGBuild::SCM;
-use PGBuild::Utils qw(:DEFAULT $branch_root);
+use PGBuild::Utils qw(:DEFAULT $branch_root $steps_completed);
 
 use strict;
 use warnings;
@@ -160,7 +182,7 @@ sub emit {
 
 my $hooks = {
 	# 'need-run' => \&need_run,
-	'install' => \&install,      # Main ABI comparison logic runs after install
+	'installcheck' => \&installcheck,      # Main ABI comparison logic runs after install
 	'cleanup' => \&cleanup,      # Clean up temporary files after build
 };
 
@@ -173,6 +195,12 @@ sub setup
 	my $conf = shift;         # ref to the whole config object
 	my $pgsql = shift;        # postgres build dir
 
+	if ($^O ne 'linux')
+	{
+		emit("Only Linux is supported for ABICompCheck Module, skipping.");
+		return;
+	}
+
 	# Only proceed if this is a stable branch with git SCM, not using msvc
 	if ($conf->{scm} ne 'git')
 	{
@@ -184,11 +212,6 @@ sub setup
 		emit("Skipping ABI check, '$branch' is not a stable branch.");
 		return;
 	}
-	if ($conf->{using_msvc})
-	{
-		emit("MSVC builds are not supported for ABICompCheck Module, skipping.");
-		return;
-	}
 
 	# Ensure debug information is available in compilation - required for libabigail tools
 	if ($conf->{using_meson})
@@ -272,19 +295,19 @@ sub setup
 }
 
 # Main function - runs after PostgreSQL installation to perform ABI comparison
-sub install
+sub installcheck
 {
 	my $self = shift;
 	return unless step_wanted('abi_comp-check');
 
-	emit "install";
+	emit "installcheck";
 	my $scm = PGBuild::SCM->new($self->{bfconf});
 
 	my $pgbranch = $self->{pgbranch};
 	my $abi_compare_loc = "$self->{abi_compare_root}/$pgbranch";
 	mkdir $abi_compare_loc unless -d $abi_compare_loc;
 	my $tag_for_branch = $self->{tag_for_branch} || {};
-	my $latest_tag;
+	my $baseline_tag;
 
 	# find the tag to compare with for the branch
 	if (exists $tag_for_branch->{$pgbranch})
@@ -298,23 +321,23 @@ sub install
 			return;
 		}
 		# use the first tag from the list in case of regex
-		emit "Using $tags[0] as the latest tag for branch $pgbranch based on pattern '$tag_pattern'";
-		$latest_tag = $tags[0];
+		emit "Using $tags[0] as the baseline tag for branch $pgbranch based on pattern '$tag_pattern'";
+		$baseline_tag = $tags[0];
 	}else{
 		emit "Finding latest tag for branch $pgbranch";
-		$latest_tag = run_log(qq{git -C ./pgsql describe --tags --abbrev=0 2>/dev/null});	# Find the latest tag
+		$baseline_tag = run_log(qq{git -C ./pgsql describe --tags --abbrev=0 2>/dev/null});	# Find the latest tag
 	}
-	chomp $latest_tag;
+	chomp $baseline_tag;
 	my $comparison_ref = '';
 	$comparison_ref = run_log(qq{git -C ./pgsql merge-base master bf_$pgbranch});	# Find the very first commit for current branch
 	die "git merge-base failed: $?" if $?;
 	chomp $comparison_ref;
 
-	if ($latest_tag) {
+	if ($baseline_tag) {
 		# if some latest tag is found, then get the commit SHA for the latest tagged commit
 		# and compare with the first commit for current branch
 		# using `git merge-base --is-ancestor A B` to
-		my $tag_commit = run_log(qq{git -C ./pgsql rev-list -n 1 $latest_tag});
+		my $tag_commit = run_log(qq{git -C ./pgsql rev-list -n 1 $baseline_tag});
 		die "git rev-list failed: $?" if $?;
 		chomp $tag_commit;
 
@@ -323,8 +346,8 @@ sub install
 			# If the latest tag is not an ancestor of the first branch commit
 			# we need to use the latest tag as the comparison reference
 			# else we use the first commit of the branch instead of tag
-			$comparison_ref = $latest_tag;
-			emit "Latest tag: $latest_tag";
+			$comparison_ref = $baseline_tag;
+			emit "Baseline tag: $baseline_tag";
 		}
 	}
 
@@ -429,15 +452,16 @@ sub install
 	my ($diff_found, $diff_log) = $self->_compare_and_log_abi_diff($comparison_ref, $pgbranch);
 
 	# Add comparison results to output
+	my $status=0;
 	if ($diff_found)
 	{
 		push(@saveout, $diff_log->log_string);
+		$status=1;
 	}
 	else
 	{
 		push(@saveout, "no abi diffs found in this run\n");
 	}
-
 	# Include tag build logs if we rebuilt
 	if ($rebuild_tag)
 	{
@@ -457,6 +481,9 @@ sub install
 	# Write final report to build farm logs
 	writelog("abi-compliance-check", \@saveout);
 
+	send_result('ABICompCheck', $status, \@saveout) if $status;
+	$steps_completed .= " ABICompCheck";
+
 	return;
 }