Merge pull request #554 from cpanel/subrename

Rename should_run_distro_upgrade to upgrade_distro_manually
cpanel · Nov 20, 2024 · c7a8098 · c7a8098
2 parents 23dbc87 + 9ec66df
commit c7a8098
Show file tree

Hide file tree

Showing 12 changed files with 30 additions and 30 deletions.
diff --git a/elevate-cpanel b/elevate-cpanel
@@ -168,7 +168,7 @@ BEGIN {    # Suppress load of all of these at earliest point.
     BEGIN {
         my @_DELEGATE_TO_CPEV = qw{
           getopt
-          should_run_distro_upgrade
+          upgrade_distro_manually
           ssystem
           ssystem_and_die
           ssystem_capture_output
@@ -686,7 +686,7 @@ BEGIN {    # Suppress load of all of these at earliest point.
 
     sub check ($self) {
 
-        return 1 unless $self->should_run_distro_upgrade;    # skip when --upgrade-distro-manually is provided
+        return 1 unless $self->upgrade_distro_manually;    # skip when --upgrade-distro-manually is provided
 
         my $ok = 0;
         try {
@@ -2262,7 +2262,7 @@ EOS
 
     sub verify_cmdline ($self) {
         return unless -x GRUBBY_PATH;
-        if ( $self->cpev->should_run_distro_upgrade() ) {
+        if ( $self->cpev->upgrade_distro_manually() ) {
             my $arg = "elevate-" . _persistent_id;
             INFO("Checking for \"$arg\" in booted kernel's command line...");
 
@@ -2448,7 +2448,7 @@ EOS
     sub check ($self) {
 
         return 1 unless Elevate::OS::needs_leapp();
-        return 1 unless $self->should_run_distro_upgrade;    # skip when --upgrade-distro-manually is provided
+        return 1 unless $self->upgrade_distro_manually;    # skip when --upgrade-distro-manually is provided
 
         my $ok = 1;
         $ok = 0 unless $self->_blocker_grub2_workaround;
@@ -3006,7 +3006,7 @@ EOS
 
     sub check ($self) {    # $self is a cpev object here
 
-        return 0 unless $self->should_run_distro_upgrade;
+        return 0 unless $self->upgrade_distro_manually;
 
         if ( _is_container_envtype() ) {
             return $self->has_blocker( <<~'EOS');
@@ -3328,7 +3328,7 @@ EOS
 
         return unless Elevate::OS::needs_leapp();
 
-        return unless $self->should_run_distro_upgrade;    # skip when --upgrade-distro-manually is provided
+        return unless $self->upgrade_distro_manually;    # skip when --upgrade-distro-manually is provided
 
         return if ( $self->components->num_blockers_found() > 0 );    # skip if any blockers have already been found
 
@@ -4162,7 +4162,7 @@ EOS
     sub check ($self) {
 
         return 1 unless Elevate::OS::needs_leapp();
-        return 1 unless $self->should_run_distro_upgrade;
+        return 1 unless $self->upgrade_distro_manually;
 
         return $self->_blocker_bad_nics_naming;
     }
@@ -8519,7 +8519,7 @@ deb https://wp-toolkit.plesk.com/cPanel/Ubuntu-22.04-x86_64/latest/thirdparty/ .
 
     sub upgrade ($self) {
 
-        return unless $self->cpev->should_run_distro_upgrade();
+        return unless $self->cpev->upgrade_distro_manually();
 
         $self->cpev->run_once(
             setup_answer_file => sub {
@@ -8648,7 +8648,7 @@ deb https://wp-toolkit.plesk.com/cPanel/Ubuntu-22.04-x86_64/latest/thirdparty/ .
     sub wait_for_leapp_completion ($self) {
         return 1 unless Elevate::OS::needs_leapp();
 
-        return 1 unless $self->cpev->should_run_distro_upgrade();
+        return 1 unless $self->cpev->upgrade_distro_manually();
 
         my $upgrade_log = LEAPP_UPGRADE_LOG;
 
@@ -10714,7 +10714,7 @@ sub run_stage_1 ($self) {
 
     Elevate::Motd->setup();
 
-    if ( !$self->should_run_distro_upgrade() ) {
+    if ( !$self->upgrade_distro_manually() ) {
         Elevate::Stages::bump_stage();
         return ACTION_CONTINUE;
     }
@@ -10793,7 +10793,7 @@ sub run_stage_3 ($self) {
 
     $self->run_once('run_final_components_pre_distro_upgrade');
 
-    if ( !$self->should_run_distro_upgrade() ) {
+    if ( !$self->upgrade_distro_manually() ) {
         return $self->_request_to_upgrade_distro_manually();
     }
 
@@ -11219,7 +11219,7 @@ sub post_upgrade_check ($self) {
 
 # TODO: We're going to need to store reboot time so we know if the last reboot has happened when we re-run the script.
 
-sub should_run_distro_upgrade ($self) {
+sub upgrade_distro_manually ($self) {
 
     # we store the upgrade_distro_manually option, but prefer using a positive check instead
     # we need to check to see if the CLI option is passed here too in order

diff --git a/lib/Elevate/Components/Base.pm b/lib/Elevate/Components/Base.pm
@@ -29,7 +29,7 @@ use Log::Log4perl qw(:easy);
 BEGIN {
     my @_DELEGATE_TO_CPEV = qw{
       getopt
-      should_run_distro_upgrade
+      upgrade_distro_manually
       ssystem
       ssystem_and_die
       ssystem_capture_output

diff --git a/lib/Elevate/Components/BootKernel.pm b/lib/Elevate/Components/BootKernel.pm
@@ -35,7 +35,7 @@ use Try::Tiny;
 
 sub check ($self) {
 
-    return 1 unless $self->should_run_distro_upgrade;    # skip when --upgrade-distro-manually is provided
+    return 1 unless $self->upgrade_distro_manually;    # skip when --upgrade-distro-manually is provided
 
     my $ok = 0;
     try {

diff --git a/lib/Elevate/Components/Grub2.pm b/lib/Elevate/Components/Grub2.pm
@@ -121,7 +121,7 @@ sub _remove_but_dont_stop_service ($self) {
 
 sub verify_cmdline ($self) {
     return unless -x GRUBBY_PATH;
-    if ( $self->cpev->should_run_distro_upgrade() ) {
+    if ( $self->cpev->upgrade_distro_manually() ) {
         my $arg = "elevate-" . _persistent_id;
         INFO("Checking for \"$arg\" in booted kernel's command line...");
 
@@ -320,7 +320,7 @@ sub post_distro_upgrade ($self) {
 sub check ($self) {
 
     return 1 unless Elevate::OS::needs_leapp();
-    return 1 unless $self->should_run_distro_upgrade;    # skip when --upgrade-distro-manually is provided
+    return 1 unless $self->upgrade_distro_manually;    # skip when --upgrade-distro-manually is provided
 
     my $ok = 1;
     $ok = 0 unless $self->_blocker_grub2_workaround;

diff --git a/lib/Elevate/Components/IsContainer.pm b/lib/Elevate/Components/IsContainer.pm
@@ -27,7 +27,7 @@ use Log::Log4perl qw(:easy);
 
 sub check ($self) {    # $self is a cpev object here
 
-    return 0 unless $self->should_run_distro_upgrade;
+    return 0 unless $self->upgrade_distro_manually;
 
     if ( _is_container_envtype() ) {
         return $self->has_blocker( <<~'EOS');

diff --git a/lib/Elevate/Components/Leapp.pm b/lib/Elevate/Components/Leapp.pm
@@ -36,7 +36,7 @@ sub check ($self) {
 
     return unless Elevate::OS::needs_leapp();
 
-    return unless $self->should_run_distro_upgrade;    # skip when --upgrade-distro-manually is provided
+    return unless $self->upgrade_distro_manually;    # skip when --upgrade-distro-manually is provided
 
     return if ( $self->components->num_blockers_found() > 0 );    # skip if any blockers have already been found
 

diff --git a/lib/Elevate/Components/NICs.pm b/lib/Elevate/Components/NICs.pm
@@ -110,7 +110,7 @@ sub check ($self) {
 
     # This only matters for upgrades performed with the leapp utility
     return 1 unless Elevate::OS::needs_leapp();
-    return 1 unless $self->should_run_distro_upgrade;
+    return 1 unless $self->upgrade_distro_manually;
 
     return $self->_blocker_bad_nics_naming;
 }

diff --git a/lib/Elevate/Leapp.pm b/lib/Elevate/Leapp.pm
@@ -89,7 +89,7 @@ sub preupgrade ($self) {
 
 sub upgrade ($self) {
 
-    return unless $self->cpev->should_run_distro_upgrade();
+    return unless $self->cpev->upgrade_distro_manually();
 
     $self->cpev->run_once(
         setup_answer_file => sub {
@@ -240,7 +240,7 @@ sub wait_for_leapp_completion ($self) {
     return 1 unless Elevate::OS::needs_leapp();
 
     # No use waiting for leapp to complete if we did not run leapp
-    return 1 unless $self->cpev->should_run_distro_upgrade();
+    return 1 unless $self->cpev->upgrade_distro_manually();
 
     my $upgrade_log = LEAPP_UPGRADE_LOG;
 

diff --git a/script/elevate-cpanel.PL b/script/elevate-cpanel.PL
@@ -940,7 +940,7 @@ sub run_stage_1 ($self) {
 
     Elevate::Motd->setup();
 
-    if ( !$self->should_run_distro_upgrade() ) {
+    if ( !$self->upgrade_distro_manually() ) {
         Elevate::Stages::bump_stage();
         return ACTION_CONTINUE;
     }
@@ -1019,7 +1019,7 @@ sub run_stage_3 ($self) {
 
     $self->run_once('run_final_components_pre_distro_upgrade');
 
-    if ( !$self->should_run_distro_upgrade() ) {
+    if ( !$self->upgrade_distro_manually() ) {
         return $self->_request_to_upgrade_distro_manually();
     }
 
@@ -1445,7 +1445,7 @@ sub post_upgrade_check ($self) {
 
 # TODO: We're going to need to store reboot time so we know if the last reboot has happened when we re-run the script.
 
-sub should_run_distro_upgrade ($self) {
+sub upgrade_distro_manually ($self) {
 
     # we store the upgrade_distro_manually option, but prefer using a positive check instead
     # we need to check to see if the CLI option is passed here too in order

diff --git a/t/components-BootKernel.t b/t/components-BootKernel.t
@@ -34,14 +34,14 @@ my $comp = cpev->new->get_component('BootKernel');
         reboot_status => sub { die "should not be called here\n"; },
     );
 
-    $mock_cpev->redefine( should_run_distro_upgrade => 0 );
+    $mock_cpev->redefine( upgrade_distro_manually => 0 );
     is( $comp->check(), 1, 'Should skip when upgrade-distro-manually is passed' );
 }
 
 {
     note 'Test BootKernel behavior';
 
-    $mock_cpev->redefine( should_run_distro_upgrade => 1 );
+    $mock_cpev->redefine( upgrade_distro_manually => 1 );
 
     my $rv;
     my $bv;

diff --git a/t/components-Grub2.t b/t/components-Grub2.t
@@ -63,8 +63,8 @@ $mock_stage_file->redefine( _save_stage_file => sub { $stage_data = $_[0]; retur
     my $cmdline;
     $mock_slurp->redefine( read_binary => sub { return $cmdline } );
 
-    $mock_cpev->redefine( should_run_distro_upgrade => 1 );
-    $mock_cpev->redefine( do_cleanup                => sub { $stage_data = undef; return; } );
+    $mock_cpev->redefine( upgrade_distro_manually => 1 );
+    $mock_cpev->redefine( do_cleanup              => sub { $stage_data = undef; return; } );
 
     my $mock_comp = Test::MockModule->new('Elevate::Components::Grub2');
     $mock_comp->redefine( _default_kernel               => "kernel-image" );

diff --git a/t/leapp_upgrade.t b/t/leapp_upgrade.t
@@ -314,13 +314,13 @@ note 'LEAPP upgrade log failure checks';
     $mock_leapp_upgrade_log->unlink;
 
     $mock_elevate->redefine(
-        should_run_distro_upgrade => 0,
+        upgrade_distro_manually => 0,
     );
 
     is( cpev->leapp->wait_for_leapp_completion, 1, 'wait_for_leapp_completion returns early when it should NOT run leapp' );
 
     $mock_elevate->redefine(
-        should_run_distro_upgrade => 1,
+        upgrade_distro_manually => 1,
     );
 
     is( cpev->leapp->wait_for_leapp_completion, 0, "wait_for_leapp_completion fails when the upgrade log is missing." );