MDL-61568 repository_flickr: Fix oauth secret export

moodle · Apr 19, 2018 · 89feef0 · 89feef0
1 parent 3b1e2eb
commit 89feef0
Show file tree

Hide file tree

Showing 3 changed files with 95 additions and 3 deletions.
diff --git a/repository/flickr/classes/privacy/provider.php b/repository/flickr/classes/privacy/provider.php
@@ -126,7 +126,7 @@ public static function export_user_preferences(int $userid) {
             writer::export_user_preference(
                 'repository_flickr',
                 'repository_flickr_access_token_secret',
-                $accesstokensecret,
+                '',
                 get_string('privacy:metadata:repository_flickr:preference:repository_flickr_access_token_secret', 'repository_flickr')
             );
         }

diff --git a/repository/flickr/lang/en/repository_flickr.php b/repository/flickr/lang/en/repository_flickr.php
@@ -45,5 +45,5 @@
 $string['username'] = 'Flickr account email';
 $string['privacy:metadata:repository_flickr'] = 'The Flickr repository plugin does store user preferences, and transmits user data from Moodle to the remote system.';
 $string['privacy:metadata:repository_flickr:text'] = 'The Flickr repository user search text query.';
-$string['privacy:metadata:repository_flickr:preference:repository_flickr_access_token'] = 'The Flickr repository user preference OAuth token.';
-$string['privacy:metadata:repository_flickr:preference:repository_flickr_access_token_secret'] = 'The Flickr repository user preference OAuth secret.';
+$string['privacy:metadata:repository_flickr:preference:repository_flickr_access_token'] = 'The Flickr repository OAuth token preference.';
+$string['privacy:metadata:repository_flickr:preference:repository_flickr_access_token_secret'] = 'The Flickr repository OAuth secret preference; this is excluded from privacy data exports.';
diff --git a/repository/flickr/tests/privacy_test.php b/repository/flickr/tests/privacy_test.php
@@ -0,0 +1,92 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+/**
+ * Privacy tests for repository_flickr.
+ *
+ * @package    repository_flickr
+ * @category   test
+ * @copyright  2018 Zig Tan <zig@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+defined('MOODLE_INTERNAL') || die();
+
+use \repository_flickr\privacy\provider;
+use \core_privacy\local\request\approved_contextlist;
+use \core_privacy\local\request\writer;
+use \core_privacy\tests\provider_testcase;
+
+/**
+ * Unit tests for repository/flickr/privacy/provider
+ *
+ * @copyright  2018 Zig Tan <zig@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class repository_flickr_privacy_testcase extends provider_testcase {
+    /**
+     * Overriding setUp() function to always reset after tests.
+     */
+    public function setUp() {
+        $this->resetAfterTest(true);
+    }
+
+    /**
+     * Test for provider::export_user_preferences().
+     */
+    public function test_export_user_preferences() {
+        global $DB;
+
+        // Test setup.
+        $user = $this->getDataGenerator()->create_user();
+        $this->setUser($user);
+        $contextlist = provider::get_contexts_for_userid($user->id);
+        $approvedcontextlist = new approved_contextlist($user, 'repository_flickr', $contextlist->get_contextids());
+        $user = $approvedcontextlist->get_user();
+        $contextuser = context_user::instance($user->id);
+
+        // Test exporting of Flickr repository user preferences *without* OAuth token/secret preference configured.
+        provider::export_user_preferences($user->id);
+        $writer = writer::with_context($contextuser);
+
+        // Verify there is no user preferences data exported.
+        $this->assertFalse($writer->has_any_data());
+
+        // Test exporting of Flickr repository user preferences *with* OAuth token/secret preference configured.
+        $preference = (object) [
+            'userid' => $user->id,
+            'name' => 'repository_flickr_access_token',
+            'value' => 'dummy flickr oauth access token'
+        ];
+        $DB->insert_record('user_preferences', $preference);
+        $preference = (object) [
+            'userid' => $user->id,
+            'name' => 'repository_flickr_access_token_secret',
+            'value' => 'dummy flickr oauth access token secret'
+        ];
+        $DB->insert_record('user_preferences', $preference);
+        provider::export_user_preferences($user->id);
+        $writer = writer::with_context($contextuser);
+
+        // Verify there is user preferences data exported.
+        $this->assertTrue($writer->has_any_data());
+        $userpreferences = $writer->get_user_preferences('repository_flickr');
+
+        // Verify the OAuth token is not an empty string value and the OAuth secret is an empty string value.
+        $accesstoken = $userpreferences->repository_flickr_access_token;
+        $this->assertFalse(empty($accesstoken->value));
+        $accesstokensecret = $userpreferences->repository_flickr_access_token_secret;
+        $this->assertTrue(empty($accesstokensecret->value));
+    }
+}