[Summary view]

Differences Between: [Versions 310 and 311] [Versions 39 and 311]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  namespace quizaccess_seb;
  18  
  19  /**
  20   * PHPUnit Tests for config_key class.
  21   *
  22   * @package   quizaccess_seb
  23   * @author    Andrew Madden <andrewmadden@catalyst-au.net>
  24   * @copyright 2020 Catalyst IT
  25   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  26   */
  27  class config_key_test extends \advanced_testcase {
  28  
  29      /**
  30       * Test that trying to generate the hash key with bad xml will result in an error.
  31       */
  32      public function test_config_key_not_generated_with_bad_xml() {
  33          $this->expectException(\invalid_parameter_exception::class);
  34          $this->expectExceptionMessage("Invalid a PList XML string, representing SEB config");
  35          config_key::generate("<?xml This is some bad xml for sure.");
  36      }
  37  
  38      /**
  39       * Test that a config key is generated with empty configuration. SEB would be using defaults for all settings.
  40       */
  41      public function test_config_key_hash_generated_with_empty_string() {
  42          $hash = config_key::generate('')->get_hash();
  43          $this->assertEquals('4f53cda18c2baa0c0354bb5f9a3ecbe5ed12ab4d8e11ba873c2f11161202b945', $hash);
  44      }
  45  
  46      /**
  47       * Check that the Config Key hash is not altered if the originatorVersion is present in the XML or not.
  48       */
  49      public function test_presence_of_originator_version_does_not_effect_hash() {
  50          $xmlwithoriginatorversion = file_get_contents(__DIR__ . '/fixtures/simpleunencrypted.seb');
  51          $xmlwithoutoriginatorversion = file_get_contents(__DIR__ . '/fixtures/simpleunencryptedwithoutoriginator.seb');
  52          $hashwithorigver = config_key::generate($xmlwithoriginatorversion)->get_hash();
  53          $hashwithoutorigver = config_key::generate($xmlwithoutoriginatorversion)->get_hash();
  54          $this->assertEquals($hashwithorigver, $hashwithoutorigver);
  55      }
  56  
  57      /**
  58       * Provide a seb file, the expected Config Key and a password if encrypted.
  59       *
  60       * @return array
  61       */
  62      public function real_ck_hash_provider() : array {
  63          return [
  64              'unencrypted_mac2.1.4' => ['unencrypted_mac_001.seb',
  65                      '4fa9af8ec8759eb7c680752ef4ee5eaf1a860628608fccae2715d519849f9292', ''],
  66              'unencrypted_win2.2.3' => ['unencrypted_win_223.seb',
  67                      'fc6f4ea5922717760f4d6d536c23b8d19bf20b52aa97940f5427a76e20f49026', ''],
  68          ];
  69      }
  70  }