features/step_definitions/additional_software_packages.rb

   1 ASP_STATE_DIR = '/run/live-additional-software'.freeze
   2 ASP_CONF = '/live/persistence/TailsData_unlocked/live-additional-software.conf'
   3            .freeze
   4
   5 Then /^the Additional Software (upgrade|installation) service has started$/ do |service|
   6   if $vm.file_exist?(ASP_CONF) && !$vm.file_empty?(ASP_CONF)
   7     case service
   8     when 'installation'
   9       service_name = 'tails-additional-software-install.service'
  10       seconds_to_wait = 600
  11     when 'upgrade'
  12       service_name = 'tails-additional-software-upgrade.service'
  13       seconds_to_wait = 900
  14     end
  15     try_for(seconds_to_wait, delay: 10) do
  16       $vm.execute("systemctl status #{service_name}").success?
  17     end
  18   end
  19 end
  20
  21 Then /^I am notified I can not use Additional Software for "([^"]*)"$/ do |package|
  22   title = "You could install #{package} automatically when starting Tails"
  23   step "I see the \"#{title}\" notification after at most 300 seconds"
  24 end
  25
  26 Then /^I am notified that the installation succeeded$/ do
  27   title = 'Additional software installed successfully'
  28   step "I see the \"#{title}\" notification after at most 300 seconds"
  29 end
  30
  31 Then /^I am proposed to add the "([^"]*)" package to my Additional Software$/ do |package|
  32   title = "Add #{package} to your additional software?"
  33   step "I see the \"#{title}\" notification after at most 300 seconds"
  34 end
  35
  36 def click_gnome_shell_notification_button(title)
  37   # The notification buttons do not expose any actions through AT-SPI,
  38   # so Dogtail is unable to click it directly. We let it grab focus
  39   # and activate it via the keyboard instead.
  40   Dogtail::Application.new('gnome-shell')
  41                       .child(title, roleName: 'push button')
  42                       .grabFocus
  43   @screen.press('Return')
  44 end
  45
  46 Then /^I create a persistent storage and activate the Additional Software feature$/ do
  47   click_gnome_shell_notification_button('Create Persistent Storage')
  48   step 'I create a persistent partition for Additional Software'
  49   assert_additional_software_persistent_storage_feature_is_enabled
  50 end
  51
  52 def assert_additional_software_persistent_storage_feature_is_enabled
  53   assert persistent_storage_main_frame.child('Personal Documents', roleName: 'label')
  54   additional_software_switch = persistent_storage_main_frame.child(
  55     'Activate Additional Software',
  56     roleName: 'toggle button'
  57   )
  58   assert additional_software_switch.checked
  59 end
  60
  61 Then /^Additional Software is correctly configured for package "([^"]*)"$/ do |package|
  62   try_for(30) do
  63     assert($vm.file_exist?(ASP_CONF), 'ASP configuration file not found')
  64     step 'all persistence configuration files have safe access rights'
  65     assert_not_empty(
  66       $vm.file_glob(
  67         "/live/persistence/TailsData_unlocked/apt/cache/#{package}_*.deb"
  68       )
  69     )
  70     assert_not_empty(
  71       $vm.file_glob('/live/persistence/TailsData_unlocked/apt/lists/*_Packages')
  72     )
  73     $vm.execute(
  74       "grep --line-regexp --fixed-strings #{package} #{ASP_CONF}"
  75     ).success?
  76   end
  77 end
  78
  79 Then /^"([^"]*)" is not in the list of Additional Software$/ do |package|
  80   assert($vm.file_exist?(ASP_CONF), 'ASP configuration file not found')
  81   step 'all persistence configuration files have safe access rights'
  82   try_for(30) do
  83     $vm.execute("grep \"#{package}\" #{ASP_CONF}").stdout.empty?
  84   end
  85 end
  86
  87 When /^I (refuse|accept) (adding|removing) "(?:[^"]*)" (?:to|from) Additional Software$/ do |decision, action|
  88   case action
  89   when 'adding'
  90     case decision
  91     when 'accept'
  92       button_title = 'Install Every Time'
  93     when 'refuse'
  94       button_title = 'Install Only Once'
  95     end
  96   when 'removing'
  97     case decision
  98     when 'accept'
  99       button_title = 'Remove'
 100     when 'refuse'
 101       button_title = 'Cancel'
 102     end
 103   end
 104   try_for(300) do
 105     click_gnome_shell_notification_button(button_title)
 106     true
 107   end
 108 end
 109
 110 Given /^I remove "([^"]*)" from the list of Additional Software using Additional Software GUI$/ do |package|
 111   asp_gui = Dogtail::Application.new('tails-additional-software-config')
 112   installed_package = asp_gui.child(package, roleName: 'label')
 113   # We can't use the click action here because this button causes a
 114   # modal dialog to be run via gtk_dialog_run() which causes the
 115   # application to hang when triggered via a ATSPI action. See
 116   # https://gitlab.gnome.org/GNOME/gtk/-/issues/1281
 117   installed_package.parent.parent.child('Remove', roleName: 'push button').grabFocus
 118   @screen.press('Return')
 119   asp_gui.child('Question', roleName: 'alert').button('Remove').click
 120   deal_with_polkit_prompt(@sudo_password)
 121 end
 122
 123 When /^I prepare the Additional Software upgrade process to fail$/ do
 124   # Remove the newest cowsay package from the APT cache with a DPKG hook
 125   # before it gets upgraded so that we simulate a failing upgrade.
 126   failing_dpkg_hook = <<~HOOK
 127     DPkg::Pre-Invoke {
 128       "ls -1 -v /var/cache/apt/archives/cowsay*.deb | tail -n 1 | xargs rm";
 129     };
 130   HOOK
 131   $vm.file_overwrite('/etc/apt/apt.conf.d/00failingDPKGhook', failing_dpkg_hook)
 132   # Tell the upgrade service check step not to run
 133   $vm.execute_successfully("touch #{ASP_STATE_DIR}/doomed_to_fail")
 134 end
 135
 136 When /^I remove the "([^"]*)" deb files from the APT cache$/ do |package|
 137   $vm.execute_successfully(
 138     "rm /live/persistence/TailsData_unlocked/apt/cache/#{package}_*.deb"
 139   )
 140 end
 141
 142 Then /^I can open the Additional Software documentation from the notification$/ do
 143   click_gnome_shell_notification_button('Documentation')
 144   try_for(60) { @torbrowser = Dogtail::Application.new('Firefox') }
 145   step '"Tails - Install by cloning" has loaded in the Tor Browser'
 146 end
 147
 148 Then /^the Additional Software dpkg hook has been run for package "([^"]*)" and notices the persistence is locked$/ do |package|
 149   asp_logs = "#{ASP_STATE_DIR}/log"
 150   assert(!$vm.file_empty?(asp_logs))
 151   try_for(180, delay: 2) do
 152     $vm.execute(
 153       "grep -E '^.*New\spackages\smanually\sinstalled:\s.*#{package}.*$' " \
 154       "#{asp_logs}"
 155     ).success?
 156   end
 157   try_for(60) do
 158     $vm.file_content(asp_logs)
 159        .include?('Warning: persistence storage is locked')
 160   end
 161 end
 162
 163 When /^I can open the Additional Software configuration window from the notification$/ do
 164   click_gnome_shell_notification_button('Configure')
 165   Dogtail::Application.new('tails-additional-software-config')
 166 end
 167
 168 Then /^I can open the Additional Software log file from the notification$/ do
 169   click_gnome_shell_notification_button('Show Log')
 170   try_for(60) do
 171     Dogtail::Application.new('gnome-text-editor').child(
 172       "log (#{ASP_STATE_DIR}) - Text Editor", roleName: 'frame'
 173     )
 174   end
 175 end