Merge pull request #7629 from VersatusHPC/harvest/template-xcatroot-fallback

fix(template): fall back to $::XCATROOT when XCATROOT is not in %ENV

xCAT-server/lib/perl/xCAT/Template.pm

@@ -1617,6 +1617,8 @@ sub envvar
         $envvar =~ s/^\$//;
     }
 
+    return $::XCATROOT if $envvar eq 'XCATROOT' && !exists $ENV{XCATROOT};
+
     return ($ENV{$envvar});
 }
 

xCAT-test/autotest/testcase/template_unit/cases0

@@ -0,0 +1,8 @@
+start:template_envvar_unit_tests
+description:Run the template environment-variable unit test through xcattest.
+os:Linux
+label:mn_only,ci_test,unit,template_unit
+cmd:prove -I/opt/xcat/lib/perl /opt/xcat/share/xcat/tools/autotest/unit/template_envvar.t
+check:rc==0
+check:output=~All tests successful
+end

xCAT-test/unit/template_envvar.t

@@ -0,0 +1,50 @@
+#!/usr/bin/env perl
+use strict;
+use warnings;
+
+use FindBin;
+use lib "$FindBin::Bin/../../perl-xCAT";
+use lib "$FindBin::Bin/../../xCAT-server/lib/perl";
+use Test::More;
+use xCAT::Template;
+
+local $::XCATROOT = '/opt/xcat-from-package';
+
+{
+    local $ENV{XCATROOT} = '/opt/xcat-from-environment';
+    is(
+        xCAT::Template::envvar('XCATROOT'),
+        '/opt/xcat-from-environment',
+        'an explicit XCATROOT environment value keeps precedence',
+    );
+}
+
+{
+    local $ENV{XCATROOT};
+    delete $ENV{XCATROOT};
+    is(
+        xCAT::Template::envvar('$XCATROOT'),
+        '/opt/xcat-from-package',
+        'the package global supplies XCATROOT when the environment omits it',
+    );
+}
+
+{
+    local $ENV{XCATROOT} = '';
+    is(
+        xCAT::Template::envvar('XCATROOT'),
+        '',
+        'an explicitly empty XCATROOT is not replaced by the fallback',
+    );
+}
+
+{
+    local $ENV{TEMPLATE_ENVVAR_TEST} = 'from-environment';
+    is(
+        xCAT::Template::envvar('TEMPLATE_ENVVAR_TEST'),
+        'from-environment',
+        'other template environment variables remain unchanged',
+    );
+}
+
+done_testing();