5 {{ $t('message.table.pageNb') }} @@ -59,9 +59,6 @@ :per-page="perPage" :pagination-simple="true" :default-sort-direction="defaultSortDirection" - @dblclick="(row) => $router.push(getConAddr(row))" - @keyup.native.enter="$router.push(getConAddr(selected))" - @keyup.native.space="$router.push(getConAddr(selected))" > { this.$store.state.client.shareContainerDeleteAccess( - this.$route.params.project, + this.project, container, ).then(() => { this.$buefy.toast.open({ diff --git a/swift_browser_ui_frontend/src/components/SharedTable.vue b/swift_browser_ui_frontend/src/components/SharedTable.vue index 9a5655dcb..0e8bec83c 100644 --- a/swift_browser_ui_frontend/src/components/SharedTable.vue +++ b/swift_browser_ui_frontend/src/components/SharedTable.vue @@ -9,7 +9,7 @@ > 5 {{ $t('message.table.pageNb') }} diff --git a/swift_browser_ui_frontend/src/components/Sharing.vue b/swift_browser_ui_frontend/src/components/Sharing.vue deleted file mode 100644 index 524a7535b..000000000 --- a/swift_browser_ui_frontend/src/components/Sharing.vue +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - {{ $t('message.share.share_cont') }} - - - - - - {{ $t('message.share.read_perm') }} - - - {{ $t('message.share.write_perm') }} - - - - - - - - - - - - - - diff --git a/swift_browser_ui_frontend/src/entries/badrequest.js b/swift_browser_ui_frontend/src/entries/badrequest.js index 0bcc16b76..6a72593cd 100644 --- a/swift_browser_ui_frontend/src/entries/badrequest.js +++ b/swift_browser_ui_frontend/src/entries/badrequest.js @@ -30,6 +30,7 @@ new Vue({ notfound: false, uidown: false, langs: [{ph: "In English", value: "en"}, {ph: "Suomeksi", value: "fi"}], + idb: true, }, created() { document.title = this.$t("message.program_name"); diff --git a/swift_browser_ui_frontend/src/entries/forbid.js b/swift_browser_ui_frontend/src/entries/forbid.js index ecc68b34b..eae7cff2e 100644 --- a/swift_browser_ui_frontend/src/entries/forbid.js +++ b/swift_browser_ui_frontend/src/entries/forbid.js @@ -30,6 +30,7 @@ new Vue({ notfound: false, uidown: false, langs: [{ph: "In English", value: "en"}, {ph: "Suomeksi", value: "fi"}], + idb: true, }, created() { document.title = this.$t("message.program_name"); diff --git a/swift_browser_ui_frontend/src/entries/index.js b/swift_browser_ui_frontend/src/entries/index.js index 319de6f4c..7b25cadb2 100644 --- a/swift_browser_ui_frontend/src/entries/index.js +++ b/swift_browser_ui_frontend/src/entries/index.js @@ -30,6 +30,7 @@ new Vue({ forbid: false, notfound: false, langs: [{ph: "In English", value: "en"}, {ph: "Suomeksi", value: "fi"}], + idb: true, }, created() { document.title = this.$t("message.program_name"); diff --git a/swift_browser_ui_frontend/src/entries/login.js b/swift_browser_ui_frontend/src/entries/login.js index 7cbb9d5a4..d75bb0566 100644 --- a/swift_browser_ui_frontend/src/entries/login.js +++ b/swift_browser_ui_frontend/src/entries/login.js @@ -22,6 +22,7 @@ new Vue ({ data: { formname: "Token id:", loginformname: "Openstack account:", + idb: true, }, created() { document.title = this.$t("message.program_name"); diff --git a/swift_browser_ui_frontend/src/entries/loginpassword.js b/swift_browser_ui_frontend/src/entries/loginpassword.js index eb17e6cb4..e7744c39a 100644 --- a/swift_browser_ui_frontend/src/entries/loginpassword.js +++ b/swift_browser_ui_frontend/src/entries/loginpassword.js @@ -24,6 +24,7 @@ new Vue({ i18n, data: { langs: [{ph: "In English", value: "en"}, {ph: "Suomeksi", value: "fi"}], + idb: true, }, created() { document.title = this.$t("message.program_name"); diff --git a/swift_browser_ui_frontend/src/entries/main.js b/swift_browser_ui_frontend/src/entries/main.js index be1cd0574..6f8ed1008 100644 --- a/swift_browser_ui_frontend/src/entries/main.js +++ b/swift_browser_ui_frontend/src/entries/main.js @@ -13,15 +13,14 @@ import getLangCookie from "@/common/conv"; import translations from "@/common/lang"; import { getUser } from "@/common/api"; import { getProjects } from "@/common/api"; -import getActiveProject from "@/common/api"; -import { changeProjectApi } from "@/common/api"; // Import SharingView and Request API import SwiftXAccountSharing from "@/common/swift_x_account_sharing_bind"; import SwiftSharingRequest from "@/common/swift_sharing_request_bind"; // Import container ACL sync -import { syncContainerACLs } from "@/common/conv"; +import { syncContainerACLs, DEV } from "@/common/conv"; +import checkIDB from "@/common/idb_support"; // Import project state import store from "@/common/store"; @@ -38,7 +37,36 @@ import ProgressBar from "@/components/UploadProgressBar"; // Import delay import delay from "lodash/delay"; + +checkIDB().then(result => { + if (!result) { + window.location.pathname = "/"; + } +}); + +window.onerror = function(error) { + if(DEV) console.log("Global error", error); + error.preventDefault(); + error.stopPropagation(); +}; +window.addEventListener("unhandledrejection", function(event) { + if(DEV) console.log("unhandledrejection", event); + event.preventDefault(); + event.stopPropagation(); +}); +window.addEventListener("rejectionhandled", function(event) { + if(DEV) console.log("rejectionhandled", event); + event.preventDefault(); + event.stopPropagation(); +}); + Vue.config.productionTip = false; +Vue.config.errorHandler = function(err, vm, info) { + if(DEV) console.log("Vue error: ", err, vm, info); +}; +Vue.config.warnHandler = function(msg, vm, info) { + if(DEV) console.log("Vue warning: ", msg, vm, info); +}; Vue.use(Buefy); Vue.use(VueI18n); @@ -75,6 +103,9 @@ new Vue({ active () { return this.$store.state.active; }, + user () { + return this.$store.state.uname; + }, isFullPage () { return this.$store.state.isFullPage; }, @@ -103,32 +134,74 @@ new Vue({ created() { document.title = this.$t("message.program_name"); this.createUploadInstance(); - getUser().then(( value ) => { - this.$store.commit("setUname", value); - }); - getProjects().then((value) => { - this.$store.commit("setProjects", value); - - getActiveProject().then((value) => { - this.$store.commit("setActive", value); - if (this.$route.params.user != undefined) { - if ( - value.name != this.$route.params.project && - this.$route.params.project != undefined - ) { - this.changeProject(this.$route.params.project); - } - } - if (document.location.pathname == "/browse") { - this.$router.push( - "/browse/".concat( - this.$store.state.uname, - "/", - value.name, - ), - ); + let initialize = async () => { + let active; + let user = await getUser(); + let projects = await getProjects(); + this.$store.commit("setUname", user); + this.$store.commit("setProjects", projects); + + const existingProjects = await this.$store.state.db.projects + .toCollection() + .primaryKeys(); + await this.$store.state.db.projects.bulkPut(projects); + const toDelete = []; + existingProjects.map(async oldProj => { + if(!projects.find(proj => proj.id === oldProj)) { + toDelete.push(oldProj); } }); + if (toDelete.length) { + await this.$store.state.db.projects.bulkDelete(toDelete); + const containersCollection = this.$store.state.db.containers + .where("projectID").anyOf(toDelete); + const containers = await containersCollection.primaryKeys(); + await containersCollection.delete(); + await this.$store.state.db.objects + .where("containerID").anyOf(containers) + .delete(); + } + + let last_active; + if(document.cookie.match("LAST_ACTIVE")) { + last_active = document.cookie + .split("; ") + .find(row => row.startsWith("LAST_ACTIVE")) + .split("=")[1]; + } + if (last_active) { + active = projects[ + projects.indexOf(projects.find(e => e.id == last_active)) + ]; + } else if ( + !(this.$route.params.user === undefined) + ) { + if ( + !(this.$route.params.project === undefined) + ) { + active = projects[ + projects.indexOf( + projects.find(e => e.id == this.$route.params.project), + ) + ]; + } + } else { + active = projects[0]; + } + this.$store.commit("setActive", active); + + if (document.location.pathname == "/browse") { + this.$router.push({ + name: "ContainersView", + params: { + project: active.id, + user: user, + }, + }); + } + }; + initialize().then(() => { + return; }); fetch("/discover") .then((resp) => { @@ -155,8 +228,22 @@ new Vue({ }); delay( this.containerSyncWrapper, - 5000, + 10000, ); + if (this.$te("message.keys")) { + for (let item of Object.entries(this.$t("message.keys"))) { + fetch( + "/download/" + + item[1]["project"] + "/" + + item[1]["container"] + "/" + + item[1]["object"], + ).then(resp => { + return resp.text(); + }).then(resp => { + this.$store.commit("appendPubKey", resp); + }); + } + } }, methods: { dragHandler: function (e) { @@ -187,17 +274,19 @@ new Vue({ this.$store.commit("appendFileTransfer", file); } } - this.$router.push({ - name: "UploadView", - params: { - project: this.$route.params.project, - container: ( - this.$route.params.container ? - this.$route.params.container : - "upload-".concat(Date.now().toString()) - ), - }, - }); + if (this.$route.name != "UploadView") { + this.$router.push({ + name: "UploadView", + params: { + project: this.$route.params.project, + container: ( + this.$route.params.container ? + this.$route.params.container : + "upload-".concat(Date.now().toString()) + ), + }, + }); + } this.itemdrop = false; }, containerSyncWrapper: function () { @@ -236,8 +325,6 @@ new Vue({ // Bake upload runner information to the resumable url parameters. let retUrl = new URL(this.uploadInfo.url); - console.log(this.uploadInfo.url); - for (const param of params) { let newParam = param.split("="); // check if we should move the file under a pseudofolder @@ -263,7 +350,6 @@ new Vue({ retUrl.searchParams.append( "signature", this.uploadInfo.signature.signature, ); - console.log(retUrl); return retUrl; }, startUpload: function () { @@ -362,26 +448,6 @@ new Vue({ return retl; }, - changeProject: function (newProject) { - // Re-scope login to project given as a parameter. - changeProjectApi(newProject).then((ret) => { - if (ret) { - getActiveProject().then((value) => { - this.$store.commit("setActive", value); - this.$store.commit("updateContainers", undefined); - this.$store.commit("eraseObjects"); - this.$router.push( - "/browse/" + - this.$store.state.uname + "/" + - this.$store.state.active["name"], - ); - this.$router.go(0); - }); - } else{ - this.$router.push("/browse/" + this.$store.state.uname); - } - }); - }, }, ...App, }).$mount("#app"); diff --git a/swift_browser_ui_frontend/src/entries/notfound.js b/swift_browser_ui_frontend/src/entries/notfound.js index 897600fdd..7d15b4079 100644 --- a/swift_browser_ui_frontend/src/entries/notfound.js +++ b/swift_browser_ui_frontend/src/entries/notfound.js @@ -30,6 +30,7 @@ new Vue({ notfound: true, uidown: false, langs: [{ph: "In English", value: "en"}, {ph: "Suomeksi", value: "fi"}], + idb: true, }, created() { document.title = this.$t("message.program_name"); diff --git a/swift_browser_ui_frontend/src/entries/uidown.js b/swift_browser_ui_frontend/src/entries/uidown.js index 0d16a24a6..b8970b84e 100644 --- a/swift_browser_ui_frontend/src/entries/uidown.js +++ b/swift_browser_ui_frontend/src/entries/uidown.js @@ -30,6 +30,7 @@ new Vue({ notfound: false, uidown: true, langs: [{ph: "In English", value: "en"}, {ph: "Suomeksi", value: "fi"}], + idb: true, }, created() { document.title = this.$t("message.program_name"); diff --git a/swift_browser_ui_frontend/src/entries/unauth.js b/swift_browser_ui_frontend/src/entries/unauth.js index 8dbbce0a7..a471e97c1 100644 --- a/swift_browser_ui_frontend/src/entries/unauth.js +++ b/swift_browser_ui_frontend/src/entries/unauth.js @@ -30,6 +30,7 @@ new Vue({ notfound: false, uidown: false, langs: [{ph: "In English", value: "en"}, {ph: "Suomeksi", value: "fi"}], + idb: true, }, created() { document.title = this.$t("message.program_name"); diff --git a/swift_browser_ui_frontend/src/pages/BrowserPage.vue b/swift_browser_ui_frontend/src/pages/BrowserPage.vue index 772627bc3..385855e91 100644 --- a/swift_browser_ui_frontend/src/pages/BrowserPage.vue +++ b/swift_browser_ui_frontend/src/pages/BrowserPage.vue @@ -7,15 +7,23 @@ > - - {{ $t('message.dropFiles') }} + + + + + {{ $t('message.dropFiles') }} diff --git a/swift_browser_ui_frontend/src/pages/IndexPage.vue b/swift_browser_ui_frontend/src/pages/IndexPage.vue index 6ea0bcac5..ff5f59d8c 100644 --- a/swift_browser_ui_frontend/src/pages/IndexPage.vue +++ b/swift_browser_ui_frontend/src/pages/IndexPage.vue @@ -64,6 +64,14 @@ > {{ $t('message.error.UIdown_text') }} + + {{ $t('message.error.idb_text') }} + {{ item.msg }} @@ -93,6 +102,7 @@ tag="a" type="is-primary" href="/" + :disabled="!idb" > {{ $t("message.error.frontPage") }} @@ -127,6 +137,16 @@ + + diff --git a/swift_browser_ui_frontend/src/views/Containers.vue b/swift_browser_ui_frontend/src/views/Containers.vue index 1a05a639b..a35088d4d 100644 --- a/swift_browser_ui_frontend/src/views/Containers.vue +++ b/swift_browser_ui_frontend/src/views/Containers.vue @@ -10,7 +10,7 @@ > @@ -34,7 +34,7 @@ @@ -46,12 +46,47 @@ {{ $t('message.table.showTags') }} - - - + + + + + + + + + {{ $t('message.search.empty') }} + + + + @@ -517,4 +638,36 @@ export default { margin: auto; } +#destinationBucket { + flex-grow: 1; +} + +.uploadButtonContainer { + margin-top: 2%; + display: flex; + flex-wrap: wrap; +} + +.uploadButtonContainer .upload + button, +.uploadButtonContainer #uploadButton + button { + margin-left: 1%; +} + +#uploadButton { + margin-left: auto; +} + +#encryptionOptions { + flex-grow: 1; + margin-top: -20px; + justify-content: right; +} + +@media screen and ( max-width: 1357px){ + #encryptionOptions { + margin-top: 0; + } + +} + \ No newline at end of file diff --git a/swift_browser_ui_frontend/vue.config.js b/swift_browser_ui_frontend/vue.config.js index 94b181673..0ba8009b5 100644 --- a/swift_browser_ui_frontend/vue.config.js +++ b/swift_browser_ui_frontend/vue.config.js @@ -2,8 +2,12 @@ module.exports = { // eslint-disable-line publicPath: "/static", devServer: { // eslint-disable-next-line - proxy: `${process.env.BACKEND_HOST || "http://localhost"}:${process.env.BACKEND_PORT || "8080"}`, - hot: true, + proxy: `http://${process.env.BACKEND_HOST || "localhost"}:${process.env.BACKEND_PORT || "8080"}`, + hot: "only", + client: { + // eslint-disable-next-line + webSocketURL: `ws://${process.env.BACKEND_HOST || "localhost"}:${process.env.BACKEND_PORT || "8080"}/ws`, + }, }, pages: { index: { diff --git a/tests/common/mockups.py b/tests/common/mockups.py index d405eef3f..f2f76f7b6 100644 --- a/tests/common/mockups.py +++ b/tests/common/mockups.py @@ -1,76 +1,209 @@ """Mock-up classes and functions for testing swift_browser_ui.""" -import random -import hashlib -import os -import datetime import json import yarl -from urllib.error import HTTPError -from contextlib import contextmanager - - -from swiftclient.service import SwiftError - - -mock_token_project_avail = json.dumps( - { - "projects": [ - # there is a special use case when this is first - # as the list of projects might give 401 - { - "is_domain": False, - "description": "Not enabled project", - "links": {"self": "https://place-holder-url:5001/v3/projects/no"}, - "enabled": False, - "id": "no", - "parent_id": "default", - "domain_id": "default", - "name": "no", - }, - { - "is_domain": False, - "description": "", - "links": { - "self": "https://place-holder-url:5001/v3/projects/placeholder" - }, - "enabled": True, - "id": "placeholder", - "parent_id": "default", - "domain_id": "default", - "name": "placeholder", - }, - { - "is_domain": False, - "description": "Wololo yol aweii", - "links": {"self": "https://place-holder-url:5001/v3/projects/wol"}, - "enabled": True, - "id": "wol", - "parent_id": "default", - "domain_id": "default", - "name": "wol", +import unittest +import unittest.mock +import time +import types +import logging + +import aiohttp_session + + +class APITestBase(unittest.IsolatedAsyncioTestCase): + """Base class for API tests using aiohttp client and server.""" + + def setUp(self): + """Set up mocks.""" + self.session_return = aiohttp_session.Session( + "test-identity", + new=True, + data={}, + ) + self.session_return["token"] = "not-really-a-token" # nosec + self.session_return["at"] = time.time() + self.session_return["referer"] = "http://localhost:8080" + self.session_return["uname"] = "testuser" + self.session_return["projects"] = { + "test-id-0": { + "id": "test-id-0", + "name": "test-name-0", + "token": "test-token-0", + "endpoint": "https://test-endpoint-0/v1/AUTH_test-id-0", }, - { - "is_domain": False, - "description": "Hmmph, what is", - "links": {"self": "https://place-holder-url:5001/v3/projects/what"}, - "enabled": True, - "id": "what", - "parent_id": "default", - "domain_id": "default", - "name": "what", + "test-id-1": { + "id": "test-id-1", + "name": "test-name-1", + "token": "test-token-1", + "endpoint": "https://test-endpoint-1/v1/AUTH_test-id-1", }, - ], - } -) + } + self.aiohttp_session_get_session_mock = unittest.mock.AsyncMock() + self.aiohttp_session_get_session_mock.return_value = self.session_return + self.p_get_sess = unittest.mock.patch( + "swift_browser_ui.ui.api.aiohttp_session.get_session", + self.aiohttp_session_get_session_mock, + ) + self.aiohttp_session_new_session_mock = unittest.mock.AsyncMock() + self.p_new_sess = unittest.mock.patch( + "swift_browser_ui.ui.login.aiohttp_session.new_session", + self.aiohttp_session_new_session_mock, + ) + self.setd_mock = { + "auth_endpoint_url": "https://example.os.com:5001/v3", + "set_origin_address": "https://localhost/login/websso", + "has_trust": True, + "upload_external_endpoint": "http://test-endpoint:9092/", + } + self.patch_setd = unittest.mock.patch( + "swift_browser_ui.ui.api.setd", self.setd_mock + ) -mock_token_domain_avail = json.dumps({"domains": []}) + self.aiohttp_json_response_mock = unittest.mock.Mock() + self.p_json_resp = unittest.mock.patch( + "swift_browser_ui.ui.api.aiohttp.web.json_response", + self.aiohttp_json_response_mock, + ) + self.mock_response_write = unittest.mock.AsyncMock() + self.mock_response_prepare = unittest.mock.AsyncMock() + self.mock_response_write_eof = unittest.mock.AsyncMock() + self.aiohttp_construct_response_mock = unittest.mock.Mock() + self.aiohttp_construct_response_mock.return_value = types.SimpleNamespace( + **{ + "status": 200, + "headers": {}, + "cookie": {}, + "write": self.mock_response_write, + "prepare": self.mock_response_prepare, + "write_eof": self.mock_response_write_eof, + } + ) + self.p_resp = unittest.mock.patch( + "swift_browser_ui.ui.api.aiohttp.web.Response", + self.aiohttp_construct_response_mock, + ) + self.p_sresp = unittest.mock.patch( + "swift_browser_ui.ui.api.aiohttp.web.StreamResponse", + self.aiohttp_construct_response_mock, + ) -mock_token_output = { + self.mock_response_read = unittest.mock.AsyncMock(return_value=b"exampleread") + self.mock_iter = unittest.mock.Mock(return_value=b"test-chunk") + + async def citer(_): + yield self.mock_iter() + + self.mock_client_json = {} + self.mock_client_text = "" + self.mock_client_response = types.SimpleNamespace( + **{ + "status": 200, + "headers": {}, + "cookie": {}, + "json": None, + "content": types.SimpleNamespace( + **{ + "iter_chunked": citer, + } + ), + "read": self.mock_response_read, + "text": unittest.mock.AsyncMock(return_value=self.mock_client_text), + "url": "https://localhost:8080", + } + ) + + class MockHandler(APITestBase): + def __init__(self, mockresp): + """.""" + self.mock_client_response = mockresp + + async def __aenter__(self): + return self.mock_client_response + + async def __aexit__(self, *_): + return + + self.MockHandler = MockHandler + self.mock_client = types.SimpleNamespace( + **{ + "get": unittest.mock.Mock( + return_value=self.MockHandler( + self.mock_client_response, + ) + ), + "post": unittest.mock.Mock( + return_value=self.MockHandler( + self.mock_client_response, + ) + ), + "put": unittest.mock.Mock( + return_value=self.MockHandler( + self.mock_client_response, + ) + ), + "delete": unittest.mock.Mock( + return_value=self.MockHandler( + self.mock_client_response, + ) + ), + "head": unittest.mock.Mock( + return_value=self.MockHandler( + self.mock_client_response, + ) + ), + } + ) + + self.mock_request = types.SimpleNamespace( + **{ + "match_info": { + "project": "test-id-0", + "container": "test-container", + "object": "test-object", + "receiver": "test-project-1", + }, + "cookies": {}, + "query": {}, + "headers": {}, + "query_string": "", + "remote": "test-remote", + "json": None, + "post": unittest.mock.AsyncMock(), + "app": { + "api_client": self.mock_client, + "client": self.mock_client, + "Log": unittest.mock.MagicMock(logging.Logger), + "test-id": "placeholder", + }, + "url": types.SimpleNamespace( + **{ + "host": "https://localhost", + } + ), + "path": "/", + } + ) + super().setUp() + + +mock_token_project_avail: dict = { "projects": [ + # there is a special use case when this is first + # as the list of projects might give 401 + { + "is_domain": False, + "description": "Not enabled project", + "links": {"self": "https://place-holder-url:5001/v3/projects/no"}, + "enabled": False, + "id": "no", + "parent_id": "default", + "domain_id": "default", + "name": "no", + }, { "is_domain": False, "description": "", @@ -102,62 +235,47 @@ "name": "what", }, ], - "domains": [], } -def return_mock_token(_, _a): - """Return a mock token.""" - return "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - - -def return_same_cookie(_): - """Return same cookie.""" - return ("placeholder", "placeholder") - - -def return_invalid(_): - """Return invalid.""" - return "INVALID" - - -def return_project_avail(_): - """Return mocked unscoped token availability output.""" - return mock_token_output - - -def return_test_swift_endpoint(_): - """Return mocked test available swift.""" - return None - - -@contextmanager -def urlopen(prq, timeout=10): - """Mockup class for opening keystone.""" - yield MockKeystone(prq) - - -class MockKeystone: - """Mockup class for OS Keystone to enable testing availability.""" +mock_token_domain_avail: dict = {"domains": []} - def __init__(self, prq): - """Initialize Mock keystone.""" - self.prq = prq - def read(self): - """Read request.""" - if "X-auth-token" not in self.prq.headers: - raise HTTPError( - url=None, code=401, msg="Unauthorized", hdrs=self.prq.headers, fp=None - ) - if "projects" in self.prq.full_url: - return mock_token_project_avail.encode("utf-8") - if "domains" in self.prq.full_url: - return mock_token_domain_avail.encode("utf-8") - else: - raise HTTPError( - url=None, code=401, msg="Unauthorized", hdrs=self.prq.headers, fp=None - ) +mock_token_output = { + "projects": [ + { + "is_domain": False, + "description": "", + "links": {"self": "https://place-holder-url:5001/v3/projects/placeholder"}, + "enabled": True, + "id": "placeholder", + "parent_id": "default", + "domain_id": "default", + "name": "placeholder", + }, + { + "is_domain": False, + "description": "Wololo yol aweii", + "links": {"self": "https://place-holder-url:5001/v3/projects/wol"}, + "enabled": True, + "id": "wol", + "parent_id": "default", + "domain_id": "default", + "name": "wol", + }, + { + "is_domain": False, + "description": "Hmmph, what is", + "links": {"self": "https://place-holder-url:5001/v3/projects/what"}, + "enabled": True, + "id": "what", + "parent_id": "default", + "domain_id": "default", + "name": "what", + }, + ], + "domains": [], +} class Mock_Request: @@ -166,7 +284,7 @@ class Mock_Request: It contains the dictionary representation of the requests that will be passed to the functions. - (the actual request eing a MutableMapping instance) + (the actual request being a MutableMapping instance) """ def __init__(self): @@ -227,231 +345,3 @@ async def json(self): if isinstance(self.post_data, str): return json.loads(self.post_data) return self.post_data - - -class Mock_Service: - """ - Mock-up class for the Openstack service. - - In this case a swiftclient.Service - instance. Contains the mock-ups for the relevant methods used in this - project. Also contains functions for generating test data, in case it is - necessary. - """ - - def __init__(self): - """.""" - self.containers = {} - self.meta = { - "tempurl_key_1": None, - "tempurl_key_2": None, - } - self.cont_meta = {} - self.obj_meta = {} - - def init_with_data( - self, - containers=0, - object_range=(0, 0), - size_range=(0, 0), - container_name_prefix="test-container-", - object_name_prefix=None, # None for just the hash as name - has_content_type=None, - ): - """Initialize the Mock_Service instance with some test data.""" - for i in range(0, containers): - to_add = [] - - # Iterate over a random amount of objects - for _ in range(0, random.randint(object_range[0], object_range[1])): # nosec - ohash = hashlib.sha1(os.urandom(256)).hexdigest() # nosec - if object_name_prefix is not None: - oname = object_name_prefix + ohash - else: - oname = ohash - to_append = { - "hash": ohash, - "name": oname, - "last_modified": datetime.datetime.now().isoformat(), - "bytes": random.randint(size_range[0], size_range[1]), # nosec - } - if has_content_type: - to_append["content_type"] = has_content_type - to_add.append(to_append) - - self.containers[container_name_prefix + str(i)] = to_add - - def list(self, container=None, options=None): - """Mock function for the service object / container listings.""" - if container is None: - ret = [] - for i in self.containers: - ret.append( - { - "name": i, - "count": len(self.containers[i]), - "bytes": sum([j["bytes"] for j in self.containers[i]]), - } - ) - return [{"success": True, "container": "mock-container", "listing": ret}] - if container is not None: - ret = [] - try: - for i in self.containers[container]: - to_append = { - "hash": i["hash"], - "name": i["name"], - "last_modified": i["last_modified"], - "bytes": i["bytes"], - } - if "content_type" in i.keys(): - to_append["content_type"] = i["content_type"] - ret.append(to_append) - return [{"success": True, "container": container, "listing": ret}] - except KeyError: - raise SwiftError(None, container=container) - else: - return None - - def stat(self, *args): - """Mock the stat call of SwiftService.""" - ret = {} - ret["headers"] = {} - if not args: - object_amount = 0 - bytes_total = 0 - container_amount = len(self.containers) - # Iterate over all containers to figure out the amount of of - # objects - for i in self.containers: - object_amount = object_amount + len(self.containers[i]) - # Iterate over all objects to get the total storage usage - for j in self.containers[i]: - bytes_total = bytes_total + j["bytes"] - ret["items"] = [ - ( - "Account", - "AUTH_test_account", - ), - ("Containers", container_amount), - ("Objects", object_amount), - ("Bytes", bytes_total), - ("Random_garbage", "afjf0f3+3++"), - ("More_random_garbage", 349000909990), - ] - # Add the tempurl headers to the return dictionary, if they have - # been initialized - if self.meta["tempurl_key_1"] is not None: - ret["headers"]["x-account-meta-temp-url-key"] = self.meta["tempurl_key_1"] - if self.meta["tempurl_key_2"] is not None: - ret["headers"]["x-account-meta-temp-url-key-2"] = self.meta[ - "tempurl_key_2" - ] - return ret - - if len(args) == 1: - # If the length is exactly one, then only a container was - # specified. - return self.ret_cont_stat(args) - - # In any other case the query is for an object. - # Iterate over the object query list. - return self.ret_obj_stat(args) - - def ret_obj_stat(self, args): - """Return object stats from stat query.""" - ret = [] - for obj in args[1]: - to_add = { - "headers": self.obj_meta[args[0]][obj], - "success": True, - "object": obj, - } - to_add["headers"]["content-type"] = "binary/octet-stream" - ret.append(to_add) - return ret - - def ret_cont_stat(self, args): - """Return container stats from stat query.""" - ret = {} - ret["headers"] = {} - if "Acc_example" in self.cont_meta[args[0]].keys(): - ret["container"] = args[0] - ret["headers"].update(self.cont_meta[args[0]]) - ret["success"] = True - return ret - - def post(self, container=None, objects=None, options=None): - """Mock the post call of SwiftService.""" - - def update_meta(target, headers, meta): - for (meta, value) in meta: - if not value: - del headers[f"x-{target}-meta-{meta}"] - continue - headers[f"x-{target}-meta-{meta}"] = value - - if container and objects: - for obj in objects: - update_meta( - "object", - self.obj_meta[container][obj.object_name], - obj.options.get("meta", []), - ) - return [{"success": True} for _ in objects] - elif container: - update_meta("container", self.cont_meta[container], options.get("meta", [])) - else: - # Get the URL key 2 - key = options["meta"][0].split(":")[1] - self.meta["tempurl_key_2"] = key - return {"success": True} - - def set_swift_meta_container(self, container): - """Generate test swift metadata for a container.""" - self.cont_meta[container] = {} - self.obj_meta[container] = {} - self.cont_meta[container]["x-container-meta-obj-example"] = "example" - self.cont_meta[container]["x-container-meta-usertags"] = ";".join( - ["SD-Connect", "with", "container", "tags"] - ) - self.cont_meta[container]["Acc_example"] = "example" - - def set_swift_meta_object(self, container, obj): - """Generate test swift metadata for an object.""" - self.obj_meta[container][obj] = { - "x-object-meta-usertags": "objects;with;tags", - "x-object-meta-obj-example": "example", - } - - def set_s3_meta_object(self, container, obj): - """Generate test s3 metadata for an object.""" - self.obj_meta[container][obj] = {} - self.obj_meta[container][obj][ - "x-object-meta-s3cmd-attrs" - ] = "atime:1536648772/ctime:1536648921/gid:101/gname:example" - - -class Mock_Session: - """ - Mock-up class for the Openstack keystoneauth1 session instance. - - It contains the relevant methods for querying the OS identity API (aka. - keystone). - """ - - def __init__(self): - """Initialize Mock session.""" - self.auth = None - - def invalidate(self, _): - """Mock session invalidation.""" - return True - - def get_user_id(self): - """Fetch the user id from the mock OS Session.""" - return "test_user_id" - - def get_endpoint(self, service_type=None): - """Fetch a service endpoint from the mock OS Session.""" - return "http://localhost:8443/swift/v1/AUTH_example" diff --git a/tests/cypress/integration/browser.spec.js b/tests/cypress/integration/browser.spec.js index 887c88560..d442b0a35 100644 --- a/tests/cypress/integration/browser.spec.js +++ b/tests/cypress/integration/browser.spec.js @@ -1,6 +1,7 @@ -describe("Browse buckets and test operations", function () { +describe("Browse containers and test operations", function () { beforeEach(function () { + cy.deleteDB() cy.login(' Log In with SSO ') }); @@ -8,11 +9,11 @@ describe("Browse buckets and test operations", function () { cy.contains('Log Out').click() }); - it("should be able to filter table, adjust display buckets per page and pagination", () => { - cy.get('[data-testid="bucketsPerPage"]').select('5 per page') + it("should be able to filter table, adjust display containers per page and pagination", () => { + cy.get('[data-testid="containersPerPage"]').select('5 per page') cy.contains('1-5 / 10') cy.get('[data-testid="paginationSwitch"]').click() - cy.get('[data-testid="bucketsPerPage"]').should('be.disabled') + cy.get('[data-testid="containersPerPage"]').should('be.disabled') cy.get('.input').type('test-container-5') }) @@ -24,7 +25,7 @@ describe("Browse buckets and test operations", function () { .within(() => { cy.get('td').eq(0).then(($elem) => { cy.get($elem).dblclick() - cy.url().should('eq', Cypress.config().baseUrl + '/browse/test_user_id/placeholder/' + $elem.get(0).innerText.split('\n')[0].trim()) + cy.url().should('eq', Cypress.config().baseUrl + '/browse/testuser/test-id-0/' + $elem.get(0).innerText.split('\n')[0].trim()) cy.wait(2000) }) @@ -38,7 +39,7 @@ describe("Browse buckets and test operations", function () { .within(() => { cy.get('td').eq(0).click() cy.get('td').eq(1).then(($elem) => { - expect($elem.get(0).innerText.split('\n')[0].trim()).to.have.lengthOf(40) + expect($elem.get(0).innerText.split('\n')[0].trim()).to.have.lengthOf(52) }) }) }) @@ -53,7 +54,7 @@ describe("Browse buckets and test operations", function () { cy.get('li').contains(hashFirstElem).should('have.length', 1) // not sure we have a prettier way to do this // as cypress seems to have some issues with new window being opened - cy.get(':nth-child(1) > :nth-child(5) > .field > .control > .button').invoke('attr', 'href').should('contain', '&objkey=' + hashFirstElem) + cy.get(':nth-child(1) > :nth-child(5) > .field > .control > .button').invoke('attr', 'href').should('contain', '/test-object-' + hashFirstElem) }) }) @@ -78,11 +79,13 @@ describe("Browse buckets and test operations", function () { // add few tags cy.get('tbody tr').contains('Edit').click() + cy.wait(250) cy.get('.taginput input').type('adding.couple more') cy.get('button').contains('Save').click() + cy.wait(250) cy.get('tbody tr .tags').first().children('.tag').should('have.length', 6) - // remove all tags from a bucket + // remove all tags from a container cy.get('tbody tr').contains('Edit').click() cy.get('.taginput-container').children('span').should('have.length', 6) cy.get('.delete').each(el => { @@ -90,12 +93,13 @@ describe("Browse buckets and test operations", function () { }); cy.get('.taginput-container').children('span').should('have.length', 0) cy.get('button').contains('Save').click() - cy.get('tbody .tags .tag').should('have.length', 36) + cy.get('tbody .tags .tag').should('have.length', 0) }) it("should display, add, remove object tags", () => { cy.get('tbody tr').first().dblclick() + cy.wait(1000) // object list loads with tags cy.get('tbody tr .tags').first().children('.tag').should('have.length', 3) @@ -104,12 +108,15 @@ describe("Browse buckets and test operations", function () { cy.get('h1').should('contain', 'Editing object') cy.get('.delete').first().click() cy.get('button').contains('Save').click() + cy.wait(1000) cy.get('tbody tr .tags').first().children('.tag').should('have.length', 2) // add few tags cy.get('tbody tr').contains('Edit').click() + cy.wait(1000) cy.get('.taginput input').type('adding.couple more') cy.get('button').contains('Save').click() + cy.wait(1000) cy.get('tbody tr .tags').first().children('.tag').should('have.length', 5) // remove all tags from an object @@ -120,6 +127,7 @@ describe("Browse buckets and test operations", function () { }); cy.get('.taginput-container').children('span').should('have.length', 0) cy.get('button').contains('Save').click() + cy.wait(1000) cy.get('tbody tr .tags').first().children('.tag').should('have.length', 0) }) }) diff --git a/tests/cypress/integration/userInfo.spec.js b/tests/cypress/integration/userInfo.spec.js index 6e6a8d289..b6f9f3046 100644 --- a/tests/cypress/integration/userInfo.spec.js +++ b/tests/cypress/integration/userInfo.spec.js @@ -6,7 +6,7 @@ describe("Login and log out a user", function () { expect($browse).to.have.length(1) expect($browse).to.contain('Browse') }) - cy.url().should('eq', Cypress.config().baseUrl + '/browse/test_user_id/placeholder') + cy.url().should('eq', Cypress.config().baseUrl + '/browse/testuser/test-id-0') cy.contains('Log Out').click() }) @@ -17,7 +17,7 @@ describe("Login and log out a user", function () { expect($browse).to.have.length(1) expect($browse).to.contain('Selain') }) - cy.url().should('eq', Cypress.config().baseUrl + '/browse/test_user_id/placeholder') + cy.url().should('eq', Cypress.config().baseUrl + '/browse/testuser/test-id-0') cy.contains('Kirjaudu ulos').click() }) @@ -34,13 +34,13 @@ describe("Retrieve User information", function () { }); it("should login the user and switch to user infomation and retrieve correct data", () => { - cy.url().should('eq', Cypress.config().baseUrl + '/browse/test_user_id/placeholder') + cy.url().should('eq', Cypress.config().baseUrl + '/browse/testuser/test-id-0') cy.contains('User information').click() cy.wait(1000) - cy.url().should('eq', Cypress.config().baseUrl + '/browse/test_user_id') - cy.contains('placeholder') - cy.contains('test_user_id') - cy.contains('test_account') + cy.url().should('eq', Cypress.config().baseUrl + '/browse/testuser') + cy.contains('test-name-0') + cy.contains('testuser') + cy.contains('test-id-0') cy.contains('Buckets: 10') }) @@ -48,22 +48,22 @@ describe("Retrieve User information", function () { cy.get('.navbar-dropdown').invoke('css', 'display', 'block') .should('have.css', 'display', 'block') cy.wait(1000) - cy.contains('wol').click() + cy.contains('test-name-0').click() cy.wait(1000) - cy.url().should('eq', Cypress.config().baseUrl + '/browse/test_user_id/wol') + cy.url().should('eq', Cypress.config().baseUrl + '/browse/testuser/test-id-0') cy.contains('User information').click() - cy.contains('test_account') + cy.contains('testuser') cy.contains('Buckets: 10') - cy.contains('wol') + cy.contains('test-name-0') cy.get('.navbar-dropdown').invoke('css', 'display', 'block') .should('have.css', 'display', 'block') cy.wait(2000) - cy.contains('what').click() + cy.contains('test-name-1').click() cy.wait(1000) - cy.url().should('eq', Cypress.config().baseUrl + '/browse/test_user_id') + cy.url().should('eq', Cypress.config().baseUrl + '/browse/testuser') cy.contains('.buttons > .button','Browser').click() cy.wait(2000) - cy.url().should('eq', Cypress.config().baseUrl + '/browse/test_user_id/what') + cy.url().should('eq', Cypress.config().baseUrl + '/browse/testuser/test-id-1') }) }) diff --git a/tests/cypress/support/commands.js b/tests/cypress/support/commands.js index eb8db48a6..f56c3b47c 100644 --- a/tests/cypress/support/commands.js +++ b/tests/cypress/support/commands.js @@ -33,6 +33,9 @@ Cypress.Commands.add("login", (loginMessage) => { cy.wait(1000) }) +Cypress.Commands.add("deleteDB", () => { + indexedDB.deleteDatabase("sd-connect") +}) // some exceptions like API reponse from delete we are not catching // and we don't need to, thus we ignore Cypress.on("uncaught:exception", () => { diff --git a/tests/performance/locustfile.py b/tests/performance/locustfile.py index 898f109aa..aca87e6d9 100644 --- a/tests/performance/locustfile.py +++ b/tests/performance/locustfile.py @@ -15,12 +15,12 @@ def logout(l_instance): def api_containers(l_instance): """Get container listing.""" - l_instance.client.get("/api/buckets") + l_instance.client.get("/api/containers") def api_objects(l_instance): """Get object listing.""" - l_instance.client.get("/api/bucket/objects?bucket=test-container-0") + l_instance.client.get("/api/container/objects?container=test-container-0") def api_active(l_instance): diff --git a/tests/ui_unit/creation.py b/tests/ui_unit/creation.py deleted file mode 100644 index 7fdfa839c..000000000 --- a/tests/ui_unit/creation.py +++ /dev/null @@ -1,97 +0,0 @@ -""" -Module that contains some frequently used constructors. - -The purpose is to ease in the building of the test environment. -""" - - -import logging -import hashlib -import os -import json -import time - -import cryptography.fernet -from swift_browser_ui.ui._convenience import generate_cookie - -from tests.common.mockups import Mock_Request, Mock_Service, Mock_Session - - -def add_csrf_to_cookie(cookie, req, bad_sign=False): - """Add specified csrf test variables to cookie.""" - # Getting options as a set - cookie["referer"] = "http://localhost:8080" - if bad_sign: - cookie["signature"] = "incorrect" - else: - cookie["signature"] = hashlib.sha256( - (cookie["id"] + cookie["referer"] + req.app["Salt"]).encode("utf-8") - ).hexdigest() - return cookie - - -def encrypt_cookie(cookie, req): - """Add encrypted cookie to request.""" - cookie_crypted = ( - req.app["Crypt"].encrypt(json.dumps(cookie).encode("utf-8")).decode("utf-8") - ) - req.cookies["S3BROW_SESSION"] = cookie_crypted - - -def get_request_with_fernet(): - """Create a request with a working fernet object.""" - ret = Mock_Request() - ret.app["Sessions"] = {} - ret.app["Log"] = logging.getLogger(name="test_logger") - ret.app["Crypt"] = cryptography.fernet.Fernet( - cryptography.fernet.Fernet.generate_key() - ) - ret.app["Salt"] = hashlib.sha256(os.urandom(512)).hexdigest() - return ret - - -def get_request_with_login_form(): - ret = get_request_with_fernet() - ret.set_post( - { - "username": "test", - "password": "password", - } - ) - return ret - - -def get_request_with_mock_openstack(): - """Create a request with a openstack mock-up service & session.""" - ret = get_request_with_fernet() - cookie, _ = generate_cookie(ret) - cookie["referer"] = "http://localhost:8080" - cookie["signature"] = ( - hashlib.sha256( - (cookie["id"] + cookie["referer"] + ret.app["Salt"]).encode("utf-8") - ) - ).hexdigest() - session = cookie["id"] - ret.cookies["S3BROW_SESSION"] = ( - ret.app["Crypt"].encrypt(json.dumps(cookie).encode("utf-8")).decode("utf-8") - ) - ret.app["Sessions"][session] = {} - ret.app["Sessions"][session]["OS_sess"] = Mock_Session() - ret.app["Sessions"][session]["ST_conn"] = Mock_Service() - ret.app["Sessions"][session]["Avail"] = { - "projects": ["test-project-1", "test-project-2"], - "domains": ["default"], - } - cur_time = time.time() - ret.app["Sessions"][session]["last_used"] = cur_time - ret.app["Sessions"][session]["max_lifetime"] = cur_time + 28800 - return session, ret - - -def get_full_crypted_session_cookie(cookie, app): - """.""" - cookie["referer"] = "http://localhost:8080" - cookie["signature"] = ( - hashlib.sha256((cookie["id"] + cookie["referer"] + app["Salt"]).encode("utf-8")) - ).hexdigest() - return app["Crypt"].encrypt(json.dumps(cookie).encode("utf-8")).decode("utf-8") diff --git a/tests/ui_unit/mock_server.py b/tests/ui_unit/mock_server.py index 53bde6d3b..07776790f 100644 --- a/tests/ui_unit/mock_server.py +++ b/tests/ui_unit/mock_server.py @@ -1,88 +1,210 @@ """Module for creating a server with mock-up openstack.""" -from os import environ +import os import logging +import typing import unittest.mock +import random +import hashlib +import datetime +import re +import json +import asyncio +import aiohttp.web import swift_browser_ui.ui.server -# Import some mock-ups that are already made before -from tests.common.mockups import ( - return_project_avail, - return_test_swift_endpoint, - Mock_Service, - Mock_Session, -) +import tests.common.mockups -SESSION_MODE = bool(environ.get("TEST_SESSION_MODE", False)) +SESSION_MODE = bool(os.environ.get("TEST_SESSION_MODE", False)) logging.basicConfig() logging.root.setLevel(logging.DEBUG) -def mock_initiate_os_session(token, _): - """Create a mock os session object.""" - return Mock_Session() +class MockSwiftMiddleware(tests.common.mockups.APITestBase): + """Mock Openstack implementation as aiohttp server middleware.""" + + def setUp(self): + """Set up mock Openstack Swift object storage contents.""" + super().setUp() + self.containeramount = int(os.environ.get("TEST_CONTAINER_AMOUNT", 10)) + self.object_range = (1, int(os.environ.get("TEST_MAX_OBJECT_AMOUNT", 100))) + self.size_range = (1, int(os.environ.get("TEST_MAX_OBJECT_SIZE", 1048576))) + + self.bodge_lock = None + + self.containers = {} + self.container_meta = {} + self.object_meta = {} + + def reinit_with_data(self): + """Reinitialize data if user logs in again.""" + for i in range(0, self.containeramount): + to_add = [] + + # Iterate over a random amount of objects + for _ in range( + 0, + random.randint( # nosec + self.object_range[0], + self.object_range[1], + ), + ): # nosec + ohash = hashlib.sha1(os.urandom(256)).hexdigest() # nosec + to_append = { + "hash": ohash, + "name": f"test-object-{ohash}", + "last_modified": datetime.datetime.now().isoformat(), + "bytes": random.randint( # nosec + self.size_range[0], + self.size_range[1], + ), + "meta": { + "X-Object-Meta-Usertags": "objects;with;tags", + "X-Object-Meta-Obj-Example": "example", + }, + } + to_append["content_type"] = "binary/octet-stream" + to_add.append(to_append) + + self.containers[f"test-instance-container-{i}"] = { + "name": f"test-instance-container-{i}", + "count": len(to_add), + "bytes": random.randint(0, 252000000), # nosec + "_objects": to_add, + "meta": { + "X-Container-Meta-Obj-Example": "example", + "X-Container-Meta-Usertags": ";".join( + ("SD-Connect", "with", "container", "tags") + ), + }, + } + + self.container_meta = { + "X-Container-Meta-Obj-Example": "example", + "X-Container-Meta-Usertags": ";".join( + ("SD-Connect", "with", "container", "tags") + ), + } + self.object_meta = { + "X-Object-Meta-Usertags": "objects;with;tags", + "X-Object-Meta-Obj-Example": "example", + } + + @aiohttp.web.middleware + async def wrap_mock_swift( + self, + request: aiohttp.web.Request, + handler: typing.Callable[ + [aiohttp.web.Request], + typing.Coroutine[typing.Awaitable, typing.Any, aiohttp.web.Response], + ], + ) -> aiohttp.web.Response: + """Replace mock aiohttp client return data based on route.""" + if self.bodge_lock is None: + self.bodge_lock = asyncio.Lock() + async with self.bodge_lock: + request.app["api_client"] = self.mock_client + + self.mock_client_response.status = 200 + + # Handle logins with simple redirection, we have a "session" in place already + if request.path == "/login/kill": + return aiohttp.web.Response(status=303, headers={"Location": "/"}) + if ( + request.path == "/login/return" + or request.path == "/login/websso" + or request.path == "/login/credentials" + ): + self.reinit_with_data() + return aiohttp.web.Response(status=303, headers={"Location": "/browse"}) + + # Handle frontend routes without patching sessions, we don't want redirections + # for now + mock_no_sess = unittest.mock.AsyncMock( + side_effect=aiohttp.web.HTTPUnauthorized + ) + p_no_sess = unittest.mock.patch( + "aiohttp_session.get_session", + mock_no_sess, + ) + if ( + request.path == "" + or request.path == "/" + or request.path == "/loginpassword" + or request.path == "/login" + or request.path == "/login/front" + ): + with p_no_sess: + return await handler(request) + + # Mock overrides for api related routes, ignoring user and projects since those' + # are available in the session object + if request.method == "GET" and re.match(r"^/api/test-id-\d$", request.path): + if "marker" not in request.query: + self.mock_iter.return_value = json.dumps( + list(self.containers.values()) + ).encode("utf-8") + else: + self.mock_iter.return_value = json.dumps([]).encode("utf-8") + if re.match(r"^/api/test-id-\d/.*$", request.path): + if request.method == "GET": + if "marker" not in request.query: + self.mock_iter.return_value = json.dumps( + self.containers[request.match_info["container"]]["_objects"] + ).encode("utf-8") + else: + self.mock_iter.return_value = json.dumps([]).encode("utf-8") + if request.method == "POST": + if "objects" in request.query: + objects = await request.json() + self.object_meta = { + f"X-Object-Meta-{k}": v + for k, v in filter(lambda i: i[1], objects[0][1].items()) + } + return aiohttp.web.HTTPNoContent() + container = await request.json() + self.container_meta = { + f"X-Container-Meta-{k}": v + for k, v in filter(lambda i: i[1], container.items()) + } + return aiohttp.web.HTTPNoContent() + if request.method == "GET" and re.match( + r"^/api/meta/test-id-\d/.*$", request.path + ): + if "objects" in request.query: + print(self.object_meta) + self.mock_client_response.headers = self.object_meta + else: + print(self.container_meta) + self.mock_client_response.headers = self.container_meta + if request.method == "GET" and re.match( + r"^/api/meta/test-id-\d$", request.path + ): + self.mock_client_response.status = 204 + self.mock_client_response.headers = { + "X-Account-Container-Count": 10, + "X-Account-Object-Count": 15000, + "X-Account-Bytes-Used": 147284563, + } + + with self.p_get_sess: + return await handler(request) -def mock_initiate_swift_service(_): - """Create a mock os swift service object.""" - serv = Mock_Service() - serv.init_with_data( - # Default container amount is 10, can be overriden with envvar. - containers=int(environ.get("TEST_CONTAINER_AMOUNT", 10)), - # Default object range is [0, 25[, the max can be overridden - # with envvar. - object_range=( - 0, - int(environ.get("TEST_MAX_OBJECT_AMOUNT", 25)), - ), - # Default size range is [0, 1048576[, the max can be overridden - # with envvar. - size_range=(1, int(environ.get("TEST_MAX_OBJECT_SIZE", 1048576))), - ) - # Add mock data for object metadata - for key in serv.containers.keys(): - serv.set_swift_meta_container(key) - for obj in serv.containers[key]: - serv.set_swift_meta_object(key, obj["name"]) - # The downloads aren't mocked, so no contents to any file. This isn't - # something we need to test, and also would consume too much resources. - # NOTE: Some random metadata creation could be added here. - return serv - - -async def mock_graceful_shutdown(_): - """.""" - - -@unittest.mock.patch( - "swift_browser_ui.ui.server.kill_sess_on_shutdown", mock_graceful_shutdown -) -@unittest.mock.patch( - "swift_browser_ui.ui.login.initiate_os_session", mock_initiate_os_session -) -@unittest.mock.patch( - "swift_browser_ui.ui.login.initiate_os_service", mock_initiate_swift_service -) -@unittest.mock.patch( - "swift_browser_ui.ui.login.get_availability_from_token", return_project_avail -) -@unittest.mock.patch( - "swift_browser_ui.ui.login.test_swift_endpoint", return_test_swift_endpoint -) @unittest.mock.patch.dict( swift_browser_ui.ui.server.setd, { "auth_endpoint_url": "https://localhost:5001/v3", "has_trust": False, "logfile": None, - "port": int(environ.get("TEST_SERVER_PORT", 8080)), + "port": int(os.environ.get("TEST_SERVER_PORT", 8080)), "verbose": True, "debug": True, "set_session_devmode": SESSION_MODE, @@ -96,7 +218,12 @@ def run_mock_server(): # Run the server in an ordinary fashion after patching everything logging.basicConfig() logging.root.setLevel(logging.DEBUG) - app = swift_browser_ui.ui.server.servinit() + + inject = MockSwiftMiddleware() + inject.setUp() + inject.reinit_with_data() + + app = swift_browser_ui.ui.server.servinit(inject_middleware=[inject.wrap_mock_swift]) swift_browser_ui.ui.server.run_server_insecure(app) diff --git a/tests/ui_unit/test_api.py b/tests/ui_unit/test_api.py index 27b8240d7..1b01ad520 100644 --- a/tests/ui_unit/test_api.py +++ b/tests/ui_unit/test_api.py @@ -1,493 +1,624 @@ """Module for testing ``swift_browser_ui.ui.api``.""" + import json -import hashlib -import os import unittest import types -import logging - -from aiohttp.web import HTTPNotFound - -from swiftclient.service import SwiftError -from swift_browser_ui.ui.api import ( - get_os_user, - os_list_projects, - update_metadata_bucket, - update_metadata_object, -) -from swift_browser_ui.ui.api import swift_list_buckets, swift_list_objects -from swift_browser_ui.ui.api import swift_download_object -from swift_browser_ui.ui.api import get_metadata_object -from swift_browser_ui.ui.api import get_metadata_bucket -from swift_browser_ui.ui.api import get_project_metadata -from swift_browser_ui.ui.api import get_os_active_project -from swift_browser_ui.ui.api import swift_download_shared_object -from swift_browser_ui.ui.api import swift_download_container -from swift_browser_ui.ui.api import swift_replicate_container -from swift_browser_ui.ui.settings import setd +import aiohttp.web -from tests.ui_unit.creation import get_request_with_mock_openstack +import tests.common.mockups +import swift_browser_ui.ui.api -class APITestClass(unittest.IsolatedAsyncioTestCase): - """Testing the Object Browser API.""" +class APITestClass(tests.common.mockups.APITestBase): + """Test the Object Browser API.""" def setUp(self): - """Set up necessary mocks.""" - self.cookie, self.request = get_request_with_mock_openstack() + """Set up mocks.""" + super().setUp() async def test_get_os_user(self): - """Test for the API call for fetching the Openstack username.""" - # _, request = get_request_with_mock_openstack() - response = await get_os_user(self.request) - self.assertEqual(json.loads(response.text), "test_user_id") - - # Follows the testing of the different list functions - async def test_list_containers_correct(self): - """Test function swift_list_buckets with a correct query.""" - self.request.app["Sessions"][self.cookie]["ST_conn"].init_with_data( - containers=100, - object_range=(0, 10), - size_range=(65535, 262144), - ) - response = await swift_list_buckets(self.request) - buckets = json.loads(response.text) - buckets = [i["name"] for i in buckets] - comp = [ - i - for i in self.request.app["Sessions"][self.cookie][ - "ST_conn" - ].containers.keys() - ] - # Test if return all the correct values from the mock service - self.assertEqual(buckets, comp) - - async def test_list_containers_swift_error(self): - """Test function swift_list_buckets when raising SwiftError.""" - self.request.app["Sessions"][self.cookie]["ST_conn"].list = unittest.mock.Mock( - side_effect=SwiftError("...") - ) - with self.assertRaises(HTTPNotFound): - _ = await swift_list_buckets(self.request) - - async def test_list_objects_correct(self): - """Test function swift_list_objetcs with a correct query.""" - self.request.app["Sessions"][self.cookie]["ST_conn"].init_with_data( - containers=5, - object_range=(10, 100), - size_range=(65535, 262144), - ) - for container in ["test-container-" + str(i) for i in range(0, 5)]: - self.request.query["bucket"] = container - response = await swift_list_objects(self.request) - objects = json.loads(response.text) - objects = [i["hash"] for i in objects] - comp = [ - i["hash"] - for i in self.request.app["Sessions"][self.cookie]["ST_conn"].containers[ - container - ] + """Test session Openstack username fetch.""" + with self.p_get_sess, self.p_json_resp: + await swift_browser_ui.ui.api.get_os_user(self.mock_request) + self.aiohttp_json_response_mock.assert_called_once_with("testuser") + + async def test_os_list_projects(self): + """Test Openstack available project scope fetch.""" + with self.p_get_sess, self.p_json_resp: + await swift_browser_ui.ui.api.os_list_projects( + self.mock_request, + ) + self.aiohttp_json_response_mock.assert_called_once_with( + [ + { + "id": "test-id-0", + "name": "test-name-0", + }, + { + "id": "test-id-1", + "name": "test-name-1", + }, ] - self.assertEqual(objects, comp) - - async def test_list_objects_with_unicode_nulls(self): - """Test function swift_list_objects with unicode nulls in type.""" - self.request.app["Sessions"][self.cookie]["ST_conn"].init_with_data( - containers=1, - object_range=(1, 10), - size_range=(65535, 262144), - has_content_type="text/html", - ) - self.request.query["bucket"] = "test-container-0" - response = await swift_list_objects(self.request) - objects = json.loads(response.text) - self.assertEqual( - objects[0]["content_type"], - "text/html", ) - async def test_list_without_containers(self): - """Test function list buckets on a project without containers.""" - self.request.app["Sessions"][self.cookie]["ST_conn"].init_with_data(containers=0) - response = await swift_list_buckets(self.request) - objects = json.loads(response.text) - self.assertEqual(objects, []) - - async def test_list_with_invalid_container(self): - """Test function list objects with an invalid container id.""" - # Let's create some test data anyway - self.request.app["Sessions"][self.cookie]["ST_conn"].init_with_data( - containers=3, - object_range=(1, 5), - size_range=(65535, 262144), - ) - self.request.query[ - "bucket" - ] = """Free buckets causing havoc\ - at the local market""" - response = await swift_list_objects(self.request) - objects = json.loads(response.text) - self.assertEqual(objects, []) - - async def test_list_without_objects(self): - """Test function list objects without an object query in request.""" - self.request.app["Sessions"][self.cookie]["ST_conn"].init_with_data( - containers=1, - object_range=(0, 0), - ) - self.request.query["bucket"] = "test-container-0" - with self.assertRaises(HTTPNotFound): - _ = await swift_list_objects(self.request) + async def test_swift_list_containers(self): + """Test container listing fetch from Openstack.""" + with self.p_get_sess, self.p_sresp: + await swift_browser_ui.ui.api.swift_list_containers( + self.mock_request, + ) + self.mock_response_prepare.assert_awaited_once() + self.mock_iter.assert_called() + self.mock_response_write.assert_awaited() + self.mock_response_write_eof.assert_awaited_once() + + async def test_swift_list_containers_fail_ostack(self): + """Test failed container listing fetch from Openstack.""" + # Set client response to incorrect + self.mock_client_response.status = 401 + with self.p_get_sess, self.p_sresp: + await swift_browser_ui.ui.api.swift_list_containers( + self.mock_request, + ) + self.aiohttp_construct_response_mock.assert_called_once_with(status=401) + self.mock_response_write.assert_not_called() + self.mock_response_prepare.assert_awaited_once() + self.mock_response_write_eof.assert_awaited_once() + + async def test_swift_list_containers_no_access(self): + """Test failed container listing access rights.""" + # Set request project to incorrect + self.mock_request.match_info["project"] = "test-id-not-available" + with self.p_get_sess, self.assertRaises(aiohttp.web.HTTPForbidden): + await swift_browser_ui.ui.api.swift_list_containers( + self.mock_request, + ) - async def test_os_list_projects(self): - """Test function os_list_projects for correct output.""" - # No need to generate test data, all required stuff can be found in the - # mock-app - response = await os_list_projects(self.request) - projects = json.loads(response.text) - self.assertEqual( - projects, self.request.app["Sessions"][self.cookie]["Avail"]["projects"] + async def test_swift_list_objects(self): + """Test object listing fetch from Openstack.""" + with self.p_get_sess, self.p_sresp: + await swift_browser_ui.ui.api.swift_list_objects( + self.mock_request, + ) + self.aiohttp_construct_response_mock.assert_called_once_with(status=200) + self.mock_response_prepare.assert_awaited_once() + self.mock_iter.assert_called() + self.mock_response_write.assert_awaited() + self.mock_response_write_eof.assert_awaited_once() + + async def test_swift_create_container(self): + """Test container creation with Openstack.""" + # Set json for tags + self.mock_request.json = unittest.mock.AsyncMock( + return_value={ + "tags": "a,b,c,d,e", + } ) - - async def test_swift_download_object(self): - """Test object download function.""" - self.request.app["Sessions"][self.cookie]["ST_conn"].init_with_data( - containers=1, - object_range=(1, 1), - size_range=(4096, 4096), + with self.p_get_sess, self.p_resp: + await swift_browser_ui.ui.api.swift_create_container( + self.mock_request, + ) + self.aiohttp_construct_response_mock.assert_called_once_with( + status=200, ) - # Get names for the download query - container = "test-container-0" - o_name = self.request.app["Sessions"][self.cookie]["ST_conn"].containers[ - container - ][0]["name"] - - self.request.app["Sessions"][self.cookie]["ST_conn"].set_swift_meta_container( - "test-container-0" + self.mock_client.put.assert_called_once() + self.mock_request.json.assert_awaited_once() + + async def test_swift_delete_container(self): + """Test container deletion with Openstack.""" + with self.p_get_sess: + resp = await swift_browser_ui.ui.api.swift_delete_container( + self.mock_request, + ) + self.assertEqual(resp.status, 200) + + async def test_swift_delete_containers_to_objects(self): + """Test container deletion with objects in query.""" + self.mock_request.query["objects"] = "placeholder" + mock_obj_delete = unittest.mock.AsyncMock() + patch_obj_delete = unittest.mock.patch( + "swift_browser_ui.ui.api.swift_delete_objects", + mock_obj_delete, ) - self.request.app["Sessions"][self.cookie]["ST_conn"].set_swift_meta_object( - "test-container-0", o_name + with patch_obj_delete: + await swift_browser_ui.ui.api.swift_delete_container( + self.mock_request, + ) + mock_obj_delete.assert_called_once() + mock_obj_delete.assert_awaited_once() + + async def test_swift_delete_objects(self): + """Test object batch deletion.""" + # set json for objects + self.mock_request.json = unittest.mock.AsyncMock( + return_value=[ + "test-object-0", + "test-object-1", + "test-object-2", + ], ) - - self.request.query["bucket"] = container - self.request.query["objkey"] = o_name - - # Set the swift endpoint URL - setd["swift_endpoint_url"] = "http://object.example-os.com:443/v1" - - # Case 1: Only Meta-Temp-URL-Key exists - self.request.app["Sessions"][self.cookie]["ST_conn"].tempurl_key_1 = hashlib.md5( - os.urandom(128) - ).hexdigest() # nosec - resp = await swift_download_object(self.request) - self.assertTrue(resp.headers["Location"] is not None) - - # Case 2: Only Meta-Temp-URL-Key-2 - self.request.app["Sessions"][self.cookie]["ST_conn"].tempurl_key_1 = None - self.request.app["Sessions"][self.cookie]["ST_conn"].tempurl_key_2 = hashlib.md5( - os.urandom(128) - ).hexdigest() # nosec - resp = await swift_download_object(self.request) - self.assertTrue(resp.headers["Location"] is not None) - - # Case 3: No pre-existing keys - self.request.app["Sessions"][self.cookie]["ST_conn"].meta = { - "tempurl_key_1": None, - "tempurl_key_2": None, - } - resp = await swift_download_object(self.request) - self.assertTrue( - self.request.app["Sessions"][self.cookie]["ST_conn"].meta["tempurl_key_1"] - is None + with self.p_get_sess: + resp = await swift_browser_ui.ui.api.swift_delete_objects( + self.mock_request, + ) + self.mock_client.post.assert_called_once() + self.mock_response_read.assert_awaited_once() + self.assertEqual(resp.status, 200) + self.assertEqual(resp.body, b"exampleread") + + async def test_swift_delete_objects_toomany(self): + """Test object batch deletion with too many objects.""" + self.mock_request.json = unittest.mock.AsyncMock( + return_value=[f"test-object-{i}" for i in range(0, 10001)] ) - self.assertTrue( - self.request.app["Sessions"][self.cookie]["ST_conn"].meta["tempurl_key_2"] - is not None + with self.p_get_sess, self.assertRaises(aiohttp.web.HTTPBadRequest): + await swift_browser_ui.ui.api.swift_delete_objects( + self.mock_request, + ) + + async def test_swift_download_object(self): + """Test object download with Openstack TempUrl engine.""" + get_tempurl_key_mock = unittest.mock.AsyncMock(return_value="test-key") + patch_tempkey = unittest.mock.patch( + "swift_browser_ui.ui.api.get_tempurl_key", + get_tempurl_key_mock, ) - self.assertTrue(resp.headers["Location"] is not None) - - # Below are the tests for the metadata API endpoint. The account metadata - # fetches won't be implemented and thus won't be tested, - # because the account - # metadata contains sensitive information. (e.g. the tempurl keys) - async def test_get_container_meta_swift(self): - """Test metadata API endpoint with container metadata.""" - req_sessions = self.request.app["Sessions"] - req_sessions[self.cookie]["ST_conn"].init_with_data( - containers=1, - object_range=(1, 1), - size_range=(252144, 252144), + generate_tempurl_mock = unittest.mock.Mock(return_value="?tempurl=true") + patch_tempurl = unittest.mock.patch( + "swift_browser_ui.ui.api.generate_temp_url", + generate_tempurl_mock, ) - req_sessions[self.cookie]["ST_conn"].meta = { - "tempurl_key_1": None, - "tempurl_key_2": None, + + self.mock_client_response.headers["Content-Type"] = "test-content" + + with self.p_get_sess, patch_tempkey, patch_tempurl: + resp = await swift_browser_ui.ui.api.swift_download_object( + self.mock_request, + ) + self.assertEqual(resp.status, 302) + self.assertEqual(resp.headers["Location"], "https://test-endpoint-0?tempurl=true") + self.assertEqual(resp.headers["Content-Type"], "test-content") + self.mock_client.head.assert_called_once() + get_tempurl_key_mock.assert_awaited_once() + generate_tempurl_mock.assert_called_once() + + async def test_swift_get_met_wrapper(self): + """Test single object metadata fetch with Openstack.""" + self.mock_client_response.headers = { + "X-Object-Meta-One": "examplemeta", + "X-Object-Meta-Two": "examplemeta", + "X-Object-Meta-Three": "examplemeta", + "X-Object-Meta-Four": "examplemeta", + "X-Object-Meta-s3cmd-attrs": "first:1/second:2/third:3", } - req_sessions[self.cookie]["ST_conn"].set_swift_meta_container("test-container-0") - - # Set up the query string - self.request.query["container"] = "test-container-0" - - resp = await get_metadata_bucket(self.request) - resp = json.loads(resp.text) - - expected = [ - "test-container-0", - {"obj-example": "example", "usertags": "SD-Connect;with;container;tags"}, - ] - self.assertEqual(resp, expected) - - async def test_set_container_meta_swift(self): - """Test metadata API endpoint with container metadata.""" - req_sessions = self.request.app["Sessions"] - req_sessions[self.cookie]["ST_conn"].init_with_data( - containers=1, - object_range=(1, 1), - size_range=(252144, 252144), + with self.p_get_sess: + ret = await swift_browser_ui.ui.api._swift_get_object_metadata_wrapper( + self.mock_request, + "test-object", + ) + self.assertIn("Three", ret[1]) + self.mock_client.head.assert_called_once() + self.assertIn("s3cmd-attrs", ret[1]) + self.assertIn("second", ret[1]["s3cmd-attrs"]) + + async def test_swift_get_meta_fail(self): + """Test single object metadata fetch failure with Openstack.""" + self.mock_client_response.status = 404 + with self.p_get_sess, self.assertRaises(aiohttp.web.HTTPInternalServerError): + await swift_browser_ui.ui.api._swift_get_object_metadata_wrapper( + self.mock_request, + "test-object", + ) + + async def test_swift_batch_get_object_meta(self): + """Test batch object metadata fetch with Openstack.""" + mock_get_meta = unittest.mock.AsyncMock(return_value=("object", "meta")) + patch_get_meta = unittest.mock.patch( + "swift_browser_ui.ui.api._swift_get_object_metadata_wrapper", + mock_get_meta, ) - req_sessions[self.cookie]["ST_conn"].meta = { - "tempurl_key_1": None, - "tempurl_key_2": None, + self.mock_request.query = {"objects": "obja,objb,objc,objd,obje,objf"} + with self.p_get_sess, patch_get_meta: + await swift_browser_ui.ui.api.swift_get_batch_object_metadata( + self.mock_request, + ) + mock_get_meta.assert_called() + mock_get_meta.assert_awaited() + + async def test_swift_get_container_meta(self): + """Test container metadata fetch with Openstack.""" + self.mock_client_response.headers = { + "X-Container-Meta-One": "examplemeta", + "X-Container-Meta-Two": "examplemeta", + "X-Container-Meta-Three": "examplemeta", + "X-Container-Meta-Four": "examplemeta", + "X-Container-Meta-Five": "examplemeta", } - req_sessions[self.cookie]["ST_conn"].set_swift_meta_container("test-container-0") - - self.request.query["container"] = "test-container-0" - self.request.set_post('{"usertags":"tags;for;testing"}') - - post_rest = await update_metadata_bucket(self.request) - self.assertEqual(post_rest.status, 204) - - self.request.set_post(None) - resp = await get_metadata_bucket(self.request) - resp = json.loads(resp.text) - - expected = [ - "test-container-0", - {"obj-example": "example", "usertags": "tags;for;testing"}, - ] - self.assertEqual(resp, expected) - - async def test_get_object_meta_swift(self): - """Test metadata API endpoint when object has swift metadata.""" - req_sessions = self.request.app["Sessions"] - req_sessions[self.cookie]["ST_conn"].init_with_data( - containers=1, - object_range=(1, 1), - size_range=(252144, 252144), + with self.p_get_sess: + await swift_browser_ui.ui.api.swift_get_metadata_container( + self.mock_request, + ) + self.mock_client.head.assert_called_once() + + async def test_swift_batch_get_object_meta_through_container(self): + """Test object batch meta fetch via container meta handler.""" + mock_object_meta_batch = unittest.mock.AsyncMock() + patch_object_meta = unittest.mock.patch( + "swift_browser_ui.ui.api.swift_get_batch_object_metadata", + mock_object_meta_batch, ) - req_sessions[self.cookie]["ST_conn"].meta = { - "tempurl_key_1": None, - "tempurl_key_2": None, - } - # Get the object key to test with - objs = req_sessions[self.cookie]["ST_conn"].containers["test-container-0"] - objkey = [i["name"] for i in objs][0] - - req_sessions[self.cookie]["ST_conn"].set_swift_meta_container("test-container-0") + self.mock_request.query["objects"] = "true" + with patch_object_meta: + await swift_browser_ui.ui.api.swift_get_metadata_container( + self.mock_request, + ) + mock_object_meta_batch.assert_awaited_once() + + async def test_swift_update_object_meta_wrapper(self): + """Test single object metadata update with Openstack.""" + with self.p_get_sess: + ret = await swift_browser_ui.ui.api._swift_update_object_meta_wrapper( + self.mock_request, + "test-object", + [("a", 1), ("b", 2), ("c", 3)], + ) + self.mock_client.post.assert_called_once() + self.assertEqual(ret, 200) - req_sessions[self.cookie]["ST_conn"].set_swift_meta_object( - "test-container-0", objkey + async def test_batch_swift_update_object_metadata(self): + """Test object metadata batch update with Openstack.""" + mock_object_meta_update = unittest.mock.AsyncMock( + return_value=204, ) - - # Set up the query string - self.request.query["container"] = "test-container-0" - self.request.query["object"] = objkey - - resp = await get_metadata_object(self.request) - resp = json.loads(resp.text) - expected = [[objkey, {"obj-example": "example", "usertags": "objects;with;tags"}]] - self.assertEqual(resp, expected) - - async def test_set_object_meta_swift(self): - """Test metadata API endpoint with container metadata.""" - req_sessions = self.request.app["Sessions"] - req_sessions[self.cookie]["ST_conn"].init_with_data( - containers=1, - object_range=(1, 1), - size_range=(252144, 252144), + patch_meta_update = unittest.mock.patch( + "swift_browser_ui.ui.api._swift_update_object_meta_wrapper", + mock_object_meta_update, ) - container = "test-container-0" - req_sessions[self.cookie]["ST_conn"].set_swift_meta_container(container) - for obj in req_sessions[self.cookie]["ST_conn"].obj_meta.keys(): - req_sessions[self.cookie]["ST_conn"].set_swift_meta_object(container, obj) - - obj = list(req_sessions[self.cookie]["ST_conn"].obj_meta[container])[0] - self.request.query["container"] = container - self.request.set_post( - json.dumps( - [ - [ - obj, - {"usertags": "tags;for;testing"}, - ] - ] - ) + + self.mock_request.json = unittest.mock.AsyncMock( + return_value=[ + ( + "test-object-0", + { + "test-meta-0": "test", + "test-meta-1": "another_test", + }, + ), + ( + "test-object-1", + { + "test-meta-0": "test", + "test-meta-1": "another_test", + }, + ), + ( + "test-object-2", + { + "test-meta-0": "test", + "test-meta-1": "another_test", + }, + ), + ( + "test-object-3", + { + "test-meta-0": "test", + "test-meta-1": "another_test", + }, + ), + ( + "test-object-4", + { + "test-meta-0": "test", + "test-meta-1": "another_test", + }, + ), + ] ) - post_resp = await update_metadata_object(self.request) - self.assertEqual(post_resp.status, 204) + with self.p_get_sess, patch_meta_update: + resp = await swift_browser_ui.ui.api.swift_batch_update_object_metadata( + self.mock_request, + ) + self.assertEqual(resp.status, 204) + mock_object_meta_update.assert_awaited() + + # Cover failure + mock_object_meta_update.return_value = 404 + with self.p_get_sess, patch_meta_update, self.assertRaises( + aiohttp.web.HTTPNotFound + ): + await swift_browser_ui.ui.api.swift_batch_update_object_metadata( + self.mock_request, + ) - self.request.set_post(None) - self.request.query["object"] = obj - resp = await get_metadata_object(self.request) - resp = json.loads(resp.text) + async def test_batch_swift_update_object_metadata_no_objects(self): + """Test object metadata batch update with missing body.""" + self.mock_request.json = unittest.mock.AsyncMock(return_value=[]) + with self.p_get_sess, self.assertRaises(aiohttp.web.HTTPBadRequest): + await swift_browser_ui.ui.api.swift_batch_update_object_metadata( + self.mock_request, + ) - expected = [ - [ - obj, - {"obj-example": "example", "usertags": "tags;for;testing"}, - ] - ] - self.assertEqual(resp, expected) - - async def test_get_object_meta_s3(self): - """Test metadata API endpoint when object has s3 metadata.""" - req_sessions = self.request.app["Sessions"] - req_sessions[self.cookie]["ST_conn"].init_with_data( - containers=1, - object_range=(1, 1), - size_range=(252144, 252144), + async def test_swift_update_container_metadata(self): + """Test container metadata update with Openstack.""" + self.mock_request.json = unittest.mock.AsyncMock( + return_value=[ + ("meta0", "test-data"), + ("meta1", "more-test-data"), + ], + ) + with self.p_get_sess: + resp = await swift_browser_ui.ui.api.swift_update_container_metadata( + self.mock_request, + ) + self.assertEqual(resp.status, 200) + self.mock_request.json.assert_awaited_once() + self.mock_client.post.assert_called_once() + + async def test_swift_update_object_metadata_via_container(self): + """Test object batch meta update via container meta update.""" + mock_object_batch_meta_update = unittest.mock.AsyncMock() + p_obj_update = unittest.mock.patch( + "swift_browser_ui.ui.api.swift_batch_update_object_metadata", + mock_object_batch_meta_update, ) - req_sessions[self.cookie]["ST_conn"].meta = { - "tempurl_key_1": None, - "tempurl_key_2": None, + self.mock_request.query["objects"] = "true" + with p_obj_update: + await swift_browser_ui.ui.api.swift_update_container_metadata( + self.mock_request, + ) + mock_object_batch_meta_update.assert_awaited_once() + + async def test_swift_get_project_metadata(self): + """Test project metadata fetch with Openstack.""" + self.mock_client_response.status = 204 + self.mock_client_response.headers = { + "X-Account-Container-Count": 100, + "X-Account-Object-Count": 10000, + "X-Account-Bytes-Used": 65535, } - # Get the object key to test with - objs = req_sessions[self.cookie]["ST_conn"].containers["test-container-0"] - objkey = [i["name"] for i in objs][0] + with self.p_get_sess: + await swift_browser_ui.ui.api.swift_get_project_metadata( + self.mock_request, + ) + self.mock_client.head.assert_called_once() + + async def test_swift_get_project_metadata_fail(self): + """Test project metadata fetch with failed request.""" + self.mock_client_response.status = 403 + with self.p_get_sess, self.assertRaises(aiohttp.web.HTTPUnauthorized): + await swift_browser_ui.ui.api.swift_get_project_metadata( + self.mock_request, + ) - req_sessions[self.cookie]["ST_conn"].set_swift_meta_container("test-container-0") + async def test_swift_get_shared_container_address(self): + """Test shared container address fetch.""" + with self.p_get_sess: + resp = await swift_browser_ui.ui.api.get_shared_container_address( + self.mock_request, + ) + self.assertEqual(resp.body, b'"https://test-endpoint-0/v1/AUTH_test-id-0"') - req_sessions[self.cookie]["ST_conn"].set_s3_meta_object( - "test-container-0", objkey + async def test_swift_get_container_acl_wrapper(self): + """Test single container ACL fetch with Openstack.""" + self.mock_client_response.headers = { + "X-Container-Read": "test-project-0:*,.r:*,.rlistings,test-project-1:*", + "X-Container-Write": "test-project-0:*,test-project-1:*", + } + with self.p_get_sess: + ret = await swift_browser_ui.ui.api._swift_get_container_acl_wrapper( + self.mock_request, + "test-container", + ) + self.assertEqual( + { + "test-project-0": { + "write": "*", + "read": "*", + }, + "test-project-1": { + "write": "*", + "read": "*", + }, + }, + ret[1], ) + self.mock_client.head.assert_called_once() - # Set up the query string - self.request.query["container"] = "test-container-0" - self.request.query["object"] = objkey - - resp = await get_metadata_object(self.request) - resp = json.loads(resp.text) + # Cover edge case with headers containing only .rlistings/.r:* + self.mock_client_response.headers = { + "X-Container-Read": ".r:*,.rlistings", + "X-Container-Write": "test-project-0:*,test-project-1:*", + } + with self.p_get_sess: + ret = await swift_browser_ui.ui.api._swift_get_container_acl_wrapper( + self.mock_request, + "test-container", + ) + self.assertEqual( + { + "test-project-0": {"write": "*"}, + "test-project-1": {"write": "*"}, + }, + ret[1], + ) - expected = [ - [ # nosec - objkey, + async def test_get_access_control_metadata(self): + """Test get ACL metadata with Openstack.""" + acl_wrapper_mock = unittest.mock.AsyncMock( + return_value=( + "test-container", { - "s3cmd-attrs": { - "atime": "1536648772", - "ctime": "1536648921", - "gid": "101", - "gname": "example", - } + "test-project-0": { + "write": "*", + }, + "test-project-1": { + "write": "*", + "read": "*", + }, }, + ), + ) + p_acl_wrapper = unittest.mock.patch( + "swift_browser_ui.ui.api._swift_get_container_acl_wrapper", + acl_wrapper_mock, + ) + # (ab)use side effects to mimic openstacks "null" terminated container paging + self.mock_client_response.json = unittest.mock.AsyncMock( + side_effect=[ + [{"name": "test-container"}], + [], ] - ] - self.assertEqual(resp, expected) - - async def test_get_object_meta_swift_whole(self): - """Test metadata API endpoint with containers' objects.""" - req_sessions = self.request.app["Sessions"] - req_sessions[self.cookie]["ST_conn"].init_with_data( - containers=1, - object_range=(5, 5), - size_range=(252144, 252144), ) - req_sessions[self.cookie]["ST_conn"].meta = { - "tempurl_key_1": None, - "tempurl_key_2": None, - } - - req_sessions[self.cookie]["ST_conn"].set_swift_meta_container("test-container-0") - - objs = req_sessions[self.cookie]["ST_conn"].containers["test-container-0"] - for key in [i["name"] for i in objs]: - req_sessions[self.cookie]["ST_conn"].set_swift_meta_object( - "test-container-0", key + with self.p_get_sess, p_acl_wrapper: + resp = await swift_browser_ui.ui.api.get_access_control_metadata( + self.mock_request, ) - - self.request.query["container"] = "test-container-0" - self.request.query["object"] = "%s,%s,%s,%s,%s" % tuple([i["name"] for i in objs]) - - resp = await get_metadata_object(self.request) - resp = json.loads(resp.text) - - comp = [ - [i, {"usertags": "objects;with;tags", "obj-example": "example"}] - for i in [j["name"] for j in objs] - ] - - self.assertEqual(resp, comp) - - async def test_get_project_metadata(self): - """Test metadata API endpoint for account metadata.""" - self.request.app["Sessions"][self.cookie]["ST_conn"].init_with_data( - containers=5, object_range=(100, 100), size_range=(1073741824, 1073741824) + acl_wrapper_mock.assert_awaited() + ret = json.loads(resp.body) + self.assertEqual("https://test-endpoint-0/v1/AUTH_test-id-0", ret["address"]) + self.assertEqual( + ret["access"], + { + "test-container": { + "test-project-0": { + "write": "*", + }, + "test-project-1": { + "write": "*", + "read": "*", + }, + } + }, + ) + # Cover edge case when ending in a 204 + self.mock_client_response.json = unittest.mock.AsyncMock( + return_value=[{"name": "test-container"}] + ) + self.mock_client.get = unittest.mock.Mock( + side_effect=[ + self.MockHandler(self.mock_client_response), + self.MockHandler( + types.SimpleNamespace( + **{ + "status": 204, + } + ) + ), + ] + ) + with self.p_get_sess, p_acl_wrapper: + resp = await swift_browser_ui.ui.api.get_access_control_metadata( + self.mock_request, + ) + acl_wrapper_mock.assert_awaited() + ret = json.loads(resp.body) + self.assertEqual("https://test-endpoint-0/v1/AUTH_test-id-0", ret["address"]) + self.assertEqual( + ret["access"], + { + "test-container": { + "test-project-0": { + "write": "*", + }, + "test-project-1": { + "write": "*", + "read": "*", + }, + } + }, ) - # Compare against the bare minimum amount of information - # required, which - # will be what the function should return. - comp = { - "Account": "AUTH_test_account", - "Containers": 5, - "Objects": 500, - "Bytes": 536870912000, + async def test_remove_project_container_acl(self): + """Test project removal from container acl with Openstack.""" + self.mock_client_response.headers = { + "X-Container-Read": "test-project-0:*,.r:*,.rlistings,test-project-1:*", + "X-Container-Write": "test-project-0:*,test-project-1:*", } + with self.p_get_sess, self.assertRaises(aiohttp.web.HTTPNotFound): + await swift_browser_ui.ui.api.remove_project_container_acl( + self.mock_request, + ) + self.mock_client_response.status = 204 + with self.p_get_sess: + await swift_browser_ui.ui.api.remove_project_container_acl( + self.mock_request, + ) + self.mock_client.post.assert_called_with( + "https://test-endpoint-0/v1/AUTH_test-id-0/test-container", + headers={ + "X-Auth-Token": "test-token-0", + "X-Container-Read": "test-project-0:*,.r:*,.rlistings", + "X-Container-Write": "test-project-0:*", + }, + ) - resp = await get_project_metadata(self.request) - resp = json.loads(resp.text) - - self.assertEqual(resp, comp) - - async def test_get_os_active_project(self): - """Test active project API endpoint.""" - self.request.app["Sessions"][self.cookie]["active_project"] = "placeholder" - resp = await get_os_active_project(self.request) - text = json.loads(resp.text) - self.assertEqual(resp.status, 200) - self.assertEqual(text, "placeholder") + async def test_remove_container_acl(self): + """Test container acl removal with Openstack.""" + with self.p_get_sess, self.assertRaises(aiohttp.web.HTTPNotFound): + await swift_browser_ui.ui.api.remove_container_acl( + self.mock_request, + ) + self.mock_client_response.status = 204 + with self.p_get_sess: + await swift_browser_ui.ui.api.remove_container_acl( + self.mock_request, + ) + self.mock_client.post.assert_called_with( + "https://test-endpoint-0/v1/AUTH_test-id-0/test-container", + headers={ + "X-Auth-Token": "test-token-0", + "X-Container-Read": "", + "X-Container-Write": "", + }, + ) - def tearDown(self): - """Test teardown.""" - self.cookie = None - self.request = None + async def test_add_project_container_acl(self): + """Test project addition to container acl with Openstack.""" + self.mock_client_response.headers = { + "X-Container-Read": "test-project-0:*,.r:*,.rlistings", + "X-Container-Write": "test-project-0:*", + } + self.mock_request.query["projects"] = "test-project-1" + self.mock_request.query["rights"] = "rw" + with self.p_get_sess, self.assertRaises(aiohttp.web.HTTPNotFound): + await swift_browser_ui.ui.api.add_project_container_acl( + self.mock_request, + ) + self.mock_client_response.status = 204 + with self.p_get_sess: + await swift_browser_ui.ui.api.add_project_container_acl( + self.mock_request, + ) + self.mock_client.post.assert_called_with( + "https://test-endpoint-0/v1/AUTH_test-id-0/test-container", + headers={ + "X-Auth-Token": "test-token-0", + "X-Container-Read": "test-project-0:*,.r:*,.rlistings,test-project-1:*", + "X-Container-Write": "test-project-0:*,test-project-1:*", + }, + ) -class TestProxyFunctions(unittest.IsolatedAsyncioTestCase): +class ProxyFunctionsTestClass(tests.common.mockups.APITestBase): """Test the handlers proxying information to the upload runner.""" def setUp(self): """.""" - self.mock_request = types.SimpleNamespace( - **{ - "match_info": { - "project": "test-project", - "container": "test-container", - "object": "test-object", - }, - "query": { - "from_container": "test-container-2", - "from_project": "test-project-2", - }, - "query_string": "&test-query=test-value", - "app": { - "Sessions": { - "session_key": { - "active_project": {"id": "test-id"}, - "Token": "test-token", - } - }, - "Log": logging.getLogger(name="test_logger"), - }, - "remote": "remote", - } - ) - - self.api_check_mock = unittest.mock.MagicMock(return_value="session_key") - self.patch_api_check = unittest.mock.patch( - "swift_browser_ui.ui.api.api_check", self.api_check_mock - ) + super().setUp() + self.mock_request.match_info = { + "project": "test-project", + "container": "test-container", + "object": "test-object", + } + self.mock_request.query = { + "from_container": "test-container-2", + "from_project": "test-project-2", + } + self.mock_request.query_string = ("&test-query=test-value§",) + self.mock_request.remote = ("remote",) self.session_open_mock = unittest.mock.AsyncMock(return_value="test_runner_id") self.patch_runner_session = unittest.mock.patch( @@ -504,41 +635,48 @@ def setUp(self): "swift_browser_ui.ui.api.sign", self.sign_mock ) - self.setd_mock = {"upload_external_endpoint": "http://test-endpoint:9092/"} - self.patch_setd = unittest.mock.patch( - "swift_browser_ui.ui.api.setd", self.setd_mock - ) - async def test_swift_download_share_object(self): """Test share object download handler.""" - with self.patch_api_check, self.patch_runner_session, self.patch_setd, self.patch_sign: - resp = await swift_download_shared_object(self.mock_request) - - self.assertIn("test-signature", resp.headers["Location"]) - self.assertIn("test-valid", resp.headers["Location"]) - self.assertIn("test-endpoint", resp.headers["Location"]) - self.assertEqual(303, resp.status) + with self.p_get_sess, self.patch_runner_session, self.patch_setd, self.patch_sign: + resp = await swift_browser_ui.ui.api.swift_download_shared_object( + self.mock_request, + ) + self.assertIn("test-signature", resp.headers["Location"]) + self.assertIn("test-valid", resp.headers["Location"]) + self.assertIn("test-endpoint", resp.headers["Location"]) + self.assertEqual(303, resp.status) async def test_swift_download_container(self): """Test container download handler.""" - with self.patch_api_check, self.patch_runner_session, self.patch_setd, self.patch_sign: - resp = await swift_download_container(self.mock_request) - - self.assertIn("test-signature", resp.headers["Location"]) - self.assertIn("test-valid", resp.headers["Location"]) - self.assertIn("test-endpoint", resp.headers["Location"]) - self.assertEqual(303, resp.status) + with self.p_get_sess, self.patch_runner_session, self.patch_setd, self.patch_sign: + resp = await swift_browser_ui.ui.api.swift_download_container( + self.mock_request, + ) + self.assertIn("test-signature", resp.headers["Location"]) + self.assertIn("test-valid", resp.headers["Location"]) + self.assertIn("test-endpoint", resp.headers["Location"]) + self.assertEqual(303, resp.status) async def test_swift_replicate_container(self): """Test replicate container handler.""" - with self.patch_api_check, self.patch_runner_session, self.patch_setd, self.patch_sign: - resp = await swift_replicate_container(self.mock_request) - - self.assertIn("test-signature", resp.headers["Location"]) - self.assertIn("test-valid", resp.headers["Location"]) - self.assertIn("test-endpoint", resp.headers["Location"]) - self.assertEqual(307, resp.status) - self.assertIn("from_container", resp.headers["Location"]) - self.assertIn("test-container-2", resp.headers["Location"]) - self.assertIn("from_project", resp.headers["Location"]) - self.assertIn("test-project-2", resp.headers["Location"]) + with self.p_get_sess, self.patch_runner_session, self.patch_setd, self.patch_sign: + resp = await swift_browser_ui.ui.api.swift_replicate_container( + self.mock_request, + ) + self.assertIn("test-signature", resp.headers["Location"]) + self.assertIn("test-valid", resp.headers["Location"]) + self.assertIn("test-endpoint", resp.headers["Location"]) + self.assertEqual(307, resp.status) + self.assertIn("from_container", resp.headers["Location"]) + self.assertIn("test-container-2", resp.headers["Location"]) + self.assertIn("from_project", resp.headers["Location"]) + self.assertIn("test-project-2", resp.headers["Location"]) + + async def test_get_upload_session(self): + """Test get active upload session.""" + with self.p_get_sess, self.patch_runner_session, self.patch_setd, self.patch_sign: + await swift_browser_ui.ui.api.get_upload_session( + self.mock_request, + ) + self.session_open_mock.assert_awaited_once() + self.sign_mock.assert_awaited_once() diff --git a/tests/ui_unit/test_convenience.py b/tests/ui_unit/test_convenience.py index 180377678..723832830 100644 --- a/tests/ui_unit/test_convenience.py +++ b/tests/ui_unit/test_convenience.py @@ -1,344 +1,126 @@ """Module for testing ``swift_browser_ui.ui._convenience``.""" - -import hashlib -import os import unittest -import time -from aiohttp.web import HTTPUnauthorized, Response -from aiohttp.web import HTTPForbidden +import aiohttp.web + +from requests.exceptions import ConnectionError # type: ignore -import cryptography.fernet -from swiftclient.service import SwiftService -from keystoneauth1.session import Session -from swift_browser_ui.ui._convenience import api_check, generate_cookie -from swift_browser_ui.ui._convenience import disable_cache, decrypt_cookie -from swift_browser_ui.ui._convenience import session_check, setup_logging -from swift_browser_ui.ui._convenience import get_availability_from_token -from swift_browser_ui.ui._convenience import initiate_os_service -from swift_browser_ui.ui._convenience import initiate_os_session -from swift_browser_ui.ui._convenience import check_csrf, clear_session_info -from swift_browser_ui.ui.settings import setd +import swift_browser_ui.ui._convenience -from tests.ui_unit.creation import ( - get_request_with_fernet, - get_request_with_mock_openstack, - get_full_crypted_session_cookie, - add_csrf_to_cookie, - encrypt_cookie, -) -from tests.common.mockups import mock_token_output, urlopen +import tests.common.mockups +from tests.common.mockups import mock_token_output -class TestConvenienceFunctions(unittest.TestCase): +class TestConvenienceFunctions( + tests.common.mockups.APITestBase, +): """Test convenience functions.""" def setUp(self): """Test that the logging setup function works.""" - setup_logging() - setd["verbose"] = True - setup_logging() - setd["debug"] = True - setup_logging() + super().setUp() + + def test_test_swift_endpoint(self): + """Test that the swift endpoint check works as it should.""" + mock_get = unittest.mock.Mock( + side_effect=[ + ConnectionError, + None, + ] + ) + p_get = unittest.mock.patch( + "swift_browser_ui.ui._convenience.requests.head", + mock_get, + ) + with self.assertRaises(aiohttp.web.HTTPServiceUnavailable), p_get: + swift_browser_ui.ui._convenience.test_swift_endpoint("test-endpoint") + with p_get: + swift_browser_ui.ui._convenience.test_swift_endpoint("test-endpoint") + mock_get.assert_called_with("test-endpoint") + + async def test_sign(self): + """Test the signature generation.""" + mock_setd = {} + p_setd = unittest.mock.patch( + "swift_browser_ui.ui._convenience.setd", + mock_setd, + ) + mock_sign_api = unittest.mock.Mock() + p_sign = unittest.mock.patch( + "swift_browser_ui.ui._convenience.swift_browser_ui.common.signature.sign_api_request", + mock_sign_api, + ) + with self.assertRaises(aiohttp.web.HTTPNotImplemented), p_setd: + await swift_browser_ui.ui._convenience.sign( + 3600, + "/testpath", + ) + mock_setd["sharing_request_token"] = "test-token" + with p_setd, p_sign: + await swift_browser_ui.ui._convenience.sign( + 3600, + "/testpath", + ) + mock_sign_api.assert_called_with( + "/testpath", + valid_for=3600, + key=b"test-token", + ) def test_disable_cache(self): """Test that the disable_cache function correctly disables cache.""" - response = Response(status=200, body=b"OK") - response = disable_cache(response) + response = aiohttp.web.Response(status=200, body=b"OK") + response = swift_browser_ui.ui._convenience.disable_cache(response) self.assertEqual( response.headers["Cache-Control"], ("no-cache, no-store, must-revalidate") ) self.assertEqual(response.headers["Pragma"], "no-Cache") self.assertEqual(response.headers["Expires"], "0") - def test_generate_cookie(self): - """Test that the cookie generation works.""" - testreq = get_request_with_fernet() - self.assertTrue(generate_cookie(testreq) is not None) - - def test_decrypt_cookie(self): - """Test that the cookie decrypt function works.""" - testreq = get_request_with_fernet() - # Generate cookie is tested separately, it can be used for testing the - # rest of the functions without mockups - cookie, testreq.cookies["S3BROW_SESSION"] = generate_cookie(testreq) - self.assertEqual(cookie, decrypt_cookie(testreq)) - - def test_session_check_nocookie(self): - """Test session check raise 401 on non-existing cookie.""" - req = get_request_with_fernet() - with self.assertRaises(HTTPUnauthorized): - session_check(req) - - def test_session_check_invtoken(self): - """Test session check raise 401 on a stale cookie.""" - req = get_request_with_fernet() - _, req.cookies["S3BROW_SESSION"] = generate_cookie(req) - req.app["Crypt"] = cryptography.fernet.Fernet( - cryptography.fernet.Fernet.generate_key() - ) - with self.assertRaises(HTTPUnauthorized): - session_check(req) - - def test_session_check_nosession(self): - """ - Test session check function raise 401 on invalid session cookie. - - (i.e. it cannot be found in the open session list) - """ - req = get_request_with_fernet() - _, req.cookies["S3BROW_SESSION"] = generate_cookie(req) - req.app["Sessions"] = {} - with self.assertRaises(HTTPUnauthorized): - session_check(req) - - def test_session_check_expired_last_used(self): - """Test session check function raise on expired last use.""" - session, req = get_request_with_mock_openstack() - req.app["Sessions"][session]["last_used"] = time.time() - 7200 - with self.assertRaises(HTTPUnauthorized): - session_check(req) - - def test_session_check_expired_max_lifetime(self): - """Test session check function raise on expired lifetime.""" - session, req = get_request_with_mock_openstack() - req.app["Sessions"][session]["max_lifetime"] = time.time() - 86400 - with self.assertRaises(HTTPUnauthorized): - session_check(req) - - def test_session_check_correct(self): - """ - Test that the ordinary session check function result is True. - - Test condition when the request is formed correctly. - """ - req = get_request_with_fernet() - cookie, _ = generate_cookie(req) - - req.cookies["S3BROW_SESSION"] = get_full_crypted_session_cookie(cookie, req.app) - - session = cookie["id"] - - req.app["Sessions"][session] = {} - req.app["Sessions"][session]["last_used"] = time.time() - 360 - req.app["Sessions"][session]["max_lifetime"] = time.time() + 86400 - self.assertIsNone(session_check(req)) - - # The api_check session check function testing – Might seem unnecessary, - # but are required since e.g. token rescoping can fail the sessions - # before the next API call, also might try to use the API - # while rescoping -> 401 - def test_api_check_raise_on_no_cookie(self): - """Test raise if there's no session cookie.""" - testreq = get_request_with_fernet() - _, testreq.cookies["S3BROW_SESSION"] = generate_cookie(testreq) - testreq.app["Sessions"] = {} - with self.assertRaises(HTTPUnauthorized): - api_check(testreq) - - def test_api_check_raise_on_invalid_cookie(self): - """Test raise if there's an invalid session cookie.""" - testreq = get_request_with_fernet() - _, testreq.cookies["S3BROW_SESSION"] = generate_cookie(testreq) - testreq.app["Sessions"] = {} - with self.assertRaises(HTTPUnauthorized): - api_check(testreq) - - def test_api_check_raise_on_invalid_fernet(self): - """Test raise if the cryptographic key has changed.""" - testreq = get_request_with_fernet() - _, testreq.cookies["S3BROW_SESSION"] = generate_cookie(testreq) - testreq.app["Crypt"] = cryptography.fernet.Fernet( - cryptography.fernet.Fernet.generate_key() - ) - with self.assertRaises(HTTPUnauthorized): - api_check(testreq) - - def test_api_check_raise_on_no_connection(self): - """Test raise if there's no existing OS connection on an API call.""" - testreq = get_request_with_fernet() - cookie, _ = generate_cookie(testreq) - testreq.cookies["S3BROW_SESSION"] = get_full_crypted_session_cookie( - cookie, testreq.app - ) - session = cookie["id"] - testreq.app["Sessions"][session] = {} - testreq.app["Sessions"][session]["Avail"] = "placeholder" - testreq.app["Sessions"][session]["OS_sess"] = "placeholder" - testreq.app["Sessions"][session]["last_used"] = time.time() - 360 - testreq.app["Sessions"][session]["max_lifetime"] = time.time() + 86400 - with self.assertRaises(HTTPUnauthorized): - api_check(testreq) - - def test_api_check_raise_on_no_session(self): - """Test raise if there's no established OS session on an API call.""" - testreq = get_request_with_fernet() - cookie, _ = generate_cookie(testreq) - testreq.cookies["S3BROW_SESSION"] = get_full_crypted_session_cookie( - cookie, testreq.app - ) - session = cookie["id"] - testreq.app["Sessions"][session] = {} - testreq.app["Sessions"][session]["ST_conn"] = "placeholder" - testreq.app["Sessions"][session]["Avail"] = "placeholder" - testreq.app["Sessions"][session]["last_used"] = time.time() - 360 - testreq.app["Sessions"][session]["max_lifetime"] = time.time() + 86400 - with self.assertRaises(HTTPUnauthorized): - api_check(testreq) - - def test_api_check_raise_on_no_avail(self): - """Test raise if the availability wasn't checked before an API call.""" - testreq = get_request_with_fernet() - cookie, _ = generate_cookie(testreq) - testreq.cookies["S3BROW_SESSION"] = get_full_crypted_session_cookie( - cookie, testreq.app + async def test_get_availability_from_token(self): + """Test token availability fetch from Openstack.""" + p_setd = unittest.mock.patch( + "swift_browser_ui.ui._convenience.setd", + {"auth_endpoint_url": "http://example.osexampleserver.com:5001/v3"}, ) - session = cookie["id"] - testreq.app["Sessions"][session] = {} - testreq.app["Sessions"][session]["ST_conn"] = "placeholder" - testreq.app["Sessions"][session]["OS_sess"] = "placeholder" - testreq.app["Sessions"][session]["last_used"] = time.time() - 360 - testreq.app["Sessions"][session]["max_lifetime"] = time.time() + 86400 - with self.assertRaises(HTTPUnauthorized): - api_check(testreq) - - def test_api_check_success(self): - """Test that the api_check function runs with correct input.""" - testreq = get_request_with_fernet() - cookie, _ = generate_cookie(testreq) - testreq.cookies["S3BROW_SESSION"] = get_full_crypted_session_cookie( - cookie, testreq.app + self.mock_client_response.json = unittest.mock.AsyncMock( + side_effect=[ + tests.common.mockups.mock_token_project_avail, + tests.common.mockups.mock_token_domain_avail, + ], ) - session = cookie["id"] - testreq.app["Sessions"][session] = {} - testreq.app["Sessions"][session]["Avail"] = "placeholder" - testreq.app["Sessions"][session]["OS_sess"] = "placeholder" - testreq.app["Sessions"][session]["ST_conn"] = "placeholder" - testreq.app["Sessions"][session]["last_used"] = time.time() - 360 - testreq.app["Sessions"][session]["max_lifetime"] = time.time() + 86400 - ret = api_check(testreq) - self.assertEqual(ret, cookie["id"]) - - def test_get_availability_from_token(self): - """Test the get_availability_from_token function.""" - with unittest.mock.patch( - "swift_browser_ui.ui._convenience.setd", - new={"auth_endpoint_url": "http://example.osexampleserver.com:5001/v3"}, - ): - - # Make the required patches to urllib.request to test the function - with unittest.mock.patch("urllib.request.urlopen", new=urlopen): - - # Test with a valid token - token = hashlib.md5(os.urandom(64)).hexdigest() # nosec - avail = get_availability_from_token(token) - - self.assertEqual(avail["projects"], mock_token_output["projects"]) - self.assertEqual(avail["domains"], mock_token_output["domains"]) - - def test_initiate_os_session(self): - """Test initiate_os_session function.""" - with unittest.mock.patch( - "swift_browser_ui.ui.settings.setd", - new={"auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3"}, - ): - ret = initiate_os_session( - hashlib.md5(os.urandom(64)).hexdigest(), "testproject" # nosec + with p_setd: + ret = await swift_browser_ui.ui._convenience.get_availability_from_token( + "test-token", + self.mock_client, ) - self.assertIsInstance(ret, Session) # nosec - - def test_initiate_os_service(self): - """Test initiate_os_servce function.""" - with unittest.mock.patch( - "swift_browser_ui.ui.settings.setd", - new={ - "auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3", - "swift_endpoint_url": "http://obj.exampleosep.com:443/v1", - }, - ): - sess_mock = unittest.mock.MagicMock(Session) - ret = initiate_os_service(sess_mock()) - self.assertIsInstance(ret, SwiftService) # nosec - - def test_check_csrf_os_skip(self): - """Test check_csrf when skipping referer from OS.""" - with unittest.mock.patch( - "swift_browser_ui.ui._convenience.setd", - new={"auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3"}, - ): - testreq = get_request_with_fernet() - cookie, _ = generate_cookie(testreq) - cookie = add_csrf_to_cookie(cookie, testreq) - encrypt_cookie(cookie, testreq) - testreq.headers["Referer"] = "http://example-auth.exampleosep.com" - self.assertTrue(check_csrf(testreq)) - - def test_check_csrf_incorrect_referer(self): - """Test check_csrf when Referer header is incorrect.""" - with unittest.mock.patch( - "swift_browser_ui.ui._convenience.setd", - new={"auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3"}, - ): - testreq = get_request_with_fernet() - cookie, _ = generate_cookie(testreq) - cookie = add_csrf_to_cookie(cookie, testreq) - encrypt_cookie(cookie, testreq) - testreq.headers["Referer"] = "http://notlocaclhost:8080" - with self.assertRaises(HTTPForbidden): - check_csrf(testreq) - - def test_check_csrf_incorrect_signature(self): - """Test check_csrf when signature doesn't match.""" - with unittest.mock.patch( - "swift_browser_ui.ui._convenience.setd", - new={"auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3"}, - ): - testreq = get_request_with_fernet() - cookie, _ = generate_cookie(testreq) - cookie = add_csrf_to_cookie(cookie, testreq, bad_sign=True) - encrypt_cookie(cookie, testreq) - testreq.headers["Referer"] = "http://localhost:8080" - with self.assertRaises(HTTPForbidden): - check_csrf(testreq) - - def test_check_csrf_no_referer(self): - """Test check_csrf when no Referer header is present.""" - with unittest.mock.patch( - "swift_browser_ui.ui._convenience.setd", - new={"auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3"}, - ): - testreq = get_request_with_fernet() - cookie, _ = generate_cookie(testreq) - cookie = add_csrf_to_cookie(cookie, testreq) - encrypt_cookie(cookie, testreq) - self.assertTrue(check_csrf(testreq)) - - def test_check_csrf_correct_referer(self): - """Test check_csrf when the session is valid.""" - with unittest.mock.patch( - "swift_browser_ui.ui._convenience.setd", - new={"auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3"}, - ): - testreq = get_request_with_fernet() - cookie, _ = generate_cookie(testreq) - cookie = add_csrf_to_cookie(cookie, testreq) - encrypt_cookie(cookie, testreq) - testreq.headers["Referer"] = "http://localhost:8080" - self.assertTrue(check_csrf(testreq)) - - def test_clear_session_info(self): - """Test if session information clear works.""" - session, req = get_request_with_mock_openstack() - sess_mock = unittest.mock.MagicMock("keystoneauth.session.Session") - sess = sess_mock() - req.app["Sessions"][session]["OS_sess"] = sess - req.app["Sessions"][session]["Token"] = "not_real_token" + self.assertEqual(ret["projects"], mock_token_output["projects"]) + self.assertEqual(ret["domains"], mock_token_output["domains"]) + + async def test_get_tempurl_key(self): + """Test tempurl key fetch from Openstack.""" + with self.p_get_sess, self.assertRaises(aiohttp.web.HTTPServerError): + ret = await swift_browser_ui.ui._convenience.get_tempurl_key( + self.mock_request, + ) + self.mock_client_response.status = 204 + with self.p_get_sess: + ret = await swift_browser_ui.ui._convenience.get_tempurl_key( + self.mock_request, + ) + self.assertIsNotNone(ret) - clear_session_info(req.app["Sessions"][session]) + self.mock_client_response.headers = {"X-Account-Meta-Temp-Url-Key": "test-key"} + with self.p_get_sess: + ret = await swift_browser_ui.ui._convenience.get_tempurl_key( + self.mock_request, + ) + self.assertEqual(ret, "test-key") - sess.invalidate.assert_called_once() - self.assertIsNone(req.app["Sessions"][session]["ST_conn"]) - self.assertIsNone(req.app["Sessions"][session]["OS_sess"]) - self.assertIsNone(req.app["Sessions"][session]["Avail"]) - self.assertIsNone(req.app["Sessions"][session]["Token"]) + self.mock_client_response.headers = {"X-Account-Meta-Temp-Url-Key-2": "test-key"} + with self.p_get_sess: + ret = await swift_browser_ui.ui._convenience.get_tempurl_key( + self.mock_request, + ) + self.assertEqual(ret, "test-key") diff --git a/tests/ui_unit/test_front.py b/tests/ui_unit/test_front.py index e72ad9518..007eefbf2 100644 --- a/tests/ui_unit/test_front.py +++ b/tests/ui_unit/test_front.py @@ -3,13 +3,17 @@ import unittest import os +import time +import aiohttp_session from aiohttp.test_utils import AioHTTPTestCase from swift_browser_ui.ui.server import servinit -class FrontendTestCase(AioHTTPTestCase): +class FrontendTestCase( + AioHTTPTestCase, +): """Test frontend.""" async def get_application(self): @@ -23,42 +27,75 @@ def return_true(_): async def test_browse(self): """Test /browse handler.""" + session_return = aiohttp_session.Session( + "test-identity", + new=True, + data={}, + ) + session_return["at"] = time.time() + session_return["token"] = "placeholder" + session_return["projects"] = "placeholder" + aiohttp_session_get_session_mock = unittest.mock.AsyncMock() + aiohttp_session_get_session_mock.return_value = session_return + p_get_sess = unittest.mock.patch( + "swift_browser_ui.ui.front.aiohttp_session.get_session", + aiohttp_session_get_session_mock, + ) patch_setd = unittest.mock.patch( "swift_browser_ui.ui.front.setd", new={"static_directory": os.getcwd() + "/swift_browser_ui_frontend/dist"}, ) - patch_check = unittest.mock.patch( - "swift_browser_ui.ui.front.session_check", new=self.return_true - ) - with patch_setd, patch_check: + with patch_setd, p_get_sess: response = await self.client.request("GET", "/browse") self.assertEqual(response.status, 200) self.assertEqual(response.headers["Content-type"], "text/html") async def test_index(self): """Test / handler.""" + session_return = aiohttp_session.Session( + "test-identity", + new=True, + data={}, + ) + session_return["at"] = time.time() + session_return["token"] = "placeholder" + session_return["projects"] = "placeholder" + aiohttp_session_get_session_mock = unittest.mock.AsyncMock() + aiohttp_session_get_session_mock.return_value = session_return + p_get_sess = unittest.mock.patch( + "swift_browser_ui.ui.front.aiohttp_session.get_session", + aiohttp_session_get_session_mock, + ) patch_setd = unittest.mock.patch( "swift_browser_ui.ui.front.setd", new={"static_directory": os.getcwd() + "/swift_browser_ui_frontend/dist"}, ) - patch_check = unittest.mock.patch( - "swift_browser_ui.ui.front.session_check", new=self.return_true - ) - with patch_setd, patch_check: + with patch_setd, p_get_sess: response = await self.client.request("GET", "/") self.assertEqual(response.status, 200) self.assertEqual(response.headers["Content-type"], "text/html") async def test_loginpassword(self): """Test /loginpassword handler.""" + session_return = aiohttp_session.Session( + "test-identity", + new=True, + data={}, + ) + session_return["at"] = time.time() + session_return["token"] = "placeholder" + session_return["projects"] = "placeholder" + aiohttp_session_get_session_mock = unittest.mock.AsyncMock() + aiohttp_session_get_session_mock.return_value = session_return + p_get_sess = unittest.mock.patch( + "swift_browser_ui.ui.front.aiohttp_session.get_session", + aiohttp_session_get_session_mock, + ) patch_setd = unittest.mock.patch( "swift_browser_ui.ui.front.setd", new={"static_directory": os.getcwd() + "/swift_browser_ui_frontend/dist"}, ) - patch_check = unittest.mock.patch( - "swift_browser_ui.ui.front.session_check", new=self.return_true - ) - with patch_setd, patch_check: + with patch_setd, p_get_sess: response = await self.client.request("GET", "/loginpassword") self.assertEqual(response.status, 200) self.assertEqual(response.headers["Content-type"], "text/html") diff --git a/tests/ui_unit/test_login.py b/tests/ui_unit/test_login.py index 11d8d4cb5..3ffda3b21 100644 --- a/tests/ui_unit/test_login.py +++ b/tests/ui_unit/test_login.py @@ -3,37 +3,35 @@ import hashlib import os import unittest -import json -import types import aiohttp import swift_browser_ui.ui.login import swift_browser_ui.ui.settings -from tests.ui_unit.creation import ( - get_request_with_fernet, - get_request_with_login_form, - get_request_with_mock_openstack, -) -from tests.common.mockups import ( - return_project_avail, - return_test_swift_endpoint, - return_invalid, - mock_token_project_avail, - return_mock_token, -) +import tests.common.mockups _path = "/auth/OS-FEDERATION/identity_providers/haka/protocols/saml2/websso" -class LoginTestClass(unittest.IsolatedAsyncioTestCase): +class LoginTestClass(tests.common.mockups.APITestBase): """Testing the Object Browser API.""" + def setUp(self): + """.""" + super().setUp() + self.setd_mock["static_directory"] = ( + __file__.replace("/settings.py", "") + "/static" + ) + self.p_get_sess = unittest.mock.patch( + "swift_browser_ui.ui.login.aiohttp_session.get_session", + self.aiohttp_session_get_session_mock, + ) + async def test_handle_login(self): """Test initial login handler.""" - mock_req = types.SimpleNamespace(**{"query": {"navto": "http://example"}}) - resp = await swift_browser_ui.ui.login.handle_login(mock_req) + self.mock_request.query["navto"] = "http://example" + resp = await swift_browser_ui.ui.login.handle_login(self.mock_request) self.assertEqual(resp.headers["Location"], "/login/front") self.assertEqual(resp.status, 302) @@ -42,11 +40,7 @@ async def test_sso_query_begin_with_trust(self): """Test sso query begin function.""" with unittest.mock.patch( "swift_browser_ui.ui.login.setd", - new={ - "auth_endpoint_url": "https://example.os.com:5001/v3", - "set_origin_address": "https://localhost/login/websso", - "has_trust": True, - }, + self.setd_mock, ): resp = await swift_browser_ui.ui.login.sso_query_begin(None) self.assertEqual(resp.status, 302) @@ -58,330 +52,280 @@ async def test_sso_query_begin_with_trust(self): async def test_sso_query_begin_without_trust(self): """Test sso query begin without trust.""" + self.setd_mock["has_trust"] = False with unittest.mock.patch( "swift_browser_ui.ui.login.setd", - new={ - "auth_endpoint_url": "https://example.os.com:5001/v3", - "origin_address": "https://localhost/login/websso", - "has_trust": False, - "static_directory": (__file__.replace("/settings.py", "") + "/static"), - }, + self.setd_mock, ): resp = await swift_browser_ui.ui.login.sso_query_begin(None) self.assertEqual(resp.status, 200) - async def test_sso_query_end_successful_http_form(self): - """ - Test sso query end function with correct execution parameters. - - This version tests the token delivery in a http encoded form. - """ - patch1 = unittest.mock.patch( - "swift_browser_ui.ui.login.setd", - new={ - "auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3", - "swift_endpoint_url": "http://obj.exampleosep.com:443/v1", - "session_lifetime": 28800, - "history_lifetime": 2592000, - }, - ) - - # Patch away the convenience function for checking project availability - patch2 = unittest.mock.patch( - "swift_browser_ui.ui.login.get_availability_from_token", - new=return_project_avail, + async def test_test_token(self): + """Test the token validity checks.""" + token_md5 = hashlib.md5(os.urandom(64)).hexdigest() # nosec + token_fernet = ( # nosec + "gAAAAABiAmI1X69b0kYq7V41NYl7RJDGIikq4rvN4nWwWeo-CNLkr08ZSLxA0aL" + "DqUhMYIhUSvkqqAbUvHXsjcHfx8gIroUY4h3y1MGBOvpHOZqdhCHq5oMuYsHE1rSpzq7UNfVsW" + "ce6" ) - patch3 = unittest.mock.patch("keystoneauth1.identity.v3.Token") - patch4 = unittest.mock.patch("keystoneauth1.session.Session") - patch5 = unittest.mock.patch("swiftclient.service.SwiftService") - - patch6 = unittest.mock.patch( - "swift_browser_ui.ui.login.test_swift_endpoint", - new=return_test_swift_endpoint, - ) - - with patch1, patch2, patch3, patch4, patch5, patch6: - req = get_request_with_fernet() - token = hashlib.md5(os.urandom(64)).hexdigest() # nosec - req.set_post({"token": token}) - - resp = await swift_browser_ui.ui.login.sso_query_end(req) + # Test with missing token + with self.assertRaises(aiohttp.web.HTTPBadRequest): + swift_browser_ui.ui.login.test_token( + {}, + self.mock_request, + ) - # Test for the correct values - assert req.app["Sessions"] # nosec - session = list(req.app["Sessions"])[0] - self.assertTrue(req.app["Sessions"][session]["Token"] is not None) - self.assertNotEqual(req.app["Sessions"][session]["Avail"], "INVALID") - self.assertEqual( - req.app["Sessions"][session]["active_project"], + # Test with malformed "fernet" token + with self.assertRaises(aiohttp.web.HTTPBadRequest): + swift_browser_ui.ui.login.test_token( { - "name": "placeholder", - "id": "placeholder", + "token": b"1_HsWO4xZLCL5NRBpvF_Fg==", }, + self.mock_request, ) - self.assertEqual(resp.status, 303) - self.assertEqual(resp.headers["Location"], "/browse") - self.assertIn("S3BROW_SESSION", resp.cookies) - - async def test_sso_query_end_successful_url_form(self): - """ - Test sso query end function with correct execution parameters. - This version tests the token delivery in a urlencoded form instead of a - http encoded one. - """ - patch1 = unittest.mock.patch( - "swift_browser_ui.ui.login.setd", - new={ - "auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3", - "swift_endpoint_url": "http://obj.exampleosep.com:443/v1", - "session_lifetime": 28800, - "history_lifetime": 2592000, + # Test with token in form + ret = swift_browser_ui.ui.login.test_token( + { + "token": token_md5, }, + self.mock_request, ) + self.assertEqual(ret, token_md5) - patch2 = unittest.mock.patch( - "swift_browser_ui.ui.login.get_availability_from_token", - new=return_project_avail, + # Test with token in query + self.mock_request.query["token"] = token_fernet + ret = swift_browser_ui.ui.login.test_token( + {}, + self.mock_request, ) - - patch3 = unittest.mock.patch("keystoneauth1.identity.v3.Token") - patch4 = unittest.mock.patch("keystoneauth1.session.Session") - patch5 = unittest.mock.patch("swiftclient.service.SwiftService") - - patch6 = unittest.mock.patch( - "swift_browser_ui.ui.login.test_swift_endpoint", - new=return_test_swift_endpoint, + self.assertEqual(ret, token_fernet) + self.mock_request.query = {} + + # Test with token in headers + self.mock_request.headers["X-Auth-Token"] = token_md5 + ret = swift_browser_ui.ui.login.test_token( + {}, + self.mock_request, ) + self.assertEqual(ret, token_md5) + + # Test with token that's malformed with both md5 and fernet + self.mock_request.headers["X-Auth-Token"] = "token-garbage" + with self.assertRaises(aiohttp.web.HTTPBadRequest): + swift_browser_ui.ui.login.test_token( + {}, + self.mock_request, + ) - with patch1, patch2, patch3, patch4, patch5, patch6: - req = get_request_with_fernet() - token = hashlib.md5(os.urandom(64)).hexdigest() # nosec + async def test_credentials_login_end(self): + """Test credentials login end handler.""" + self.mock_request.post.return_value = {} + self.mock_client_response.text.return_value = "test-reason" + # Test with missing username/password + with self.assertRaises(aiohttp.web.HTTPBadRequest): + await swift_browser_ui.ui.login.credentials_login_end( + self.mock_request, + ) - req.query["token"] = token + self.mock_request.post.return_value = { + "username": "test-username", + "password": "test-password", + } + # Test with different response failure status codes + self.mock_client_response.status = 400 + with self.assertRaises(aiohttp.web.HTTPBadRequest): + await swift_browser_ui.ui.login.credentials_login_end( + self.mock_request, + ) + self.mock_client_response.status = 401 + with self.assertRaises(aiohttp.web.HTTPUnauthorized): + await swift_browser_ui.ui.login.credentials_login_end( + self.mock_request, + ) + self.mock_client_response.status = 500 + with self.assertRaises(aiohttp.web.HTTPUnauthorized): + await swift_browser_ui.ui.login.credentials_login_end( + self.mock_request, + ) - resp = await swift_browser_ui.ui.login.sso_query_end(req) + # Test with "correct" credentials + self.mock_client_response.status = 201 + self.mock_client_response.headers["X-Subject-Token"] = "test-token" + mock_login = unittest.mock.AsyncMock() + patch_login = unittest.mock.patch( + "swift_browser_ui.ui.login.login_with_token", mock_login + ) + with patch_login: + await swift_browser_ui.ui.login.credentials_login_end( + self.mock_request, + ) + mock_login.assert_awaited_once_with( + self.mock_request, + "test-token", + ) - # Test for the correct values - assert req.app["Sessions"] # nosec - session = list(req.app["Sessions"].keys())[0] - self.assertTrue(req.app["Sessions"][session]["Token"] is not None) - self.assertNotEqual(req.app["Sessions"][session]["Avail"], "INVALID") - self.assertEqual( - req.app["Sessions"][session]["active_project"], - { - "name": "placeholder", - "id": "placeholder", - }, + async def test_sso_query_end(self): + """Test SSO query end handler.""" + self.mock_request.post.return_value = { + "token": "test-token", + } + mock_login = unittest.mock.AsyncMock() + patch_login = unittest.mock.patch( + "swift_browser_ui.ui.login.login_with_token", + mock_login, + ) + patch_test_token = unittest.mock.patch( + "swift_browser_ui.ui.login.test_token", + unittest.mock.Mock(return_value="test-token"), + ) + with patch_login, patch_test_token: + await swift_browser_ui.ui.login.sso_query_end( + self.mock_request, ) - self.assertEqual(resp.status, 303) - self.assertEqual(resp.headers["Location"], "/browse") - self.assertIn("S3BROW_SESSION", resp.cookies) + mock_login.assert_awaited_once_with( + self.mock_request, + "test-token", + ) - async def test_sso_query_end_successful_header(self): + async def test_login_with_token(self): """ Test sso query end function with correct execution parameters. - This version tests the token delivery in a HTTP header. + This version tests the token delivery in a http encoded form. """ + self.setd_mock["session_lifetime"] = 28800 + self.setd_mock["history_lifetime"] = 2592000 + self.setd_mock["swift_endpoint_url"] = ("http://obj.exampleosep.com:443/v1",) patch1 = unittest.mock.patch( "swift_browser_ui.ui.login.setd", - new={ - "auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3", - "swift_endpoint_url": "http://obj.exampleosep.com:443/v1", - "session_lifetime": 28800, - "history_lifetime": 2592000, - }, + self.setd_mock, ) # Patch away the convenience function for checking project availability - patch2 = unittest.mock.patch( - "swift_browser_ui.ui.login.get_availability_from_token", - new=return_project_avail, - ) - - patch3 = unittest.mock.patch("keystoneauth1.identity.v3.Token") - - patch4 = unittest.mock.patch("keystoneauth1.session.Session") - - patch5 = unittest.mock.patch("swiftclient.service.SwiftService") - - patch6 = unittest.mock.patch( - "swift_browser_ui.ui.login.test_swift_endpoint", - new=return_test_swift_endpoint, - ) - - with patch1, patch2, patch3, patch4, patch5, patch6: - req = get_request_with_fernet() - token = hashlib.md5(os.urandom(64)).hexdigest() # nosec - - req.headers["X-Auth-Token"] = token - - resp = await swift_browser_ui.ui.login.sso_query_end(req) - - # Test for the correct values - assert req.app["Sessions"] # nosec - session = list(req.app["Sessions"].keys())[0] - self.assertTrue(req.app["Sessions"][session]["Token"] is not None) - self.assertNotEqual(req.app["Sessions"][session]["Avail"], "INVALID") - self.assertEqual( - req.app["Sessions"][session]["active_project"], - { - "name": "placeholder", - "id": "placeholder", - }, - ) - self.assertEqual(resp.status, 303) - self.assertEqual(resp.headers["Location"], "/browse") - self.assertIn("S3BROW_SESSION", resp.cookies) - - async def test_credential_query_end(self): - """Test credential query end.""" - patch1 = unittest.mock.patch( - "swift_browser_ui.ui.login.setd", - new={ - "auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3", - "swift_endpoint_url": "http://obj.exampleosep.com:443/v1", - "session_lifetime": 28800, - "history_lifetime": 2592000, - }, + mock_get_avail = unittest.mock.AsyncMock( + return_value=tests.common.mockups.mock_token_output, ) patch2 = unittest.mock.patch( - "swift_browser_ui.ui.login.os_get_token_from_credentials", - new=return_mock_token, - ) - # Patch away the convenience function for checking project availability - patch3 = unittest.mock.patch( "swift_browser_ui.ui.login.get_availability_from_token", - new=return_project_avail, + mock_get_avail, ) - patch4 = unittest.mock.patch("keystoneauth1.identity.v3.Token") - - patch5 = unittest.mock.patch("keystoneauth1.session.Session") - - patch6 = unittest.mock.patch("swiftclient.service.SwiftService") - - patch7 = unittest.mock.patch( - "swift_browser_ui.ui.login.test_swift_endpoint", - new=return_test_swift_endpoint, - ) - - with patch1, patch2, patch3, patch4, patch5, patch6, patch7: - req = get_request_with_login_form() - resp = await swift_browser_ui.ui.login.credentials_login_end(req) - - # Test for the correct values - assert req.app["Sessions"] # nosec - session = list(req.app["Sessions"].keys())[0] - self.assertTrue(req.app["Sessions"][session]["Token"] is not None) - self.assertNotEqual(req.app["Sessions"][session]["Avail"], "INVALID") - self.assertEqual( - req.app["Sessions"][session]["active_project"], - { - "name": "placeholder", - "id": "placeholder", + self.mock_client_response.headers["X-Subject-Token"] = "test-token" # nosec + self.mock_client_json = { + "token": { + "user": { + "name": "test-user", }, - ) - self.assertEqual(resp.status, 303) - self.assertEqual(resp.headers["Location"], "/browse") - self.assertIn("S3BROW_SESSION", resp.cookies) - - async def test_sso_query_end_unsuccessful_missing_token(self): - """Test unsuccessful token delivery with token missing.""" - patch1 = unittest.mock.patch( - "swift_browser_ui.ui.login.setd", - new={ - "auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3", - "swift_endpoint_url": "http://obj.exampleosep.com:443/v1", + "roles": [ + { + "name": "object_store_user", + }, + ], + "catalog": [ + { + "type": "object-store", + "id": "test-id", + "name": "swift", + "endpoints": [ + { + "region_id": "default", + "url": "https://test-swift:443/swift/v1/AUTH_test-id-0", + "region": "default", + "interface": "admin", + "id": "test-id", + }, + { + "region_id": "default", + "url": "https://test-swift:443/swift/v1/AUTH_test-id-0", + "region": "default", + "interface": "public", + "id": "test-id", + }, + { + "region_id": "default", + "url": "https://test-swift:443/swift/v1/AUTH_test-id-0", + "region": "default", + "interface": "internal", + "id": "test-id", + }, + ], + }, + ], }, + } + self.mock_client_response.json = unittest.mock.AsyncMock( + return_value=self.mock_client_json, ) - patch2 = unittest.mock.patch("keystoneauth1.identity.v3.Token") - patch3 = unittest.mock.patch("keystoneauth1.session.Session") - patch4 = unittest.mock.patch("swiftclient.service.SwiftService") - - with patch1, patch2, patch3, patch4: - req = get_request_with_fernet() + token = hashlib.md5(os.urandom(64)).hexdigest() # nosec - with self.assertRaises(aiohttp.web.HTTPClientError): - _ = await swift_browser_ui.ui.login.sso_query_end(req) + with patch1, patch2, self.p_new_sess: + resp = await swift_browser_ui.ui.login.login_with_token( + self.mock_request, + token, + ) - async def test_sso_query_end_unsuccessful_invalid_token(self): - """Test unsuccessful token delivery with an invalid.""" - patch1 = unittest.mock.patch( - "swift_browser_ui.ui.login.setd", - new={ - "auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3", - "swift_endpoint_url": "http://obj.exampleosep.com:443/v1", - "has_trust": False, + self.assertEqual(resp.status, 303) + self.assertEqual(resp.headers["Location"], "/browse") + self.mock_client.post.assert_called_with( + "https://example.os.com:5001/v3/auth/tokens", + json={ + "auth": { + "identity": { + "methods": [ + "token", + ], + "token": { + "id": token, + }, + }, + "scope": {"project": {"id": "what"}}, + } }, ) - # Patch away the convenience function for checking project availability - patch2 = unittest.mock.patch( - "swift_browser_ui.ui.login.get_availability_from_token", new=return_invalid - ) - - patch3 = unittest.mock.patch("keystoneauth1.identity.v3.Token") - patch4 = unittest.mock.patch("keystoneauth1.session.Session") - patch5 = unittest.mock.patch("swiftclient.service.SwiftService") + self.mock_request.cookies["NAV_TO"] = "/test-nav" + with patch1, patch2, self.p_new_sess: + resp = await swift_browser_ui.ui.login.login_with_token( + self.mock_request, + token, + ) - with patch1, patch2, patch3, patch4, patch5: - req = get_request_with_fernet() - # token = hashlib.md5(os.urandom(64)).hexdigest() # nosec - token = "incorrect_token" # nosec + self.assertEqual(resp.headers["Location"], "/test-nav") - req.headers["X-Auth-Token"] = token + self.mock_client_response.status = 401 + with self.assertRaises( + aiohttp.web.HTTPUnauthorized + ), patch1, patch2, self.p_new_sess: + await swift_browser_ui.ui.login.login_with_token( + self.mock_request, + token, + ) - with self.assertRaises(aiohttp.web.HTTPClientError): - await swift_browser_ui.ui.login.sso_query_end(req) + self.mock_client_response.status = 403 + with self.assertRaises( + aiohttp.web.HTTPForbidden + ), patch1, patch2, self.p_new_sess: + await swift_browser_ui.ui.login.login_with_token( + self.mock_request, + token, + ) async def test_handle_logout(self): - """Test the logout function.""" - cookie, req = get_request_with_mock_openstack() - - sess_mock = unittest.mock.MagicMock("keystoneauth.session.Session") - req.app["Sessions"][cookie]["OS_sess"] = sess_mock() - - resp = await swift_browser_ui.ui.login.handle_logout(req) - + """Test logging out.""" + with self.p_get_sess: + resp = await swift_browser_ui.ui.login.handle_logout( + self.mock_request, + ) + self.mock_client.delete.assert_called() self.assertEqual(resp.status, 303) self.assertEqual(resp.headers["Location"], "/") - self.assertNotIn(cookie, req.app["Sessions"]) - - async def test_token_rescope_not_available(self): - """Test the token rescope function.""" - session, req = get_request_with_mock_openstack() - req.app["Sessions"][session]["Avail"] = json.loads(mock_token_project_avail) - req.query["project"] = "non-existent-project" - with self.assertRaises(aiohttp.web.HTTPForbidden): - await swift_browser_ui.ui.login.token_rescope(req) - - async def test_token_rescope_correct(self): - """Test the token rescope function with correct request.""" - session, req = get_request_with_mock_openstack() - req.app["Sessions"][session]["Avail"] = json.loads(mock_token_project_avail) - req.query["project"] = "wol" - req.app["Sessions"][session]["Token"] = "not_actually_a_token" # nosec - - # Set up mockups - sess_mock = unittest.mock.MagicMock("keystoneauth.session.Session") - req.app["Sessions"][session]["OS_sess"] = sess_mock() - patch_os_auth = unittest.mock.patch( - "swift_browser_ui.ui.login.initiate_os_service", - new=unittest.mock.MagicMock( - swift_browser_ui.ui._convenience.initiate_os_service - ), - ) - patch_os_sess = unittest.mock.patch( - "swift_browser_ui.ui.login.initiate_os_session", - new=unittest.mock.MagicMock( - swift_browser_ui.ui._convenience.initiate_os_session - ), - ) - with patch_os_auth, patch_os_sess: - resp = await swift_browser_ui.ui.login.token_rescope(req) - self.assertEqual(resp.status, 303) - self.assertEqual(resp.headers["Location"], "/browse") + + # Test with "undecryptable" session + self.aiohttp_session_get_session_mock.side_effect = aiohttp.web.HTTPUnauthorized + with self.assertRaises(aiohttp.web.HTTPUnauthorized), self.p_get_sess: + await swift_browser_ui.ui.login.handle_logout( + self.mock_request, + ) diff --git a/tests/ui_unit/test_middlewares.py b/tests/ui_unit/test_middlewares.py index aa84ef665..5a8446e3a 100644 --- a/tests/ui_unit/test_middlewares.py +++ b/tests/ui_unit/test_middlewares.py @@ -7,9 +7,11 @@ from aiohttp.web import HTTPUnauthorized, HTTPForbidden, HTTPNotFound from aiohttp.web import Response, HTTPClientError, FileResponse -from swift_browser_ui.ui.middlewares import error_middleware +import swift_browser_ui.ui.middlewares from swift_browser_ui.ui.front import index +import tests.common.mockups + async def return_401_handler(with_exception): """Return an HTTP401 error.""" @@ -39,9 +41,52 @@ async def return_400_handler(with_exception): return Response(status=400) -class MiddlewareTestClass(unittest.IsolatedAsyncioTestCase): +async def return_200_handler(_): + """Return a successful response.""" + return Response(status=200, body=b"OK") + + +class MiddlewareTestClass(tests.common.mockups.APITestBase): """Testing the error middleware.""" + def setUp(self): + """.""" + super().setUp() + self.p_get_sess = unittest.mock.patch( + "swift_browser_ui.ui.middlewares.aiohttp_session.get_session", + self.aiohttp_session_get_session_mock, + ) + + async def test_check_session_at(self): + """Test session expiration middleware.""" + with self.p_get_sess: + ret = await swift_browser_ui.ui.middlewares.check_session_at( + self.mock_request, + return_200_handler, + ) + self.assertEqual(ret.status, 200) + + async def test_check_session_fail_expired(self): + """Test session expiration middleware with expired session.""" + self.mock_request.path = "/api/test-projct/test-container" + self.session_return["at"] = 0 + + with self.p_get_sess, self.assertRaises(HTTPUnauthorized): + await swift_browser_ui.ui.middlewares.check_session_at( + self.mock_request, + return_200_handler, + ) + + async def test_check_session_fail_no_raise(self): + """Test session expiration middleware with route that shouldn't fail.""" + self.mock_request.path = "/login" + with self.p_get_sess: + ret = await swift_browser_ui.ui.middlewares.check_session_at( + self.mock_request, + return_200_handler, + ) + self.assertEqual(ret.status, 200) + async def test_401_return(self): """Test 401 middleware when the 401 status is returned.""" patch_setd = unittest.mock.patch( @@ -49,7 +94,9 @@ async def test_401_return(self): new={"static_directory": os.getcwd() + "/swift_browser_ui_frontend/dist"}, ) with patch_setd: - resp = await error_middleware(None, return_401_handler) + resp = await swift_browser_ui.ui.middlewares.error_middleware( + None, return_401_handler + ) self.assertEqual(resp.status, 401) self.assertIsInstance(resp, Response) @@ -60,7 +107,9 @@ async def test_401_exception(self): new={"static_directory": os.getcwd() + "/swift_browser_ui_frontend/dist"}, ) with patch_setd: - resp = await error_middleware(True, return_401_handler) + resp = await swift_browser_ui.ui.middlewares.error_middleware( + True, return_401_handler + ) self.assertEqual(resp.status, 401) self.assertIsInstance(resp, Response) @@ -71,7 +120,9 @@ async def test_403_return(self): new={"static_directory": os.getcwd() + "/swift_browser_ui_frontend/dist"}, ) with patch_setd: - resp = await error_middleware(None, return_403_handler) + resp = await swift_browser_ui.ui.middlewares.error_middleware( + None, return_403_handler + ) self.assertEqual(resp.status, 403) self.assertIsInstance(resp, Response) @@ -82,7 +133,9 @@ async def test_403_exception(self): new={"static_directory": os.getcwd() + "/swift_browser_ui_frontend/dist"}, ) with patch_setd: - resp = await error_middleware(True, return_403_handler) + resp = await swift_browser_ui.ui.middlewares.error_middleware( + True, return_403_handler + ) self.assertEqual(resp.status, 403) self.assertIsInstance(resp, Response) @@ -93,7 +146,9 @@ async def test_404_return(self): new={"static_directory": os.getcwd() + "/swift_browser_ui_frontend/dist"}, ) with patch_setd: - resp = await error_middleware(None, return_404_handler) + resp = await swift_browser_ui.ui.middlewares.error_middleware( + None, return_404_handler + ) self.assertEqual(resp.status, 404) self.assertIsInstance(resp, Response) @@ -104,7 +159,9 @@ async def test_404_exception(self): new={"static_directory": os.getcwd() + "/swift_browser_ui_frontend/dist"}, ) with patch_setd: - resp = await error_middleware(True, return_404_handler) + resp = await swift_browser_ui.ui.middlewares.error_middleware( + True, return_404_handler + ) self.assertEqual(resp.status, 404) self.assertIsInstance(resp, Response) @@ -115,7 +172,7 @@ async def test_error_middleware_no_error(self): new={"static_directory": os.getcwd() + "/swift_browser_ui_frontend/dist"}, ) with patch_setd: - resp = await error_middleware(None, index) + resp = await swift_browser_ui.ui.middlewares.error_middleware(None, index) self.assertEqual(resp.status, 200) self.assertIsInstance(resp, FileResponse) @@ -126,4 +183,6 @@ async def test_error_middleware_non_handled_raise(self): new={"static_directory": os.getcwd() + "/swift_browser_ui_frontend/dist"}, ) with self.assertRaises(HTTPClientError), patch_setd: - await error_middleware(True, return_400_handler) + await swift_browser_ui.ui.middlewares.error_middleware( + True, return_400_handler + ) diff --git a/tests/ui_unit/test_server.py b/tests/ui_unit/test_server.py index 77dc0beda..3f0f59911 100644 --- a/tests/ui_unit/test_server.py +++ b/tests/ui_unit/test_server.py @@ -13,11 +13,9 @@ import aiohttp from swift_browser_ui.ui.server import servinit, run_server_insecure -from swift_browser_ui.ui.server import kill_sess_on_shutdown, run_server_secure +from swift_browser_ui.ui.server import run_server_secure from swift_browser_ui.ui.settings import setd -from tests.ui_unit.creation import get_request_with_mock_openstack - # Set static folder in settings so it can be tested setd["static_directory"] = os.getcwd() + "/swift_browser_ui_frontend" @@ -34,18 +32,6 @@ async def test_servinit(self): self.assertTrue(app is not None) -class TestServerShutdownHandler(unittest.IsolatedAsyncioTestCase): - """Test case for the server graceful shutdown handler.""" - - async def test_kill_sess_on_shutdown(self): - """Test kill_sess_on_shutdown function.""" - session, req = get_request_with_mock_openstack() - - await kill_sess_on_shutdown(req.app) - - self.assertNotIn(session, req.app["Sessions"]) - - class TestRunServerFunctions(unittest.TestCase): """Test class for server run functions.""" @@ -131,22 +117,30 @@ async def test_working_routes(self): self.assertNotEqual(response.status, 404) response = await self.client.request("GET", "/login/front") self.assertNotEqual(response.status, 404) - response = await self.client.request("GET", "/login/rescope") + response = await self.client.request("GET", "/loginpassword") + self.assertNotEqual(response.status, 404) + response = await self.client.request("GET", "/api/username") + self.assertNotEqual(response.status, 404) + response = await self.client.request("GET", "/api/projects") self.assertNotEqual(response.status, 404) - response = await self.client.request("GET", "/api/buckets") + response = await self.client.request("GET", "/api/test-project") self.assertNotEqual(response.status, 404) - response = await self.client.request("GET", "/api/bucket/objects") + response = await self.client.request("GET", "/api/test-project/acl") self.assertNotEqual(response.status, 404) - response = await self.client.request("GET", "/api/object/dload") + response = await self.client.request("GET", "/api/test-project/address") self.assertNotEqual(response.status, 404) - response = await self.client.request("GET", "/api/username") + response = await self.client.request("GET", "/api/test-project/test-bucket") self.assertNotEqual(response.status, 404) - response = await self.client.request("GET", "/api/projects") + response = await self.client.request( + "GET", "/api/test-project/test-bucket/test-object" + ) self.assertNotEqual(response.status, 404) - response = await self.client.request("GET", "/api/bucket/meta") + response = await self.client.request( + "GET", "/api/meta/test-project/test-bucket" + ) self.assertNotEqual(response.status, 404) response = await self.client.request( "GET", - "/api/project/meta", + "/api/meta/test-project", ) self.assertNotEqual(response.status, 404) diff --git a/tests/ui_unit/test_signature.py b/tests/ui_unit/test_signature.py index e83635d34..4924556bb 100644 --- a/tests/ui_unit/test_signature.py +++ b/tests/ui_unit/test_signature.py @@ -10,19 +10,18 @@ from swift_browser_ui.ui.signature import handle_ext_token_create from swift_browser_ui.ui.signature import handle_ext_token_remove from swift_browser_ui.ui.signature import handle_ext_token_list -from swift_browser_ui.ui.signature import handle_form_post_signature +import tests.common.mockups -class SignatureMiscTestClass(unittest.IsolatedAsyncioTestCase): + +class SignatureMiscTestClass( + tests.common.mockups.APITestBase, +): """Class for testing the signature module misc handlers.""" def setUp(self): """Set up relevant mocks.""" - self.session_check_mock = unittest.mock.Mock() - self.session_check_patch = unittest.mock.patch( - "swift_browser_ui.ui._convenience.session_check", self.session_check_mock - ) - + super().setUp() self.sign_mock = unittest.mock.AsyncMock( return_value={ "valid": 15000000, @@ -33,38 +32,11 @@ def setUp(self): "swift_browser_ui.ui._convenience.sign", self.sign_mock ) - self.api_check_mock = unittest.mock.Mock(return_value="test-session") - self.api_check_patch = unittest.mock.patch( - "swift_browser_ui.ui._convenience.api_check", self.api_check_mock - ) - - self.mock_request = types.SimpleNamespace( - **{ - "query": { - "path": "/test/path", - "count": "60", - }, - "match_info": { - "valid": "600", - "container": "test-container", - }, - "app": { - "Sessions": { - "test-session": { - "ST_conn": None, - "OS_sess": types.SimpleNamespace( - **{ - "get_endpoint": unittest.mock.Mock( - return_value="https://test-endpoint/swift/v1/AUTH_test" # noqa - ) - } - ), - }, - } - }, - "remote": "test-remote", - } - ) + self.mock_request.match_info = {"valid": 600, "count": 60, "project": "test-id-0"} + self.mock_request.query = { + "path": "/test/path", + "count": "60", + } self.get_tempurl_key_mock = unittest.mock.AsyncMock(return_value="test-key") self.get_tempurl_key_patch = unittest.mock.patch( @@ -78,90 +50,38 @@ def setUp(self): } ) + self.p_get_sess = unittest.mock.patch( + "swift_browser_ui.ui.signature.aiohttp_session.get_session", + self.aiohttp_session_get_session_mock, + ) + + self.mock_client_text = "Test token listing." + async def test_handle_signature_request_correct(self): """Test signature request handler.""" - with self.session_check_patch, self.sign_patch: + with self.p_get_sess, self.sign_patch: resp = await handle_signature_request(self.mock_request) - - self.assertIsInstance(resp, aiohttp.web.Response) + self.assertIsInstance(resp, aiohttp.web.Response) async def test_handle_signature_request_fail_no_values(self): """Test signature request handler when failing on client error.""" - with self.session_check_patch, self.sign_patch: - with self.assertRaises(aiohttp.web_exceptions.HTTPClientError): + with self.assertRaises(aiohttp.web_exceptions.HTTPClientError): + with self.p_get_sess, self.sign_patch: await handle_signature_request(self.mock_request_noval) - async def test_handle_form_post_signature_correct(self): - """Test form post signature handler.""" - with self.get_tempurl_key_patch, self.api_check_patch: - resp = await handle_form_post_signature(self.mock_request) - self.assertIsInstance(resp, aiohttp.web.Response) - -class SignatureTokenTestClass(unittest.IsolatedAsyncioTestCase): +class SignatureTokenTestClass( + tests.common.mockups.APITestBase, +): """Class for testing the token creation proxy handlers.""" def setUp(self): """Set up relevant mocks.""" - self.mock_request = types.SimpleNamespace( - **{ - "match_info": {"id": "test-token"}, - "app": { - "Sessions": { - "test-session": { - "active_project": { - "id": "test-project", - }, - }, - }, - "api_client": types.SimpleNamespace( - **{ - "post": unittest.mock.AsyncMock( - return_value=types.SimpleNamespace(**{"status": 200}) - ), - "delete": unittest.mock.AsyncMock(), - "get": unittest.mock.AsyncMock( - return_value=types.SimpleNamespace( - **{ - "text": unittest.mock.AsyncMock( - return_value="test-token" - ) - } - ) - ), - } - ), - }, - } - ) - - self.mock_request_fail_post = types.SimpleNamespace( - **{ - "match_info": {"id": "test-token"}, - "app": { - "Sessions": { - "test-session": { - "active_project": {"id": "test-project"}, - }, - }, - "api_client": types.SimpleNamespace( - **{ - "post": unittest.mock.AsyncMock( - return_value=types.SimpleNamespace( - **{ - "status": 500, - "text": unittest.mock.AsyncMock( - return_value="Error" - ), - "url": "http://example-endpoint", - } - ) - ), - } - ), - }, - } - ) + super().setUp() + self.mock_request.match_info = { + "id": "test-token-id", + "project": "test-id-0", + } self.setd_mock = { "sharing_internal_endpoint": "http://sharing-test-endpoint", @@ -189,52 +109,54 @@ def setUp(self): "swift_browser_ui.ui._convenience.sign", self.sign_mock ) - self.api_check_mock = unittest.mock.Mock(return_value="test-session") - self.api_check_patch = unittest.mock.patch( - "swift_browser_ui.ui._convenience.api_check", self.api_check_mock + self.p_get_sess = unittest.mock.patch( + "swift_browser_ui.ui.signature.aiohttp_session.get_session", + self.aiohttp_session_get_session_mock, ) async def test_handle_ext_token_create_correct(self): """Test external API token creation handler.""" - with self.sign_patch, self.setd_patch, self.api_check_patch: + with self.sign_patch, self.setd_patch, self.p_get_sess: resp = await handle_ext_token_create(self.mock_request) self.assertIsInstance(resp, aiohttp.web.Response) self.assertEqual(resp.status, 201) async def test_handle_ext_token_create_fail_no_api_address(self): """Test external API token creation handler with no API address.""" - with self.sign_patch, self.setd_missing_patch, self.api_check_patch: + with self.sign_patch, self.setd_missing_patch, self.p_get_sess: with self.assertRaises(aiohttp.web.HTTPNotFound): await handle_ext_token_create(self.mock_request) async def test_handle_ext_token_create_fail_token_creation(self): """Test external API token creation handler in case of failure.""" - with self.sign_patch, self.setd_patch, self.api_check_patch: + self.mock_client_response.status = 500 + self.mock_client_response.text.return_value = "Error" + with self.sign_patch, self.setd_patch, self.p_get_sess: with self.assertRaises(aiohttp.web.HTTPInternalServerError): - await handle_ext_token_create(self.mock_request_fail_post) + await handle_ext_token_create(self.mock_request) async def test_handle_ext_token_remove_correct(self): """Test external API token removal handler.""" - with self.sign_patch, self.setd_patch, self.api_check_patch: + with self.sign_patch, self.setd_patch, self.p_get_sess: resp = await handle_ext_token_remove(self.mock_request) self.assertIsInstance(resp, aiohttp.web.Response) self.assertEqual(resp.status, 204) async def test_handle_ext_token_remove_fail_no_api_address(self): """Test external API token creation handler with no API address.""" - with self.sign_patch, self.setd_missing_patch, self.api_check_patch: + with self.sign_patch, self.setd_missing_patch, self.p_get_sess: with self.assertRaises(aiohttp.web.HTTPNotFound): await handle_ext_token_remove(self.mock_request) async def test_handle_ext_token_list_correct(self): """Test external API token listing handler.""" - with self.sign_patch, self.setd_patch, self.api_check_patch: + with self.sign_patch, self.setd_patch, self.p_get_sess: resp = await handle_ext_token_list(self.mock_request) self.assertIsInstance(resp, aiohttp.web.Response) self.assertEqual(resp.status, 200) async def test_handle_ext_token_list_fail_no_api_address(self): """Test external API token listing handler with no API address.""" - with self.sign_patch, self.setd_missing_patch, self.api_check_patch: + with self.sign_patch, self.setd_missing_patch, self.p_get_sess: with self.assertRaises(aiohttp.web.HTTPNotFound): await handle_ext_token_list(self.mock_request) diff --git a/tests/upload/common.py b/tests/upload/common.py deleted file mode 100644 index 2e57bf843..000000000 --- a/tests/upload/common.py +++ /dev/null @@ -1 +0,0 @@ -"""Common test utilities for upload testing.""" diff --git a/tests/upload/test_api.py b/tests/upload/test_api.py index cbd56f8cd..8a99ff1da 100644 --- a/tests/upload/test_api.py +++ b/tests/upload/test_api.py @@ -11,16 +11,17 @@ import tests.common.mockups -class APITestClass(unittest.IsolatedAsyncioTestCase): +class APITestClass(tests.common.mockups.APITestBase): """Test class for swift_browser_ui.upload.api functions.""" def setUp(self) -> None: """.""" - self.request = tests.common.mockups.Mock_Request() - - self.mock_get_auth = unittest.mock.Mock(return_value="auth") - self.patch_get_auth = unittest.mock.patch( - "swift_browser_ui.upload.api.get_auth_instance", self.mock_get_auth + super().setUp() + self.mock_get_session_id = unittest.mock.Mock( + return_value="test-id", + ) + self.p_get_sess = unittest.mock.patch( + "swift_browser_ui.upload.api.get_session_id", self.mock_get_session_id ) self.mock_upload_instance = types.SimpleNamespace( @@ -66,26 +67,19 @@ def setUp(self) -> None: ) self.mock_init_download = unittest.mock.Mock(return_value=self.mock_download) - return super().setUp() - async def test_handle_get_object(self): """Test swift_browser_ui.upload.api.handle_get_object.""" - req = tests.common.mockups.Mock_Request() - req.set_match( - { - "project": "test-project", - "container": "test-container", - "object_name": "test-object", - } - ) + self.mock_request.match_info["project"] = "test-project" + self.mock_request.match_info["container"] = "test-container" + self.mock_request.match_info["object_name"] = "test-object" patch_init_download = unittest.mock.patch( "swift_browser_ui.upload.api.FileDownloadProxy", self.mock_init_download, ) - with patch_init_download, self.patch_get_auth, self.patch_streamresponse: - resp = await swift_browser_ui.upload.api.handle_get_object(req) + with patch_init_download, self.p_get_sess, self.patch_streamresponse: + resp = await swift_browser_ui.upload.api.handle_get_object(self.mock_request) self.assertIs(resp, self.mock_response) self.mock_a_begin.assert_called_once_with( @@ -106,21 +100,21 @@ async def test_handle_replicate_container(self): "swift_browser_ui.upload.api.ObjectReplicationProxy", mock_init_replicator ) - req = tests.common.mockups.Mock_Request() - req.set_match({"project": "test-project", "container": "test-container"}) - req.set_query( - {"from_project": "other-project", "from_container": "source-container"} - ) - req.app["client"] = "client" + self.mock_request.query["from_project"] = "other-project" + self.mock_request.query["from_container"] = "source-container" + self.mock_request.match_info["project"] = "test-project" + self.mock_request.match_info["container"] = "test-container" - with self.patch_get_auth, patch_replicator: - resp = await swift_browser_ui.upload.api.handle_replicate_container(req) + with self.p_get_sess, patch_replicator: + resp = await swift_browser_ui.upload.api.handle_replicate_container( + self.mock_request, + ) self.assertIsInstance(resp, aiohttp.web.Response) self.assertEqual(resp.status, 202) mock_init_replicator.assert_called_once_with( - "auth", - "client", + "placeholder", + self.mock_client, "test-project", "test-container", "other-project", @@ -137,25 +131,22 @@ async def test_handle_replicate_object(self): "swift_browser_ui.upload.api.ObjectReplicationProxy", mock_init_replicator ) - req = tests.common.mockups.Mock_Request() - req.set_match({"project": "test-project", "container": "test-container"}) - req.set_query( - { - "from_project": "other-project", - "from_container": "source-container", - "from_object": "source-object", - } - ) - req.app["client"] = "client" + self.mock_request.match_info["project"] = "test-project" + self.mock_request.match_info["container"] = "test-container" + self.mock_request.query["from_project"] = "other-project" + self.mock_request.query["from_container"] = "source-container" + self.mock_request.query["from_object"] = "source-object" - with self.patch_get_auth, patch_replicator: - resp = await swift_browser_ui.upload.api.handle_replicate_object(req) + with self.p_get_sess, patch_replicator: + resp = await swift_browser_ui.upload.api.handle_replicate_object( + self.mock_request, + ) self.assertIsInstance(resp, aiohttp.web.Response) self.assertEqual(resp.status, 202) mock_init_replicator.assert_called_once_with( - "auth", - "client", + "placeholder", + self.mock_client, "test-project", "test-container", "other-project", @@ -217,12 +208,12 @@ async def test_handle_get_object_chunk(self): req = tests.common.mockups.Mock_Request() req.set_match({"project": "test-project", "container": "test-container"}) - with self.assertRaises(aiohttp.web.HTTPBadRequest), self.patch_get_auth: + with self.assertRaises(aiohttp.web.HTTPBadRequest), self.p_get_sess: await swift_browser_ui.upload.api.handle_get_object_chunk(req) req.set_query({"resumableChunkNumber": 100}) - with self.patch_get_auth, self.patch_get_upload_instance: + with self.p_get_sess, self.patch_get_upload_instance: resp = await swift_browser_ui.upload.api.handle_get_object_chunk(req) self.assertEqual(resp, "check-success") @@ -238,32 +229,36 @@ async def test_handle_post_object_options(self): async def test_handle_get_container(self): """Test swift_browser_ui.upload.api.handle_get_container.""" # Handle edge case of uploaded object chunk check - req = tests.common.mockups.Mock_Request() - req.set_query({"resumableChunkNumber": 1}) + self.mock_request.match_info["project"] = "test-project" + self.mock_request.match_info["container"] = "test-container" + self.mock_request.query["resumableChunkNumber"] = 1 + mock_get_object_chunk = unittest.mock.AsyncMock(return_value="get-chunk-success") patch_get_object_chunk = unittest.mock.patch( "swift_browser_ui.upload.api.handle_get_object_chunk", mock_get_object_chunk ) with patch_get_object_chunk: - resp = await swift_browser_ui.upload.api.handle_get_container(req) + resp = await swift_browser_ui.upload.api.handle_get_container( + self.mock_request, + ) self.assertEqual(resp, "get-chunk-success") # Test normal behaviour - req = tests.common.mockups.Mock_Request() - req.set_match({"project": "test-project", "container": "test-container"}) - + self.mock_request.query.pop("resumableChunkNumber") patch_init_download = unittest.mock.patch( "swift_browser_ui.upload.api.ContainerArchiveDownloadProxy", self.mock_init_download, ) - with self.patch_get_auth, self.patch_streamresponse, patch_init_download: - resp = await swift_browser_ui.upload.api.handle_get_container(req) + with self.p_get_sess, self.patch_streamresponse, patch_init_download: + resp = await swift_browser_ui.upload.api.handle_get_container( + self.mock_request, + ) self.assertIs(resp, self.mock_response) self.mock_download.a_write_to_response.assert_called_once() self.mock_init_download.assert_called_once_with( - "auth", "test-project", "test-container" + "placeholder", "test-project", "test-container" ) self.assertEqual(resp.headers["Content-Type"], "application/x-tar") self.assertIsNotNone(resp.headers["Content-Disposition"]) diff --git a/tests/upload/test_auth.py b/tests/upload/test_auth.py index 831f2d8bc..1c1342a2d 100644 --- a/tests/upload/test_auth.py +++ b/tests/upload/test_auth.py @@ -9,41 +9,69 @@ import tests.common.mockups -class AuthTestClass(unittest.IsolatedAsyncioTestCase): +class AuthTestClass(tests.common.mockups.APITestBase): """Test class for swift_browser_ui.upload.auth functions.""" def setUp(self): """.""" - self.initiate_mock = unittest.mock.Mock(return_value="OS_Session") - self.patch_initiate = unittest.mock.patch( - "swift_browser_ui.upload.auth.initiate_os_session", - self.initiate_mock, - ) super().setUp() async def test_handle_login(self): """Test swift_browser_ui.upload.auth.handle_login.""" - req = tests.common.mockups.Mock_Request() - with self.assertRaises(aiohttp.web.HTTPUnauthorized): - await swift_browser_ui.upload.auth.handle_login(req) - - req.set_match( - { - "project": "test-project", - } + await swift_browser_ui.upload.auth.handle_login(self.mock_request) + + self.mock_request.post.return_value = { + "token": "test-token", + } + + self.mock_client_response.headers["X-Subject-Token"] = "test-token" # nosec + self.mock_client_json = { + "token": { + "user": { + "name": "test-user", + }, + "catalog": [ + { + "type": "object-store", + "id": "test-id", + "name": "swift", + "endpoints": [ + { + "region_id": "default", + "url": "https://test-swift:443/swift/v1/AUTH_test-id-0", + "region": "default", + "interface": "admin", + "id": "test-id", + }, + { + "region_id": "default", + "url": "https://test-swift:443/swift/v1/AUTH_test-id-0", + "region": "default", + "interface": "public", + "id": "test-id", + }, + { + "region_id": "default", + "url": "https://test-swift:443/swift/v1/AUTH_test-id-0", + "region": "default", + "interface": "internal", + "id": "test-id", + }, + ], + }, + ], + }, + } + self.mock_client_response.json = unittest.mock.AsyncMock( + return_value=self.mock_client_json, ) - req.set_post( - { - "token": "test-token", - } - ) - with self.patch_initiate: - resp = await swift_browser_ui.upload.auth.handle_login(req) - self.assertIsNotNone(resp.cookies["RUNNER_SESSION_ID"]) - self.assertEqual(resp.status, 200) - session_key = resp.cookies["RUNNER_SESSION_ID"].value - self.assertEqual(req.app[session_key]["auth"], "OS_Session") + + resp = await swift_browser_ui.upload.auth.handle_login(self.mock_request) + self.assertIsNotNone(resp.cookies["RUNNER_SESSION_ID"]) + self.assertEqual(resp.status, 200) + session_key = resp.cookies["RUNNER_SESSION_ID"].value + self.assertIsNotNone(self.mock_request.app[session_key]) async def test_handle_validate_authentication(self): """Test swift_browser_ui.upload.auth.handle_validate_authentication.""" diff --git a/tests/upload/test_common.py b/tests/upload/test_common.py index 705d7143f..3723bafa6 100644 --- a/tests/upload/test_common.py +++ b/tests/upload/test_common.py @@ -39,9 +39,10 @@ async def test_generate_download_url(self): async def test_get_download_host(self): """Test get_download_host function.""" - auth = tests.common.mockups.Mock_Session() - - ret = swift_browser_ui.upload.common.get_download_host(auth, "AUTH_testproject") + ret = swift_browser_ui.upload.common.get_download_host( + "https://test-endpoint:443/v1/AUTH_notwhatwewant", + "AUTH_testproject", + ) self.assertIn("AUTH_testproject", ret) @@ -82,7 +83,6 @@ async def test_get_upload_instance(self): req.app["client"] = None req.app["test-session"] = {} req.app["test-session"]["uploads"] = {} - req.app["test-session"]["auth"] = tests.common.mockups.Mock_Session() req.set_query({"session": "test-session"}) query = {
- {{ $t('message.share.share_cont') }} -
- {{ $t('message.dropFiles') }} +
+ +
+ {{ $t('message.dropFiles') }}
@@ -517,4 +638,36 @@ export default { margin: auto; } +#destinationBucket { + flex-grow: 1; +} + +.uploadButtonContainer { + margin-top: 2%; + display: flex; + flex-wrap: wrap; +} + +.uploadButtonContainer .upload + button, +.uploadButtonContainer #uploadButton + button { + margin-left: 1%; +} + +#uploadButton { + margin-left: auto; +} + +#encryptionOptions { + flex-grow: 1; + margin-top: -20px; + justify-content: right; +} + +@media screen and ( max-width: 1357px){ + #encryptionOptions { + margin-top: 0; + } + +} + \ No newline at end of file diff --git a/swift_browser_ui_frontend/vue.config.js b/swift_browser_ui_frontend/vue.config.js index 94b181673..0ba8009b5 100644 --- a/swift_browser_ui_frontend/vue.config.js +++ b/swift_browser_ui_frontend/vue.config.js @@ -2,8 +2,12 @@ module.exports = { // eslint-disable-line publicPath: "/static", devServer: { // eslint-disable-next-line - proxy: `${process.env.BACKEND_HOST || "http://localhost"}:${process.env.BACKEND_PORT || "8080"}`, - hot: true, + proxy: `http://${process.env.BACKEND_HOST || "localhost"}:${process.env.BACKEND_PORT || "8080"}`, + hot: "only", + client: { + // eslint-disable-next-line + webSocketURL: `ws://${process.env.BACKEND_HOST || "localhost"}:${process.env.BACKEND_PORT || "8080"}/ws`, + }, }, pages: { index: { diff --git a/tests/common/mockups.py b/tests/common/mockups.py index d405eef3f..f2f76f7b6 100644 --- a/tests/common/mockups.py +++ b/tests/common/mockups.py @@ -1,76 +1,209 @@ """Mock-up classes and functions for testing swift_browser_ui.""" -import random -import hashlib -import os -import datetime import json import yarl -from urllib.error import HTTPError -from contextlib import contextmanager - - -from swiftclient.service import SwiftError - - -mock_token_project_avail = json.dumps( - { - "projects": [ - # there is a special use case when this is first - # as the list of projects might give 401 - { - "is_domain": False, - "description": "Not enabled project", - "links": {"self": "https://place-holder-url:5001/v3/projects/no"}, - "enabled": False, - "id": "no", - "parent_id": "default", - "domain_id": "default", - "name": "no", - }, - { - "is_domain": False, - "description": "", - "links": { - "self": "https://place-holder-url:5001/v3/projects/placeholder" - }, - "enabled": True, - "id": "placeholder", - "parent_id": "default", - "domain_id": "default", - "name": "placeholder", - }, - { - "is_domain": False, - "description": "Wololo yol aweii", - "links": {"self": "https://place-holder-url:5001/v3/projects/wol"}, - "enabled": True, - "id": "wol", - "parent_id": "default", - "domain_id": "default", - "name": "wol", +import unittest +import unittest.mock +import time +import types +import logging + +import aiohttp_session + + +class APITestBase(unittest.IsolatedAsyncioTestCase): + """Base class for API tests using aiohttp client and server.""" + + def setUp(self): + """Set up mocks.""" + self.session_return = aiohttp_session.Session( + "test-identity", + new=True, + data={}, + ) + self.session_return["token"] = "not-really-a-token" # nosec + self.session_return["at"] = time.time() + self.session_return["referer"] = "http://localhost:8080" + self.session_return["uname"] = "testuser" + self.session_return["projects"] = { + "test-id-0": { + "id": "test-id-0", + "name": "test-name-0", + "token": "test-token-0", + "endpoint": "https://test-endpoint-0/v1/AUTH_test-id-0", }, - { - "is_domain": False, - "description": "Hmmph, what is", - "links": {"self": "https://place-holder-url:5001/v3/projects/what"}, - "enabled": True, - "id": "what", - "parent_id": "default", - "domain_id": "default", - "name": "what", + "test-id-1": { + "id": "test-id-1", + "name": "test-name-1", + "token": "test-token-1", + "endpoint": "https://test-endpoint-1/v1/AUTH_test-id-1", }, - ], - } -) + } + self.aiohttp_session_get_session_mock = unittest.mock.AsyncMock() + self.aiohttp_session_get_session_mock.return_value = self.session_return + self.p_get_sess = unittest.mock.patch( + "swift_browser_ui.ui.api.aiohttp_session.get_session", + self.aiohttp_session_get_session_mock, + ) + self.aiohttp_session_new_session_mock = unittest.mock.AsyncMock() + self.p_new_sess = unittest.mock.patch( + "swift_browser_ui.ui.login.aiohttp_session.new_session", + self.aiohttp_session_new_session_mock, + ) + self.setd_mock = { + "auth_endpoint_url": "https://example.os.com:5001/v3", + "set_origin_address": "https://localhost/login/websso", + "has_trust": True, + "upload_external_endpoint": "http://test-endpoint:9092/", + } + self.patch_setd = unittest.mock.patch( + "swift_browser_ui.ui.api.setd", self.setd_mock + ) -mock_token_domain_avail = json.dumps({"domains": []}) + self.aiohttp_json_response_mock = unittest.mock.Mock() + self.p_json_resp = unittest.mock.patch( + "swift_browser_ui.ui.api.aiohttp.web.json_response", + self.aiohttp_json_response_mock, + ) + self.mock_response_write = unittest.mock.AsyncMock() + self.mock_response_prepare = unittest.mock.AsyncMock() + self.mock_response_write_eof = unittest.mock.AsyncMock() + self.aiohttp_construct_response_mock = unittest.mock.Mock() + self.aiohttp_construct_response_mock.return_value = types.SimpleNamespace( + **{ + "status": 200, + "headers": {}, + "cookie": {}, + "write": self.mock_response_write, + "prepare": self.mock_response_prepare, + "write_eof": self.mock_response_write_eof, + } + ) + self.p_resp = unittest.mock.patch( + "swift_browser_ui.ui.api.aiohttp.web.Response", + self.aiohttp_construct_response_mock, + ) + self.p_sresp = unittest.mock.patch( + "swift_browser_ui.ui.api.aiohttp.web.StreamResponse", + self.aiohttp_construct_response_mock, + ) -mock_token_output = { + self.mock_response_read = unittest.mock.AsyncMock(return_value=b"exampleread") + self.mock_iter = unittest.mock.Mock(return_value=b"test-chunk") + + async def citer(_): + yield self.mock_iter() + + self.mock_client_json = {} + self.mock_client_text = "" + self.mock_client_response = types.SimpleNamespace( + **{ + "status": 200, + "headers": {}, + "cookie": {}, + "json": None, + "content": types.SimpleNamespace( + **{ + "iter_chunked": citer, + } + ), + "read": self.mock_response_read, + "text": unittest.mock.AsyncMock(return_value=self.mock_client_text), + "url": "https://localhost:8080", + } + ) + + class MockHandler(APITestBase): + def __init__(self, mockresp): + """.""" + self.mock_client_response = mockresp + + async def __aenter__(self): + return self.mock_client_response + + async def __aexit__(self, *_): + return + + self.MockHandler = MockHandler + self.mock_client = types.SimpleNamespace( + **{ + "get": unittest.mock.Mock( + return_value=self.MockHandler( + self.mock_client_response, + ) + ), + "post": unittest.mock.Mock( + return_value=self.MockHandler( + self.mock_client_response, + ) + ), + "put": unittest.mock.Mock( + return_value=self.MockHandler( + self.mock_client_response, + ) + ), + "delete": unittest.mock.Mock( + return_value=self.MockHandler( + self.mock_client_response, + ) + ), + "head": unittest.mock.Mock( + return_value=self.MockHandler( + self.mock_client_response, + ) + ), + } + ) + + self.mock_request = types.SimpleNamespace( + **{ + "match_info": { + "project": "test-id-0", + "container": "test-container", + "object": "test-object", + "receiver": "test-project-1", + }, + "cookies": {}, + "query": {}, + "headers": {}, + "query_string": "", + "remote": "test-remote", + "json": None, + "post": unittest.mock.AsyncMock(), + "app": { + "api_client": self.mock_client, + "client": self.mock_client, + "Log": unittest.mock.MagicMock(logging.Logger), + "test-id": "placeholder", + }, + "url": types.SimpleNamespace( + **{ + "host": "https://localhost", + } + ), + "path": "/", + } + ) + super().setUp() + + +mock_token_project_avail: dict = { "projects": [ + # there is a special use case when this is first + # as the list of projects might give 401 + { + "is_domain": False, + "description": "Not enabled project", + "links": {"self": "https://place-holder-url:5001/v3/projects/no"}, + "enabled": False, + "id": "no", + "parent_id": "default", + "domain_id": "default", + "name": "no", + }, { "is_domain": False, "description": "", @@ -102,62 +235,47 @@ "name": "what", }, ], - "domains": [], } -def return_mock_token(_, _a): - """Return a mock token.""" - return "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - - -def return_same_cookie(_): - """Return same cookie.""" - return ("placeholder", "placeholder") - - -def return_invalid(_): - """Return invalid.""" - return "INVALID" - - -def return_project_avail(_): - """Return mocked unscoped token availability output.""" - return mock_token_output - - -def return_test_swift_endpoint(_): - """Return mocked test available swift.""" - return None - - -@contextmanager -def urlopen(prq, timeout=10): - """Mockup class for opening keystone.""" - yield MockKeystone(prq) - - -class MockKeystone: - """Mockup class for OS Keystone to enable testing availability.""" +mock_token_domain_avail: dict = {"domains": []} - def __init__(self, prq): - """Initialize Mock keystone.""" - self.prq = prq - def read(self): - """Read request.""" - if "X-auth-token" not in self.prq.headers: - raise HTTPError( - url=None, code=401, msg="Unauthorized", hdrs=self.prq.headers, fp=None - ) - if "projects" in self.prq.full_url: - return mock_token_project_avail.encode("utf-8") - if "domains" in self.prq.full_url: - return mock_token_domain_avail.encode("utf-8") - else: - raise HTTPError( - url=None, code=401, msg="Unauthorized", hdrs=self.prq.headers, fp=None - ) +mock_token_output = { + "projects": [ + { + "is_domain": False, + "description": "", + "links": {"self": "https://place-holder-url:5001/v3/projects/placeholder"}, + "enabled": True, + "id": "placeholder", + "parent_id": "default", + "domain_id": "default", + "name": "placeholder", + }, + { + "is_domain": False, + "description": "Wololo yol aweii", + "links": {"self": "https://place-holder-url:5001/v3/projects/wol"}, + "enabled": True, + "id": "wol", + "parent_id": "default", + "domain_id": "default", + "name": "wol", + }, + { + "is_domain": False, + "description": "Hmmph, what is", + "links": {"self": "https://place-holder-url:5001/v3/projects/what"}, + "enabled": True, + "id": "what", + "parent_id": "default", + "domain_id": "default", + "name": "what", + }, + ], + "domains": [], +} class Mock_Request: @@ -166,7 +284,7 @@ class Mock_Request: It contains the dictionary representation of the requests that will be passed to the functions. - (the actual request eing a MutableMapping instance) + (the actual request being a MutableMapping instance) """ def __init__(self): @@ -227,231 +345,3 @@ async def json(self): if isinstance(self.post_data, str): return json.loads(self.post_data) return self.post_data - - -class Mock_Service: - """ - Mock-up class for the Openstack service. - - In this case a swiftclient.Service - instance. Contains the mock-ups for the relevant methods used in this - project. Also contains functions for generating test data, in case it is - necessary. - """ - - def __init__(self): - """.""" - self.containers = {} - self.meta = { - "tempurl_key_1": None, - "tempurl_key_2": None, - } - self.cont_meta = {} - self.obj_meta = {} - - def init_with_data( - self, - containers=0, - object_range=(0, 0), - size_range=(0, 0), - container_name_prefix="test-container-", - object_name_prefix=None, # None for just the hash as name - has_content_type=None, - ): - """Initialize the Mock_Service instance with some test data.""" - for i in range(0, containers): - to_add = [] - - # Iterate over a random amount of objects - for _ in range(0, random.randint(object_range[0], object_range[1])): # nosec - ohash = hashlib.sha1(os.urandom(256)).hexdigest() # nosec - if object_name_prefix is not None: - oname = object_name_prefix + ohash - else: - oname = ohash - to_append = { - "hash": ohash, - "name": oname, - "last_modified": datetime.datetime.now().isoformat(), - "bytes": random.randint(size_range[0], size_range[1]), # nosec - } - if has_content_type: - to_append["content_type"] = has_content_type - to_add.append(to_append) - - self.containers[container_name_prefix + str(i)] = to_add - - def list(self, container=None, options=None): - """Mock function for the service object / container listings.""" - if container is None: - ret = [] - for i in self.containers: - ret.append( - { - "name": i, - "count": len(self.containers[i]), - "bytes": sum([j["bytes"] for j in self.containers[i]]), - } - ) - return [{"success": True, "container": "mock-container", "listing": ret}] - if container is not None: - ret = [] - try: - for i in self.containers[container]: - to_append = { - "hash": i["hash"], - "name": i["name"], - "last_modified": i["last_modified"], - "bytes": i["bytes"], - } - if "content_type" in i.keys(): - to_append["content_type"] = i["content_type"] - ret.append(to_append) - return [{"success": True, "container": container, "listing": ret}] - except KeyError: - raise SwiftError(None, container=container) - else: - return None - - def stat(self, *args): - """Mock the stat call of SwiftService.""" - ret = {} - ret["headers"] = {} - if not args: - object_amount = 0 - bytes_total = 0 - container_amount = len(self.containers) - # Iterate over all containers to figure out the amount of of - # objects - for i in self.containers: - object_amount = object_amount + len(self.containers[i]) - # Iterate over all objects to get the total storage usage - for j in self.containers[i]: - bytes_total = bytes_total + j["bytes"] - ret["items"] = [ - ( - "Account", - "AUTH_test_account", - ), - ("Containers", container_amount), - ("Objects", object_amount), - ("Bytes", bytes_total), - ("Random_garbage", "afjf0f3+3++"), - ("More_random_garbage", 349000909990), - ] - # Add the tempurl headers to the return dictionary, if they have - # been initialized - if self.meta["tempurl_key_1"] is not None: - ret["headers"]["x-account-meta-temp-url-key"] = self.meta["tempurl_key_1"] - if self.meta["tempurl_key_2"] is not None: - ret["headers"]["x-account-meta-temp-url-key-2"] = self.meta[ - "tempurl_key_2" - ] - return ret - - if len(args) == 1: - # If the length is exactly one, then only a container was - # specified. - return self.ret_cont_stat(args) - - # In any other case the query is for an object. - # Iterate over the object query list. - return self.ret_obj_stat(args) - - def ret_obj_stat(self, args): - """Return object stats from stat query.""" - ret = [] - for obj in args[1]: - to_add = { - "headers": self.obj_meta[args[0]][obj], - "success": True, - "object": obj, - } - to_add["headers"]["content-type"] = "binary/octet-stream" - ret.append(to_add) - return ret - - def ret_cont_stat(self, args): - """Return container stats from stat query.""" - ret = {} - ret["headers"] = {} - if "Acc_example" in self.cont_meta[args[0]].keys(): - ret["container"] = args[0] - ret["headers"].update(self.cont_meta[args[0]]) - ret["success"] = True - return ret - - def post(self, container=None, objects=None, options=None): - """Mock the post call of SwiftService.""" - - def update_meta(target, headers, meta): - for (meta, value) in meta: - if not value: - del headers[f"x-{target}-meta-{meta}"] - continue - headers[f"x-{target}-meta-{meta}"] = value - - if container and objects: - for obj in objects: - update_meta( - "object", - self.obj_meta[container][obj.object_name], - obj.options.get("meta", []), - ) - return [{"success": True} for _ in objects] - elif container: - update_meta("container", self.cont_meta[container], options.get("meta", [])) - else: - # Get the URL key 2 - key = options["meta"][0].split(":")[1] - self.meta["tempurl_key_2"] = key - return {"success": True} - - def set_swift_meta_container(self, container): - """Generate test swift metadata for a container.""" - self.cont_meta[container] = {} - self.obj_meta[container] = {} - self.cont_meta[container]["x-container-meta-obj-example"] = "example" - self.cont_meta[container]["x-container-meta-usertags"] = ";".join( - ["SD-Connect", "with", "container", "tags"] - ) - self.cont_meta[container]["Acc_example"] = "example" - - def set_swift_meta_object(self, container, obj): - """Generate test swift metadata for an object.""" - self.obj_meta[container][obj] = { - "x-object-meta-usertags": "objects;with;tags", - "x-object-meta-obj-example": "example", - } - - def set_s3_meta_object(self, container, obj): - """Generate test s3 metadata for an object.""" - self.obj_meta[container][obj] = {} - self.obj_meta[container][obj][ - "x-object-meta-s3cmd-attrs" - ] = "atime:1536648772/ctime:1536648921/gid:101/gname:example" - - -class Mock_Session: - """ - Mock-up class for the Openstack keystoneauth1 session instance. - - It contains the relevant methods for querying the OS identity API (aka. - keystone). - """ - - def __init__(self): - """Initialize Mock session.""" - self.auth = None - - def invalidate(self, _): - """Mock session invalidation.""" - return True - - def get_user_id(self): - """Fetch the user id from the mock OS Session.""" - return "test_user_id" - - def get_endpoint(self, service_type=None): - """Fetch a service endpoint from the mock OS Session.""" - return "http://localhost:8443/swift/v1/AUTH_example" diff --git a/tests/cypress/integration/browser.spec.js b/tests/cypress/integration/browser.spec.js index 887c88560..d442b0a35 100644 --- a/tests/cypress/integration/browser.spec.js +++ b/tests/cypress/integration/browser.spec.js @@ -1,6 +1,7 @@ -describe("Browse buckets and test operations", function () { +describe("Browse containers and test operations", function () { beforeEach(function () { + cy.deleteDB() cy.login(' Log In with SSO ') }); @@ -8,11 +9,11 @@ describe("Browse buckets and test operations", function () { cy.contains('Log Out').click() }); - it("should be able to filter table, adjust display buckets per page and pagination", () => { - cy.get('[data-testid="bucketsPerPage"]').select('5 per page') + it("should be able to filter table, adjust display containers per page and pagination", () => { + cy.get('[data-testid="containersPerPage"]').select('5 per page') cy.contains('1-5 / 10') cy.get('[data-testid="paginationSwitch"]').click() - cy.get('[data-testid="bucketsPerPage"]').should('be.disabled') + cy.get('[data-testid="containersPerPage"]').should('be.disabled') cy.get('.input').type('test-container-5') }) @@ -24,7 +25,7 @@ describe("Browse buckets and test operations", function () { .within(() => { cy.get('td').eq(0).then(($elem) => { cy.get($elem).dblclick() - cy.url().should('eq', Cypress.config().baseUrl + '/browse/test_user_id/placeholder/' + $elem.get(0).innerText.split('\n')[0].trim()) + cy.url().should('eq', Cypress.config().baseUrl + '/browse/testuser/test-id-0/' + $elem.get(0).innerText.split('\n')[0].trim()) cy.wait(2000) }) @@ -38,7 +39,7 @@ describe("Browse buckets and test operations", function () { .within(() => { cy.get('td').eq(0).click() cy.get('td').eq(1).then(($elem) => { - expect($elem.get(0).innerText.split('\n')[0].trim()).to.have.lengthOf(40) + expect($elem.get(0).innerText.split('\n')[0].trim()).to.have.lengthOf(52) }) }) }) @@ -53,7 +54,7 @@ describe("Browse buckets and test operations", function () { cy.get('li').contains(hashFirstElem).should('have.length', 1) // not sure we have a prettier way to do this // as cypress seems to have some issues with new window being opened - cy.get(':nth-child(1) > :nth-child(5) > .field > .control > .button').invoke('attr', 'href').should('contain', '&objkey=' + hashFirstElem) + cy.get(':nth-child(1) > :nth-child(5) > .field > .control > .button').invoke('attr', 'href').should('contain', '/test-object-' + hashFirstElem) }) }) @@ -78,11 +79,13 @@ describe("Browse buckets and test operations", function () { // add few tags cy.get('tbody tr').contains('Edit').click() + cy.wait(250) cy.get('.taginput input').type('adding.couple more') cy.get('button').contains('Save').click() + cy.wait(250) cy.get('tbody tr .tags').first().children('.tag').should('have.length', 6) - // remove all tags from a bucket + // remove all tags from a container cy.get('tbody tr').contains('Edit').click() cy.get('.taginput-container').children('span').should('have.length', 6) cy.get('.delete').each(el => { @@ -90,12 +93,13 @@ describe("Browse buckets and test operations", function () { }); cy.get('.taginput-container').children('span').should('have.length', 0) cy.get('button').contains('Save').click() - cy.get('tbody .tags .tag').should('have.length', 36) + cy.get('tbody .tags .tag').should('have.length', 0) }) it("should display, add, remove object tags", () => { cy.get('tbody tr').first().dblclick() + cy.wait(1000) // object list loads with tags cy.get('tbody tr .tags').first().children('.tag').should('have.length', 3) @@ -104,12 +108,15 @@ describe("Browse buckets and test operations", function () { cy.get('h1').should('contain', 'Editing object') cy.get('.delete').first().click() cy.get('button').contains('Save').click() + cy.wait(1000) cy.get('tbody tr .tags').first().children('.tag').should('have.length', 2) // add few tags cy.get('tbody tr').contains('Edit').click() + cy.wait(1000) cy.get('.taginput input').type('adding.couple more') cy.get('button').contains('Save').click() + cy.wait(1000) cy.get('tbody tr .tags').first().children('.tag').should('have.length', 5) // remove all tags from an object @@ -120,6 +127,7 @@ describe("Browse buckets and test operations", function () { }); cy.get('.taginput-container').children('span').should('have.length', 0) cy.get('button').contains('Save').click() + cy.wait(1000) cy.get('tbody tr .tags').first().children('.tag').should('have.length', 0) }) }) diff --git a/tests/cypress/integration/userInfo.spec.js b/tests/cypress/integration/userInfo.spec.js index 6e6a8d289..b6f9f3046 100644 --- a/tests/cypress/integration/userInfo.spec.js +++ b/tests/cypress/integration/userInfo.spec.js @@ -6,7 +6,7 @@ describe("Login and log out a user", function () { expect($browse).to.have.length(1) expect($browse).to.contain('Browse') }) - cy.url().should('eq', Cypress.config().baseUrl + '/browse/test_user_id/placeholder') + cy.url().should('eq', Cypress.config().baseUrl + '/browse/testuser/test-id-0') cy.contains('Log Out').click() }) @@ -17,7 +17,7 @@ describe("Login and log out a user", function () { expect($browse).to.have.length(1) expect($browse).to.contain('Selain') }) - cy.url().should('eq', Cypress.config().baseUrl + '/browse/test_user_id/placeholder') + cy.url().should('eq', Cypress.config().baseUrl + '/browse/testuser/test-id-0') cy.contains('Kirjaudu ulos').click() }) @@ -34,13 +34,13 @@ describe("Retrieve User information", function () { }); it("should login the user and switch to user infomation and retrieve correct data", () => { - cy.url().should('eq', Cypress.config().baseUrl + '/browse/test_user_id/placeholder') + cy.url().should('eq', Cypress.config().baseUrl + '/browse/testuser/test-id-0') cy.contains('User information').click() cy.wait(1000) - cy.url().should('eq', Cypress.config().baseUrl + '/browse/test_user_id') - cy.contains('placeholder') - cy.contains('test_user_id') - cy.contains('test_account') + cy.url().should('eq', Cypress.config().baseUrl + '/browse/testuser') + cy.contains('test-name-0') + cy.contains('testuser') + cy.contains('test-id-0') cy.contains('Buckets: 10') }) @@ -48,22 +48,22 @@ describe("Retrieve User information", function () { cy.get('.navbar-dropdown').invoke('css', 'display', 'block') .should('have.css', 'display', 'block') cy.wait(1000) - cy.contains('wol').click() + cy.contains('test-name-0').click() cy.wait(1000) - cy.url().should('eq', Cypress.config().baseUrl + '/browse/test_user_id/wol') + cy.url().should('eq', Cypress.config().baseUrl + '/browse/testuser/test-id-0') cy.contains('User information').click() - cy.contains('test_account') + cy.contains('testuser') cy.contains('Buckets: 10') - cy.contains('wol') + cy.contains('test-name-0') cy.get('.navbar-dropdown').invoke('css', 'display', 'block') .should('have.css', 'display', 'block') cy.wait(2000) - cy.contains('what').click() + cy.contains('test-name-1').click() cy.wait(1000) - cy.url().should('eq', Cypress.config().baseUrl + '/browse/test_user_id') + cy.url().should('eq', Cypress.config().baseUrl + '/browse/testuser') cy.contains('.buttons > .button','Browser').click() cy.wait(2000) - cy.url().should('eq', Cypress.config().baseUrl + '/browse/test_user_id/what') + cy.url().should('eq', Cypress.config().baseUrl + '/browse/testuser/test-id-1') }) }) diff --git a/tests/cypress/support/commands.js b/tests/cypress/support/commands.js index eb8db48a6..f56c3b47c 100644 --- a/tests/cypress/support/commands.js +++ b/tests/cypress/support/commands.js @@ -33,6 +33,9 @@ Cypress.Commands.add("login", (loginMessage) => { cy.wait(1000) }) +Cypress.Commands.add("deleteDB", () => { + indexedDB.deleteDatabase("sd-connect") +}) // some exceptions like API reponse from delete we are not catching // and we don't need to, thus we ignore Cypress.on("uncaught:exception", () => { diff --git a/tests/performance/locustfile.py b/tests/performance/locustfile.py index 898f109aa..aca87e6d9 100644 --- a/tests/performance/locustfile.py +++ b/tests/performance/locustfile.py @@ -15,12 +15,12 @@ def logout(l_instance): def api_containers(l_instance): """Get container listing.""" - l_instance.client.get("/api/buckets") + l_instance.client.get("/api/containers") def api_objects(l_instance): """Get object listing.""" - l_instance.client.get("/api/bucket/objects?bucket=test-container-0") + l_instance.client.get("/api/container/objects?container=test-container-0") def api_active(l_instance): diff --git a/tests/ui_unit/creation.py b/tests/ui_unit/creation.py deleted file mode 100644 index 7fdfa839c..000000000 --- a/tests/ui_unit/creation.py +++ /dev/null @@ -1,97 +0,0 @@ -""" -Module that contains some frequently used constructors. - -The purpose is to ease in the building of the test environment. -""" - - -import logging -import hashlib -import os -import json -import time - -import cryptography.fernet -from swift_browser_ui.ui._convenience import generate_cookie - -from tests.common.mockups import Mock_Request, Mock_Service, Mock_Session - - -def add_csrf_to_cookie(cookie, req, bad_sign=False): - """Add specified csrf test variables to cookie.""" - # Getting options as a set - cookie["referer"] = "http://localhost:8080" - if bad_sign: - cookie["signature"] = "incorrect" - else: - cookie["signature"] = hashlib.sha256( - (cookie["id"] + cookie["referer"] + req.app["Salt"]).encode("utf-8") - ).hexdigest() - return cookie - - -def encrypt_cookie(cookie, req): - """Add encrypted cookie to request.""" - cookie_crypted = ( - req.app["Crypt"].encrypt(json.dumps(cookie).encode("utf-8")).decode("utf-8") - ) - req.cookies["S3BROW_SESSION"] = cookie_crypted - - -def get_request_with_fernet(): - """Create a request with a working fernet object.""" - ret = Mock_Request() - ret.app["Sessions"] = {} - ret.app["Log"] = logging.getLogger(name="test_logger") - ret.app["Crypt"] = cryptography.fernet.Fernet( - cryptography.fernet.Fernet.generate_key() - ) - ret.app["Salt"] = hashlib.sha256(os.urandom(512)).hexdigest() - return ret - - -def get_request_with_login_form(): - ret = get_request_with_fernet() - ret.set_post( - { - "username": "test", - "password": "password", - } - ) - return ret - - -def get_request_with_mock_openstack(): - """Create a request with a openstack mock-up service & session.""" - ret = get_request_with_fernet() - cookie, _ = generate_cookie(ret) - cookie["referer"] = "http://localhost:8080" - cookie["signature"] = ( - hashlib.sha256( - (cookie["id"] + cookie["referer"] + ret.app["Salt"]).encode("utf-8") - ) - ).hexdigest() - session = cookie["id"] - ret.cookies["S3BROW_SESSION"] = ( - ret.app["Crypt"].encrypt(json.dumps(cookie).encode("utf-8")).decode("utf-8") - ) - ret.app["Sessions"][session] = {} - ret.app["Sessions"][session]["OS_sess"] = Mock_Session() - ret.app["Sessions"][session]["ST_conn"] = Mock_Service() - ret.app["Sessions"][session]["Avail"] = { - "projects": ["test-project-1", "test-project-2"], - "domains": ["default"], - } - cur_time = time.time() - ret.app["Sessions"][session]["last_used"] = cur_time - ret.app["Sessions"][session]["max_lifetime"] = cur_time + 28800 - return session, ret - - -def get_full_crypted_session_cookie(cookie, app): - """.""" - cookie["referer"] = "http://localhost:8080" - cookie["signature"] = ( - hashlib.sha256((cookie["id"] + cookie["referer"] + app["Salt"]).encode("utf-8")) - ).hexdigest() - return app["Crypt"].encrypt(json.dumps(cookie).encode("utf-8")).decode("utf-8") diff --git a/tests/ui_unit/mock_server.py b/tests/ui_unit/mock_server.py index 53bde6d3b..07776790f 100644 --- a/tests/ui_unit/mock_server.py +++ b/tests/ui_unit/mock_server.py @@ -1,88 +1,210 @@ """Module for creating a server with mock-up openstack.""" -from os import environ +import os import logging +import typing import unittest.mock +import random +import hashlib +import datetime +import re +import json +import asyncio +import aiohttp.web import swift_browser_ui.ui.server -# Import some mock-ups that are already made before -from tests.common.mockups import ( - return_project_avail, - return_test_swift_endpoint, - Mock_Service, - Mock_Session, -) +import tests.common.mockups -SESSION_MODE = bool(environ.get("TEST_SESSION_MODE", False)) +SESSION_MODE = bool(os.environ.get("TEST_SESSION_MODE", False)) logging.basicConfig() logging.root.setLevel(logging.DEBUG) -def mock_initiate_os_session(token, _): - """Create a mock os session object.""" - return Mock_Session() +class MockSwiftMiddleware(tests.common.mockups.APITestBase): + """Mock Openstack implementation as aiohttp server middleware.""" + + def setUp(self): + """Set up mock Openstack Swift object storage contents.""" + super().setUp() + self.containeramount = int(os.environ.get("TEST_CONTAINER_AMOUNT", 10)) + self.object_range = (1, int(os.environ.get("TEST_MAX_OBJECT_AMOUNT", 100))) + self.size_range = (1, int(os.environ.get("TEST_MAX_OBJECT_SIZE", 1048576))) + + self.bodge_lock = None + + self.containers = {} + self.container_meta = {} + self.object_meta = {} + + def reinit_with_data(self): + """Reinitialize data if user logs in again.""" + for i in range(0, self.containeramount): + to_add = [] + + # Iterate over a random amount of objects + for _ in range( + 0, + random.randint( # nosec + self.object_range[0], + self.object_range[1], + ), + ): # nosec + ohash = hashlib.sha1(os.urandom(256)).hexdigest() # nosec + to_append = { + "hash": ohash, + "name": f"test-object-{ohash}", + "last_modified": datetime.datetime.now().isoformat(), + "bytes": random.randint( # nosec + self.size_range[0], + self.size_range[1], + ), + "meta": { + "X-Object-Meta-Usertags": "objects;with;tags", + "X-Object-Meta-Obj-Example": "example", + }, + } + to_append["content_type"] = "binary/octet-stream" + to_add.append(to_append) + + self.containers[f"test-instance-container-{i}"] = { + "name": f"test-instance-container-{i}", + "count": len(to_add), + "bytes": random.randint(0, 252000000), # nosec + "_objects": to_add, + "meta": { + "X-Container-Meta-Obj-Example": "example", + "X-Container-Meta-Usertags": ";".join( + ("SD-Connect", "with", "container", "tags") + ), + }, + } + + self.container_meta = { + "X-Container-Meta-Obj-Example": "example", + "X-Container-Meta-Usertags": ";".join( + ("SD-Connect", "with", "container", "tags") + ), + } + self.object_meta = { + "X-Object-Meta-Usertags": "objects;with;tags", + "X-Object-Meta-Obj-Example": "example", + } + + @aiohttp.web.middleware + async def wrap_mock_swift( + self, + request: aiohttp.web.Request, + handler: typing.Callable[ + [aiohttp.web.Request], + typing.Coroutine[typing.Awaitable, typing.Any, aiohttp.web.Response], + ], + ) -> aiohttp.web.Response: + """Replace mock aiohttp client return data based on route.""" + if self.bodge_lock is None: + self.bodge_lock = asyncio.Lock() + async with self.bodge_lock: + request.app["api_client"] = self.mock_client + + self.mock_client_response.status = 200 + + # Handle logins with simple redirection, we have a "session" in place already + if request.path == "/login/kill": + return aiohttp.web.Response(status=303, headers={"Location": "/"}) + if ( + request.path == "/login/return" + or request.path == "/login/websso" + or request.path == "/login/credentials" + ): + self.reinit_with_data() + return aiohttp.web.Response(status=303, headers={"Location": "/browse"}) + + # Handle frontend routes without patching sessions, we don't want redirections + # for now + mock_no_sess = unittest.mock.AsyncMock( + side_effect=aiohttp.web.HTTPUnauthorized + ) + p_no_sess = unittest.mock.patch( + "aiohttp_session.get_session", + mock_no_sess, + ) + if ( + request.path == "" + or request.path == "/" + or request.path == "/loginpassword" + or request.path == "/login" + or request.path == "/login/front" + ): + with p_no_sess: + return await handler(request) + + # Mock overrides for api related routes, ignoring user and projects since those' + # are available in the session object + if request.method == "GET" and re.match(r"^/api/test-id-\d$", request.path): + if "marker" not in request.query: + self.mock_iter.return_value = json.dumps( + list(self.containers.values()) + ).encode("utf-8") + else: + self.mock_iter.return_value = json.dumps([]).encode("utf-8") + if re.match(r"^/api/test-id-\d/.*$", request.path): + if request.method == "GET": + if "marker" not in request.query: + self.mock_iter.return_value = json.dumps( + self.containers[request.match_info["container"]]["_objects"] + ).encode("utf-8") + else: + self.mock_iter.return_value = json.dumps([]).encode("utf-8") + if request.method == "POST": + if "objects" in request.query: + objects = await request.json() + self.object_meta = { + f"X-Object-Meta-{k}": v + for k, v in filter(lambda i: i[1], objects[0][1].items()) + } + return aiohttp.web.HTTPNoContent() + container = await request.json() + self.container_meta = { + f"X-Container-Meta-{k}": v + for k, v in filter(lambda i: i[1], container.items()) + } + return aiohttp.web.HTTPNoContent() + if request.method == "GET" and re.match( + r"^/api/meta/test-id-\d/.*$", request.path + ): + if "objects" in request.query: + print(self.object_meta) + self.mock_client_response.headers = self.object_meta + else: + print(self.container_meta) + self.mock_client_response.headers = self.container_meta + if request.method == "GET" and re.match( + r"^/api/meta/test-id-\d$", request.path + ): + self.mock_client_response.status = 204 + self.mock_client_response.headers = { + "X-Account-Container-Count": 10, + "X-Account-Object-Count": 15000, + "X-Account-Bytes-Used": 147284563, + } + + with self.p_get_sess: + return await handler(request) -def mock_initiate_swift_service(_): - """Create a mock os swift service object.""" - serv = Mock_Service() - serv.init_with_data( - # Default container amount is 10, can be overriden with envvar. - containers=int(environ.get("TEST_CONTAINER_AMOUNT", 10)), - # Default object range is [0, 25[, the max can be overridden - # with envvar. - object_range=( - 0, - int(environ.get("TEST_MAX_OBJECT_AMOUNT", 25)), - ), - # Default size range is [0, 1048576[, the max can be overridden - # with envvar. - size_range=(1, int(environ.get("TEST_MAX_OBJECT_SIZE", 1048576))), - ) - # Add mock data for object metadata - for key in serv.containers.keys(): - serv.set_swift_meta_container(key) - for obj in serv.containers[key]: - serv.set_swift_meta_object(key, obj["name"]) - # The downloads aren't mocked, so no contents to any file. This isn't - # something we need to test, and also would consume too much resources. - # NOTE: Some random metadata creation could be added here. - return serv - - -async def mock_graceful_shutdown(_): - """.""" - - -@unittest.mock.patch( - "swift_browser_ui.ui.server.kill_sess_on_shutdown", mock_graceful_shutdown -) -@unittest.mock.patch( - "swift_browser_ui.ui.login.initiate_os_session", mock_initiate_os_session -) -@unittest.mock.patch( - "swift_browser_ui.ui.login.initiate_os_service", mock_initiate_swift_service -) -@unittest.mock.patch( - "swift_browser_ui.ui.login.get_availability_from_token", return_project_avail -) -@unittest.mock.patch( - "swift_browser_ui.ui.login.test_swift_endpoint", return_test_swift_endpoint -) @unittest.mock.patch.dict( swift_browser_ui.ui.server.setd, { "auth_endpoint_url": "https://localhost:5001/v3", "has_trust": False, "logfile": None, - "port": int(environ.get("TEST_SERVER_PORT", 8080)), + "port": int(os.environ.get("TEST_SERVER_PORT", 8080)), "verbose": True, "debug": True, "set_session_devmode": SESSION_MODE, @@ -96,7 +218,12 @@ def run_mock_server(): # Run the server in an ordinary fashion after patching everything logging.basicConfig() logging.root.setLevel(logging.DEBUG) - app = swift_browser_ui.ui.server.servinit() + + inject = MockSwiftMiddleware() + inject.setUp() + inject.reinit_with_data() + + app = swift_browser_ui.ui.server.servinit(inject_middleware=[inject.wrap_mock_swift]) swift_browser_ui.ui.server.run_server_insecure(app) diff --git a/tests/ui_unit/test_api.py b/tests/ui_unit/test_api.py index 27b8240d7..1b01ad520 100644 --- a/tests/ui_unit/test_api.py +++ b/tests/ui_unit/test_api.py @@ -1,493 +1,624 @@ """Module for testing ``swift_browser_ui.ui.api``.""" + import json -import hashlib -import os import unittest import types -import logging - -from aiohttp.web import HTTPNotFound - -from swiftclient.service import SwiftError -from swift_browser_ui.ui.api import ( - get_os_user, - os_list_projects, - update_metadata_bucket, - update_metadata_object, -) -from swift_browser_ui.ui.api import swift_list_buckets, swift_list_objects -from swift_browser_ui.ui.api import swift_download_object -from swift_browser_ui.ui.api import get_metadata_object -from swift_browser_ui.ui.api import get_metadata_bucket -from swift_browser_ui.ui.api import get_project_metadata -from swift_browser_ui.ui.api import get_os_active_project -from swift_browser_ui.ui.api import swift_download_shared_object -from swift_browser_ui.ui.api import swift_download_container -from swift_browser_ui.ui.api import swift_replicate_container -from swift_browser_ui.ui.settings import setd +import aiohttp.web -from tests.ui_unit.creation import get_request_with_mock_openstack +import tests.common.mockups +import swift_browser_ui.ui.api -class APITestClass(unittest.IsolatedAsyncioTestCase): - """Testing the Object Browser API.""" +class APITestClass(tests.common.mockups.APITestBase): + """Test the Object Browser API.""" def setUp(self): - """Set up necessary mocks.""" - self.cookie, self.request = get_request_with_mock_openstack() + """Set up mocks.""" + super().setUp() async def test_get_os_user(self): - """Test for the API call for fetching the Openstack username.""" - # _, request = get_request_with_mock_openstack() - response = await get_os_user(self.request) - self.assertEqual(json.loads(response.text), "test_user_id") - - # Follows the testing of the different list functions - async def test_list_containers_correct(self): - """Test function swift_list_buckets with a correct query.""" - self.request.app["Sessions"][self.cookie]["ST_conn"].init_with_data( - containers=100, - object_range=(0, 10), - size_range=(65535, 262144), - ) - response = await swift_list_buckets(self.request) - buckets = json.loads(response.text) - buckets = [i["name"] for i in buckets] - comp = [ - i - for i in self.request.app["Sessions"][self.cookie][ - "ST_conn" - ].containers.keys() - ] - # Test if return all the correct values from the mock service - self.assertEqual(buckets, comp) - - async def test_list_containers_swift_error(self): - """Test function swift_list_buckets when raising SwiftError.""" - self.request.app["Sessions"][self.cookie]["ST_conn"].list = unittest.mock.Mock( - side_effect=SwiftError("...") - ) - with self.assertRaises(HTTPNotFound): - _ = await swift_list_buckets(self.request) - - async def test_list_objects_correct(self): - """Test function swift_list_objetcs with a correct query.""" - self.request.app["Sessions"][self.cookie]["ST_conn"].init_with_data( - containers=5, - object_range=(10, 100), - size_range=(65535, 262144), - ) - for container in ["test-container-" + str(i) for i in range(0, 5)]: - self.request.query["bucket"] = container - response = await swift_list_objects(self.request) - objects = json.loads(response.text) - objects = [i["hash"] for i in objects] - comp = [ - i["hash"] - for i in self.request.app["Sessions"][self.cookie]["ST_conn"].containers[ - container - ] + """Test session Openstack username fetch.""" + with self.p_get_sess, self.p_json_resp: + await swift_browser_ui.ui.api.get_os_user(self.mock_request) + self.aiohttp_json_response_mock.assert_called_once_with("testuser") + + async def test_os_list_projects(self): + """Test Openstack available project scope fetch.""" + with self.p_get_sess, self.p_json_resp: + await swift_browser_ui.ui.api.os_list_projects( + self.mock_request, + ) + self.aiohttp_json_response_mock.assert_called_once_with( + [ + { + "id": "test-id-0", + "name": "test-name-0", + }, + { + "id": "test-id-1", + "name": "test-name-1", + }, ] - self.assertEqual(objects, comp) - - async def test_list_objects_with_unicode_nulls(self): - """Test function swift_list_objects with unicode nulls in type.""" - self.request.app["Sessions"][self.cookie]["ST_conn"].init_with_data( - containers=1, - object_range=(1, 10), - size_range=(65535, 262144), - has_content_type="text/html", - ) - self.request.query["bucket"] = "test-container-0" - response = await swift_list_objects(self.request) - objects = json.loads(response.text) - self.assertEqual( - objects[0]["content_type"], - "text/html", ) - async def test_list_without_containers(self): - """Test function list buckets on a project without containers.""" - self.request.app["Sessions"][self.cookie]["ST_conn"].init_with_data(containers=0) - response = await swift_list_buckets(self.request) - objects = json.loads(response.text) - self.assertEqual(objects, []) - - async def test_list_with_invalid_container(self): - """Test function list objects with an invalid container id.""" - # Let's create some test data anyway - self.request.app["Sessions"][self.cookie]["ST_conn"].init_with_data( - containers=3, - object_range=(1, 5), - size_range=(65535, 262144), - ) - self.request.query[ - "bucket" - ] = """Free buckets causing havoc\ - at the local market""" - response = await swift_list_objects(self.request) - objects = json.loads(response.text) - self.assertEqual(objects, []) - - async def test_list_without_objects(self): - """Test function list objects without an object query in request.""" - self.request.app["Sessions"][self.cookie]["ST_conn"].init_with_data( - containers=1, - object_range=(0, 0), - ) - self.request.query["bucket"] = "test-container-0" - with self.assertRaises(HTTPNotFound): - _ = await swift_list_objects(self.request) + async def test_swift_list_containers(self): + """Test container listing fetch from Openstack.""" + with self.p_get_sess, self.p_sresp: + await swift_browser_ui.ui.api.swift_list_containers( + self.mock_request, + ) + self.mock_response_prepare.assert_awaited_once() + self.mock_iter.assert_called() + self.mock_response_write.assert_awaited() + self.mock_response_write_eof.assert_awaited_once() + + async def test_swift_list_containers_fail_ostack(self): + """Test failed container listing fetch from Openstack.""" + # Set client response to incorrect + self.mock_client_response.status = 401 + with self.p_get_sess, self.p_sresp: + await swift_browser_ui.ui.api.swift_list_containers( + self.mock_request, + ) + self.aiohttp_construct_response_mock.assert_called_once_with(status=401) + self.mock_response_write.assert_not_called() + self.mock_response_prepare.assert_awaited_once() + self.mock_response_write_eof.assert_awaited_once() + + async def test_swift_list_containers_no_access(self): + """Test failed container listing access rights.""" + # Set request project to incorrect + self.mock_request.match_info["project"] = "test-id-not-available" + with self.p_get_sess, self.assertRaises(aiohttp.web.HTTPForbidden): + await swift_browser_ui.ui.api.swift_list_containers( + self.mock_request, + ) - async def test_os_list_projects(self): - """Test function os_list_projects for correct output.""" - # No need to generate test data, all required stuff can be found in the - # mock-app - response = await os_list_projects(self.request) - projects = json.loads(response.text) - self.assertEqual( - projects, self.request.app["Sessions"][self.cookie]["Avail"]["projects"] + async def test_swift_list_objects(self): + """Test object listing fetch from Openstack.""" + with self.p_get_sess, self.p_sresp: + await swift_browser_ui.ui.api.swift_list_objects( + self.mock_request, + ) + self.aiohttp_construct_response_mock.assert_called_once_with(status=200) + self.mock_response_prepare.assert_awaited_once() + self.mock_iter.assert_called() + self.mock_response_write.assert_awaited() + self.mock_response_write_eof.assert_awaited_once() + + async def test_swift_create_container(self): + """Test container creation with Openstack.""" + # Set json for tags + self.mock_request.json = unittest.mock.AsyncMock( + return_value={ + "tags": "a,b,c,d,e", + } ) - - async def test_swift_download_object(self): - """Test object download function.""" - self.request.app["Sessions"][self.cookie]["ST_conn"].init_with_data( - containers=1, - object_range=(1, 1), - size_range=(4096, 4096), + with self.p_get_sess, self.p_resp: + await swift_browser_ui.ui.api.swift_create_container( + self.mock_request, + ) + self.aiohttp_construct_response_mock.assert_called_once_with( + status=200, ) - # Get names for the download query - container = "test-container-0" - o_name = self.request.app["Sessions"][self.cookie]["ST_conn"].containers[ - container - ][0]["name"] - - self.request.app["Sessions"][self.cookie]["ST_conn"].set_swift_meta_container( - "test-container-0" + self.mock_client.put.assert_called_once() + self.mock_request.json.assert_awaited_once() + + async def test_swift_delete_container(self): + """Test container deletion with Openstack.""" + with self.p_get_sess: + resp = await swift_browser_ui.ui.api.swift_delete_container( + self.mock_request, + ) + self.assertEqual(resp.status, 200) + + async def test_swift_delete_containers_to_objects(self): + """Test container deletion with objects in query.""" + self.mock_request.query["objects"] = "placeholder" + mock_obj_delete = unittest.mock.AsyncMock() + patch_obj_delete = unittest.mock.patch( + "swift_browser_ui.ui.api.swift_delete_objects", + mock_obj_delete, ) - self.request.app["Sessions"][self.cookie]["ST_conn"].set_swift_meta_object( - "test-container-0", o_name + with patch_obj_delete: + await swift_browser_ui.ui.api.swift_delete_container( + self.mock_request, + ) + mock_obj_delete.assert_called_once() + mock_obj_delete.assert_awaited_once() + + async def test_swift_delete_objects(self): + """Test object batch deletion.""" + # set json for objects + self.mock_request.json = unittest.mock.AsyncMock( + return_value=[ + "test-object-0", + "test-object-1", + "test-object-2", + ], ) - - self.request.query["bucket"] = container - self.request.query["objkey"] = o_name - - # Set the swift endpoint URL - setd["swift_endpoint_url"] = "http://object.example-os.com:443/v1" - - # Case 1: Only Meta-Temp-URL-Key exists - self.request.app["Sessions"][self.cookie]["ST_conn"].tempurl_key_1 = hashlib.md5( - os.urandom(128) - ).hexdigest() # nosec - resp = await swift_download_object(self.request) - self.assertTrue(resp.headers["Location"] is not None) - - # Case 2: Only Meta-Temp-URL-Key-2 - self.request.app["Sessions"][self.cookie]["ST_conn"].tempurl_key_1 = None - self.request.app["Sessions"][self.cookie]["ST_conn"].tempurl_key_2 = hashlib.md5( - os.urandom(128) - ).hexdigest() # nosec - resp = await swift_download_object(self.request) - self.assertTrue(resp.headers["Location"] is not None) - - # Case 3: No pre-existing keys - self.request.app["Sessions"][self.cookie]["ST_conn"].meta = { - "tempurl_key_1": None, - "tempurl_key_2": None, - } - resp = await swift_download_object(self.request) - self.assertTrue( - self.request.app["Sessions"][self.cookie]["ST_conn"].meta["tempurl_key_1"] - is None + with self.p_get_sess: + resp = await swift_browser_ui.ui.api.swift_delete_objects( + self.mock_request, + ) + self.mock_client.post.assert_called_once() + self.mock_response_read.assert_awaited_once() + self.assertEqual(resp.status, 200) + self.assertEqual(resp.body, b"exampleread") + + async def test_swift_delete_objects_toomany(self): + """Test object batch deletion with too many objects.""" + self.mock_request.json = unittest.mock.AsyncMock( + return_value=[f"test-object-{i}" for i in range(0, 10001)] ) - self.assertTrue( - self.request.app["Sessions"][self.cookie]["ST_conn"].meta["tempurl_key_2"] - is not None + with self.p_get_sess, self.assertRaises(aiohttp.web.HTTPBadRequest): + await swift_browser_ui.ui.api.swift_delete_objects( + self.mock_request, + ) + + async def test_swift_download_object(self): + """Test object download with Openstack TempUrl engine.""" + get_tempurl_key_mock = unittest.mock.AsyncMock(return_value="test-key") + patch_tempkey = unittest.mock.patch( + "swift_browser_ui.ui.api.get_tempurl_key", + get_tempurl_key_mock, ) - self.assertTrue(resp.headers["Location"] is not None) - - # Below are the tests for the metadata API endpoint. The account metadata - # fetches won't be implemented and thus won't be tested, - # because the account - # metadata contains sensitive information. (e.g. the tempurl keys) - async def test_get_container_meta_swift(self): - """Test metadata API endpoint with container metadata.""" - req_sessions = self.request.app["Sessions"] - req_sessions[self.cookie]["ST_conn"].init_with_data( - containers=1, - object_range=(1, 1), - size_range=(252144, 252144), + generate_tempurl_mock = unittest.mock.Mock(return_value="?tempurl=true") + patch_tempurl = unittest.mock.patch( + "swift_browser_ui.ui.api.generate_temp_url", + generate_tempurl_mock, ) - req_sessions[self.cookie]["ST_conn"].meta = { - "tempurl_key_1": None, - "tempurl_key_2": None, + + self.mock_client_response.headers["Content-Type"] = "test-content" + + with self.p_get_sess, patch_tempkey, patch_tempurl: + resp = await swift_browser_ui.ui.api.swift_download_object( + self.mock_request, + ) + self.assertEqual(resp.status, 302) + self.assertEqual(resp.headers["Location"], "https://test-endpoint-0?tempurl=true") + self.assertEqual(resp.headers["Content-Type"], "test-content") + self.mock_client.head.assert_called_once() + get_tempurl_key_mock.assert_awaited_once() + generate_tempurl_mock.assert_called_once() + + async def test_swift_get_met_wrapper(self): + """Test single object metadata fetch with Openstack.""" + self.mock_client_response.headers = { + "X-Object-Meta-One": "examplemeta", + "X-Object-Meta-Two": "examplemeta", + "X-Object-Meta-Three": "examplemeta", + "X-Object-Meta-Four": "examplemeta", + "X-Object-Meta-s3cmd-attrs": "first:1/second:2/third:3", } - req_sessions[self.cookie]["ST_conn"].set_swift_meta_container("test-container-0") - - # Set up the query string - self.request.query["container"] = "test-container-0" - - resp = await get_metadata_bucket(self.request) - resp = json.loads(resp.text) - - expected = [ - "test-container-0", - {"obj-example": "example", "usertags": "SD-Connect;with;container;tags"}, - ] - self.assertEqual(resp, expected) - - async def test_set_container_meta_swift(self): - """Test metadata API endpoint with container metadata.""" - req_sessions = self.request.app["Sessions"] - req_sessions[self.cookie]["ST_conn"].init_with_data( - containers=1, - object_range=(1, 1), - size_range=(252144, 252144), + with self.p_get_sess: + ret = await swift_browser_ui.ui.api._swift_get_object_metadata_wrapper( + self.mock_request, + "test-object", + ) + self.assertIn("Three", ret[1]) + self.mock_client.head.assert_called_once() + self.assertIn("s3cmd-attrs", ret[1]) + self.assertIn("second", ret[1]["s3cmd-attrs"]) + + async def test_swift_get_meta_fail(self): + """Test single object metadata fetch failure with Openstack.""" + self.mock_client_response.status = 404 + with self.p_get_sess, self.assertRaises(aiohttp.web.HTTPInternalServerError): + await swift_browser_ui.ui.api._swift_get_object_metadata_wrapper( + self.mock_request, + "test-object", + ) + + async def test_swift_batch_get_object_meta(self): + """Test batch object metadata fetch with Openstack.""" + mock_get_meta = unittest.mock.AsyncMock(return_value=("object", "meta")) + patch_get_meta = unittest.mock.patch( + "swift_browser_ui.ui.api._swift_get_object_metadata_wrapper", + mock_get_meta, ) - req_sessions[self.cookie]["ST_conn"].meta = { - "tempurl_key_1": None, - "tempurl_key_2": None, + self.mock_request.query = {"objects": "obja,objb,objc,objd,obje,objf"} + with self.p_get_sess, patch_get_meta: + await swift_browser_ui.ui.api.swift_get_batch_object_metadata( + self.mock_request, + ) + mock_get_meta.assert_called() + mock_get_meta.assert_awaited() + + async def test_swift_get_container_meta(self): + """Test container metadata fetch with Openstack.""" + self.mock_client_response.headers = { + "X-Container-Meta-One": "examplemeta", + "X-Container-Meta-Two": "examplemeta", + "X-Container-Meta-Three": "examplemeta", + "X-Container-Meta-Four": "examplemeta", + "X-Container-Meta-Five": "examplemeta", } - req_sessions[self.cookie]["ST_conn"].set_swift_meta_container("test-container-0") - - self.request.query["container"] = "test-container-0" - self.request.set_post('{"usertags":"tags;for;testing"}') - - post_rest = await update_metadata_bucket(self.request) - self.assertEqual(post_rest.status, 204) - - self.request.set_post(None) - resp = await get_metadata_bucket(self.request) - resp = json.loads(resp.text) - - expected = [ - "test-container-0", - {"obj-example": "example", "usertags": "tags;for;testing"}, - ] - self.assertEqual(resp, expected) - - async def test_get_object_meta_swift(self): - """Test metadata API endpoint when object has swift metadata.""" - req_sessions = self.request.app["Sessions"] - req_sessions[self.cookie]["ST_conn"].init_with_data( - containers=1, - object_range=(1, 1), - size_range=(252144, 252144), + with self.p_get_sess: + await swift_browser_ui.ui.api.swift_get_metadata_container( + self.mock_request, + ) + self.mock_client.head.assert_called_once() + + async def test_swift_batch_get_object_meta_through_container(self): + """Test object batch meta fetch via container meta handler.""" + mock_object_meta_batch = unittest.mock.AsyncMock() + patch_object_meta = unittest.mock.patch( + "swift_browser_ui.ui.api.swift_get_batch_object_metadata", + mock_object_meta_batch, ) - req_sessions[self.cookie]["ST_conn"].meta = { - "tempurl_key_1": None, - "tempurl_key_2": None, - } - # Get the object key to test with - objs = req_sessions[self.cookie]["ST_conn"].containers["test-container-0"] - objkey = [i["name"] for i in objs][0] - - req_sessions[self.cookie]["ST_conn"].set_swift_meta_container("test-container-0") + self.mock_request.query["objects"] = "true" + with patch_object_meta: + await swift_browser_ui.ui.api.swift_get_metadata_container( + self.mock_request, + ) + mock_object_meta_batch.assert_awaited_once() + + async def test_swift_update_object_meta_wrapper(self): + """Test single object metadata update with Openstack.""" + with self.p_get_sess: + ret = await swift_browser_ui.ui.api._swift_update_object_meta_wrapper( + self.mock_request, + "test-object", + [("a", 1), ("b", 2), ("c", 3)], + ) + self.mock_client.post.assert_called_once() + self.assertEqual(ret, 200) - req_sessions[self.cookie]["ST_conn"].set_swift_meta_object( - "test-container-0", objkey + async def test_batch_swift_update_object_metadata(self): + """Test object metadata batch update with Openstack.""" + mock_object_meta_update = unittest.mock.AsyncMock( + return_value=204, ) - - # Set up the query string - self.request.query["container"] = "test-container-0" - self.request.query["object"] = objkey - - resp = await get_metadata_object(self.request) - resp = json.loads(resp.text) - expected = [[objkey, {"obj-example": "example", "usertags": "objects;with;tags"}]] - self.assertEqual(resp, expected) - - async def test_set_object_meta_swift(self): - """Test metadata API endpoint with container metadata.""" - req_sessions = self.request.app["Sessions"] - req_sessions[self.cookie]["ST_conn"].init_with_data( - containers=1, - object_range=(1, 1), - size_range=(252144, 252144), + patch_meta_update = unittest.mock.patch( + "swift_browser_ui.ui.api._swift_update_object_meta_wrapper", + mock_object_meta_update, ) - container = "test-container-0" - req_sessions[self.cookie]["ST_conn"].set_swift_meta_container(container) - for obj in req_sessions[self.cookie]["ST_conn"].obj_meta.keys(): - req_sessions[self.cookie]["ST_conn"].set_swift_meta_object(container, obj) - - obj = list(req_sessions[self.cookie]["ST_conn"].obj_meta[container])[0] - self.request.query["container"] = container - self.request.set_post( - json.dumps( - [ - [ - obj, - {"usertags": "tags;for;testing"}, - ] - ] - ) + + self.mock_request.json = unittest.mock.AsyncMock( + return_value=[ + ( + "test-object-0", + { + "test-meta-0": "test", + "test-meta-1": "another_test", + }, + ), + ( + "test-object-1", + { + "test-meta-0": "test", + "test-meta-1": "another_test", + }, + ), + ( + "test-object-2", + { + "test-meta-0": "test", + "test-meta-1": "another_test", + }, + ), + ( + "test-object-3", + { + "test-meta-0": "test", + "test-meta-1": "another_test", + }, + ), + ( + "test-object-4", + { + "test-meta-0": "test", + "test-meta-1": "another_test", + }, + ), + ] ) - post_resp = await update_metadata_object(self.request) - self.assertEqual(post_resp.status, 204) + with self.p_get_sess, patch_meta_update: + resp = await swift_browser_ui.ui.api.swift_batch_update_object_metadata( + self.mock_request, + ) + self.assertEqual(resp.status, 204) + mock_object_meta_update.assert_awaited() + + # Cover failure + mock_object_meta_update.return_value = 404 + with self.p_get_sess, patch_meta_update, self.assertRaises( + aiohttp.web.HTTPNotFound + ): + await swift_browser_ui.ui.api.swift_batch_update_object_metadata( + self.mock_request, + ) - self.request.set_post(None) - self.request.query["object"] = obj - resp = await get_metadata_object(self.request) - resp = json.loads(resp.text) + async def test_batch_swift_update_object_metadata_no_objects(self): + """Test object metadata batch update with missing body.""" + self.mock_request.json = unittest.mock.AsyncMock(return_value=[]) + with self.p_get_sess, self.assertRaises(aiohttp.web.HTTPBadRequest): + await swift_browser_ui.ui.api.swift_batch_update_object_metadata( + self.mock_request, + ) - expected = [ - [ - obj, - {"obj-example": "example", "usertags": "tags;for;testing"}, - ] - ] - self.assertEqual(resp, expected) - - async def test_get_object_meta_s3(self): - """Test metadata API endpoint when object has s3 metadata.""" - req_sessions = self.request.app["Sessions"] - req_sessions[self.cookie]["ST_conn"].init_with_data( - containers=1, - object_range=(1, 1), - size_range=(252144, 252144), + async def test_swift_update_container_metadata(self): + """Test container metadata update with Openstack.""" + self.mock_request.json = unittest.mock.AsyncMock( + return_value=[ + ("meta0", "test-data"), + ("meta1", "more-test-data"), + ], + ) + with self.p_get_sess: + resp = await swift_browser_ui.ui.api.swift_update_container_metadata( + self.mock_request, + ) + self.assertEqual(resp.status, 200) + self.mock_request.json.assert_awaited_once() + self.mock_client.post.assert_called_once() + + async def test_swift_update_object_metadata_via_container(self): + """Test object batch meta update via container meta update.""" + mock_object_batch_meta_update = unittest.mock.AsyncMock() + p_obj_update = unittest.mock.patch( + "swift_browser_ui.ui.api.swift_batch_update_object_metadata", + mock_object_batch_meta_update, ) - req_sessions[self.cookie]["ST_conn"].meta = { - "tempurl_key_1": None, - "tempurl_key_2": None, + self.mock_request.query["objects"] = "true" + with p_obj_update: + await swift_browser_ui.ui.api.swift_update_container_metadata( + self.mock_request, + ) + mock_object_batch_meta_update.assert_awaited_once() + + async def test_swift_get_project_metadata(self): + """Test project metadata fetch with Openstack.""" + self.mock_client_response.status = 204 + self.mock_client_response.headers = { + "X-Account-Container-Count": 100, + "X-Account-Object-Count": 10000, + "X-Account-Bytes-Used": 65535, } - # Get the object key to test with - objs = req_sessions[self.cookie]["ST_conn"].containers["test-container-0"] - objkey = [i["name"] for i in objs][0] + with self.p_get_sess: + await swift_browser_ui.ui.api.swift_get_project_metadata( + self.mock_request, + ) + self.mock_client.head.assert_called_once() + + async def test_swift_get_project_metadata_fail(self): + """Test project metadata fetch with failed request.""" + self.mock_client_response.status = 403 + with self.p_get_sess, self.assertRaises(aiohttp.web.HTTPUnauthorized): + await swift_browser_ui.ui.api.swift_get_project_metadata( + self.mock_request, + ) - req_sessions[self.cookie]["ST_conn"].set_swift_meta_container("test-container-0") + async def test_swift_get_shared_container_address(self): + """Test shared container address fetch.""" + with self.p_get_sess: + resp = await swift_browser_ui.ui.api.get_shared_container_address( + self.mock_request, + ) + self.assertEqual(resp.body, b'"https://test-endpoint-0/v1/AUTH_test-id-0"') - req_sessions[self.cookie]["ST_conn"].set_s3_meta_object( - "test-container-0", objkey + async def test_swift_get_container_acl_wrapper(self): + """Test single container ACL fetch with Openstack.""" + self.mock_client_response.headers = { + "X-Container-Read": "test-project-0:*,.r:*,.rlistings,test-project-1:*", + "X-Container-Write": "test-project-0:*,test-project-1:*", + } + with self.p_get_sess: + ret = await swift_browser_ui.ui.api._swift_get_container_acl_wrapper( + self.mock_request, + "test-container", + ) + self.assertEqual( + { + "test-project-0": { + "write": "*", + "read": "*", + }, + "test-project-1": { + "write": "*", + "read": "*", + }, + }, + ret[1], ) + self.mock_client.head.assert_called_once() - # Set up the query string - self.request.query["container"] = "test-container-0" - self.request.query["object"] = objkey - - resp = await get_metadata_object(self.request) - resp = json.loads(resp.text) + # Cover edge case with headers containing only .rlistings/.r:* + self.mock_client_response.headers = { + "X-Container-Read": ".r:*,.rlistings", + "X-Container-Write": "test-project-0:*,test-project-1:*", + } + with self.p_get_sess: + ret = await swift_browser_ui.ui.api._swift_get_container_acl_wrapper( + self.mock_request, + "test-container", + ) + self.assertEqual( + { + "test-project-0": {"write": "*"}, + "test-project-1": {"write": "*"}, + }, + ret[1], + ) - expected = [ - [ # nosec - objkey, + async def test_get_access_control_metadata(self): + """Test get ACL metadata with Openstack.""" + acl_wrapper_mock = unittest.mock.AsyncMock( + return_value=( + "test-container", { - "s3cmd-attrs": { - "atime": "1536648772", - "ctime": "1536648921", - "gid": "101", - "gname": "example", - } + "test-project-0": { + "write": "*", + }, + "test-project-1": { + "write": "*", + "read": "*", + }, }, + ), + ) + p_acl_wrapper = unittest.mock.patch( + "swift_browser_ui.ui.api._swift_get_container_acl_wrapper", + acl_wrapper_mock, + ) + # (ab)use side effects to mimic openstacks "null" terminated container paging + self.mock_client_response.json = unittest.mock.AsyncMock( + side_effect=[ + [{"name": "test-container"}], + [], ] - ] - self.assertEqual(resp, expected) - - async def test_get_object_meta_swift_whole(self): - """Test metadata API endpoint with containers' objects.""" - req_sessions = self.request.app["Sessions"] - req_sessions[self.cookie]["ST_conn"].init_with_data( - containers=1, - object_range=(5, 5), - size_range=(252144, 252144), ) - req_sessions[self.cookie]["ST_conn"].meta = { - "tempurl_key_1": None, - "tempurl_key_2": None, - } - - req_sessions[self.cookie]["ST_conn"].set_swift_meta_container("test-container-0") - - objs = req_sessions[self.cookie]["ST_conn"].containers["test-container-0"] - for key in [i["name"] for i in objs]: - req_sessions[self.cookie]["ST_conn"].set_swift_meta_object( - "test-container-0", key + with self.p_get_sess, p_acl_wrapper: + resp = await swift_browser_ui.ui.api.get_access_control_metadata( + self.mock_request, ) - - self.request.query["container"] = "test-container-0" - self.request.query["object"] = "%s,%s,%s,%s,%s" % tuple([i["name"] for i in objs]) - - resp = await get_metadata_object(self.request) - resp = json.loads(resp.text) - - comp = [ - [i, {"usertags": "objects;with;tags", "obj-example": "example"}] - for i in [j["name"] for j in objs] - ] - - self.assertEqual(resp, comp) - - async def test_get_project_metadata(self): - """Test metadata API endpoint for account metadata.""" - self.request.app["Sessions"][self.cookie]["ST_conn"].init_with_data( - containers=5, object_range=(100, 100), size_range=(1073741824, 1073741824) + acl_wrapper_mock.assert_awaited() + ret = json.loads(resp.body) + self.assertEqual("https://test-endpoint-0/v1/AUTH_test-id-0", ret["address"]) + self.assertEqual( + ret["access"], + { + "test-container": { + "test-project-0": { + "write": "*", + }, + "test-project-1": { + "write": "*", + "read": "*", + }, + } + }, + ) + # Cover edge case when ending in a 204 + self.mock_client_response.json = unittest.mock.AsyncMock( + return_value=[{"name": "test-container"}] + ) + self.mock_client.get = unittest.mock.Mock( + side_effect=[ + self.MockHandler(self.mock_client_response), + self.MockHandler( + types.SimpleNamespace( + **{ + "status": 204, + } + ) + ), + ] + ) + with self.p_get_sess, p_acl_wrapper: + resp = await swift_browser_ui.ui.api.get_access_control_metadata( + self.mock_request, + ) + acl_wrapper_mock.assert_awaited() + ret = json.loads(resp.body) + self.assertEqual("https://test-endpoint-0/v1/AUTH_test-id-0", ret["address"]) + self.assertEqual( + ret["access"], + { + "test-container": { + "test-project-0": { + "write": "*", + }, + "test-project-1": { + "write": "*", + "read": "*", + }, + } + }, ) - # Compare against the bare minimum amount of information - # required, which - # will be what the function should return. - comp = { - "Account": "AUTH_test_account", - "Containers": 5, - "Objects": 500, - "Bytes": 536870912000, + async def test_remove_project_container_acl(self): + """Test project removal from container acl with Openstack.""" + self.mock_client_response.headers = { + "X-Container-Read": "test-project-0:*,.r:*,.rlistings,test-project-1:*", + "X-Container-Write": "test-project-0:*,test-project-1:*", } + with self.p_get_sess, self.assertRaises(aiohttp.web.HTTPNotFound): + await swift_browser_ui.ui.api.remove_project_container_acl( + self.mock_request, + ) + self.mock_client_response.status = 204 + with self.p_get_sess: + await swift_browser_ui.ui.api.remove_project_container_acl( + self.mock_request, + ) + self.mock_client.post.assert_called_with( + "https://test-endpoint-0/v1/AUTH_test-id-0/test-container", + headers={ + "X-Auth-Token": "test-token-0", + "X-Container-Read": "test-project-0:*,.r:*,.rlistings", + "X-Container-Write": "test-project-0:*", + }, + ) - resp = await get_project_metadata(self.request) - resp = json.loads(resp.text) - - self.assertEqual(resp, comp) - - async def test_get_os_active_project(self): - """Test active project API endpoint.""" - self.request.app["Sessions"][self.cookie]["active_project"] = "placeholder" - resp = await get_os_active_project(self.request) - text = json.loads(resp.text) - self.assertEqual(resp.status, 200) - self.assertEqual(text, "placeholder") + async def test_remove_container_acl(self): + """Test container acl removal with Openstack.""" + with self.p_get_sess, self.assertRaises(aiohttp.web.HTTPNotFound): + await swift_browser_ui.ui.api.remove_container_acl( + self.mock_request, + ) + self.mock_client_response.status = 204 + with self.p_get_sess: + await swift_browser_ui.ui.api.remove_container_acl( + self.mock_request, + ) + self.mock_client.post.assert_called_with( + "https://test-endpoint-0/v1/AUTH_test-id-0/test-container", + headers={ + "X-Auth-Token": "test-token-0", + "X-Container-Read": "", + "X-Container-Write": "", + }, + ) - def tearDown(self): - """Test teardown.""" - self.cookie = None - self.request = None + async def test_add_project_container_acl(self): + """Test project addition to container acl with Openstack.""" + self.mock_client_response.headers = { + "X-Container-Read": "test-project-0:*,.r:*,.rlistings", + "X-Container-Write": "test-project-0:*", + } + self.mock_request.query["projects"] = "test-project-1" + self.mock_request.query["rights"] = "rw" + with self.p_get_sess, self.assertRaises(aiohttp.web.HTTPNotFound): + await swift_browser_ui.ui.api.add_project_container_acl( + self.mock_request, + ) + self.mock_client_response.status = 204 + with self.p_get_sess: + await swift_browser_ui.ui.api.add_project_container_acl( + self.mock_request, + ) + self.mock_client.post.assert_called_with( + "https://test-endpoint-0/v1/AUTH_test-id-0/test-container", + headers={ + "X-Auth-Token": "test-token-0", + "X-Container-Read": "test-project-0:*,.r:*,.rlistings,test-project-1:*", + "X-Container-Write": "test-project-0:*,test-project-1:*", + }, + ) -class TestProxyFunctions(unittest.IsolatedAsyncioTestCase): +class ProxyFunctionsTestClass(tests.common.mockups.APITestBase): """Test the handlers proxying information to the upload runner.""" def setUp(self): """.""" - self.mock_request = types.SimpleNamespace( - **{ - "match_info": { - "project": "test-project", - "container": "test-container", - "object": "test-object", - }, - "query": { - "from_container": "test-container-2", - "from_project": "test-project-2", - }, - "query_string": "&test-query=test-value", - "app": { - "Sessions": { - "session_key": { - "active_project": {"id": "test-id"}, - "Token": "test-token", - } - }, - "Log": logging.getLogger(name="test_logger"), - }, - "remote": "remote", - } - ) - - self.api_check_mock = unittest.mock.MagicMock(return_value="session_key") - self.patch_api_check = unittest.mock.patch( - "swift_browser_ui.ui.api.api_check", self.api_check_mock - ) + super().setUp() + self.mock_request.match_info = { + "project": "test-project", + "container": "test-container", + "object": "test-object", + } + self.mock_request.query = { + "from_container": "test-container-2", + "from_project": "test-project-2", + } + self.mock_request.query_string = ("&test-query=test-value§",) + self.mock_request.remote = ("remote",) self.session_open_mock = unittest.mock.AsyncMock(return_value="test_runner_id") self.patch_runner_session = unittest.mock.patch( @@ -504,41 +635,48 @@ def setUp(self): "swift_browser_ui.ui.api.sign", self.sign_mock ) - self.setd_mock = {"upload_external_endpoint": "http://test-endpoint:9092/"} - self.patch_setd = unittest.mock.patch( - "swift_browser_ui.ui.api.setd", self.setd_mock - ) - async def test_swift_download_share_object(self): """Test share object download handler.""" - with self.patch_api_check, self.patch_runner_session, self.patch_setd, self.patch_sign: - resp = await swift_download_shared_object(self.mock_request) - - self.assertIn("test-signature", resp.headers["Location"]) - self.assertIn("test-valid", resp.headers["Location"]) - self.assertIn("test-endpoint", resp.headers["Location"]) - self.assertEqual(303, resp.status) + with self.p_get_sess, self.patch_runner_session, self.patch_setd, self.patch_sign: + resp = await swift_browser_ui.ui.api.swift_download_shared_object( + self.mock_request, + ) + self.assertIn("test-signature", resp.headers["Location"]) + self.assertIn("test-valid", resp.headers["Location"]) + self.assertIn("test-endpoint", resp.headers["Location"]) + self.assertEqual(303, resp.status) async def test_swift_download_container(self): """Test container download handler.""" - with self.patch_api_check, self.patch_runner_session, self.patch_setd, self.patch_sign: - resp = await swift_download_container(self.mock_request) - - self.assertIn("test-signature", resp.headers["Location"]) - self.assertIn("test-valid", resp.headers["Location"]) - self.assertIn("test-endpoint", resp.headers["Location"]) - self.assertEqual(303, resp.status) + with self.p_get_sess, self.patch_runner_session, self.patch_setd, self.patch_sign: + resp = await swift_browser_ui.ui.api.swift_download_container( + self.mock_request, + ) + self.assertIn("test-signature", resp.headers["Location"]) + self.assertIn("test-valid", resp.headers["Location"]) + self.assertIn("test-endpoint", resp.headers["Location"]) + self.assertEqual(303, resp.status) async def test_swift_replicate_container(self): """Test replicate container handler.""" - with self.patch_api_check, self.patch_runner_session, self.patch_setd, self.patch_sign: - resp = await swift_replicate_container(self.mock_request) - - self.assertIn("test-signature", resp.headers["Location"]) - self.assertIn("test-valid", resp.headers["Location"]) - self.assertIn("test-endpoint", resp.headers["Location"]) - self.assertEqual(307, resp.status) - self.assertIn("from_container", resp.headers["Location"]) - self.assertIn("test-container-2", resp.headers["Location"]) - self.assertIn("from_project", resp.headers["Location"]) - self.assertIn("test-project-2", resp.headers["Location"]) + with self.p_get_sess, self.patch_runner_session, self.patch_setd, self.patch_sign: + resp = await swift_browser_ui.ui.api.swift_replicate_container( + self.mock_request, + ) + self.assertIn("test-signature", resp.headers["Location"]) + self.assertIn("test-valid", resp.headers["Location"]) + self.assertIn("test-endpoint", resp.headers["Location"]) + self.assertEqual(307, resp.status) + self.assertIn("from_container", resp.headers["Location"]) + self.assertIn("test-container-2", resp.headers["Location"]) + self.assertIn("from_project", resp.headers["Location"]) + self.assertIn("test-project-2", resp.headers["Location"]) + + async def test_get_upload_session(self): + """Test get active upload session.""" + with self.p_get_sess, self.patch_runner_session, self.patch_setd, self.patch_sign: + await swift_browser_ui.ui.api.get_upload_session( + self.mock_request, + ) + self.session_open_mock.assert_awaited_once() + self.sign_mock.assert_awaited_once() diff --git a/tests/ui_unit/test_convenience.py b/tests/ui_unit/test_convenience.py index 180377678..723832830 100644 --- a/tests/ui_unit/test_convenience.py +++ b/tests/ui_unit/test_convenience.py @@ -1,344 +1,126 @@ """Module for testing ``swift_browser_ui.ui._convenience``.""" - -import hashlib -import os import unittest -import time -from aiohttp.web import HTTPUnauthorized, Response -from aiohttp.web import HTTPForbidden +import aiohttp.web + +from requests.exceptions import ConnectionError # type: ignore -import cryptography.fernet -from swiftclient.service import SwiftService -from keystoneauth1.session import Session -from swift_browser_ui.ui._convenience import api_check, generate_cookie -from swift_browser_ui.ui._convenience import disable_cache, decrypt_cookie -from swift_browser_ui.ui._convenience import session_check, setup_logging -from swift_browser_ui.ui._convenience import get_availability_from_token -from swift_browser_ui.ui._convenience import initiate_os_service -from swift_browser_ui.ui._convenience import initiate_os_session -from swift_browser_ui.ui._convenience import check_csrf, clear_session_info -from swift_browser_ui.ui.settings import setd +import swift_browser_ui.ui._convenience -from tests.ui_unit.creation import ( - get_request_with_fernet, - get_request_with_mock_openstack, - get_full_crypted_session_cookie, - add_csrf_to_cookie, - encrypt_cookie, -) -from tests.common.mockups import mock_token_output, urlopen +import tests.common.mockups +from tests.common.mockups import mock_token_output -class TestConvenienceFunctions(unittest.TestCase): +class TestConvenienceFunctions( + tests.common.mockups.APITestBase, +): """Test convenience functions.""" def setUp(self): """Test that the logging setup function works.""" - setup_logging() - setd["verbose"] = True - setup_logging() - setd["debug"] = True - setup_logging() + super().setUp() + + def test_test_swift_endpoint(self): + """Test that the swift endpoint check works as it should.""" + mock_get = unittest.mock.Mock( + side_effect=[ + ConnectionError, + None, + ] + ) + p_get = unittest.mock.patch( + "swift_browser_ui.ui._convenience.requests.head", + mock_get, + ) + with self.assertRaises(aiohttp.web.HTTPServiceUnavailable), p_get: + swift_browser_ui.ui._convenience.test_swift_endpoint("test-endpoint") + with p_get: + swift_browser_ui.ui._convenience.test_swift_endpoint("test-endpoint") + mock_get.assert_called_with("test-endpoint") + + async def test_sign(self): + """Test the signature generation.""" + mock_setd = {} + p_setd = unittest.mock.patch( + "swift_browser_ui.ui._convenience.setd", + mock_setd, + ) + mock_sign_api = unittest.mock.Mock() + p_sign = unittest.mock.patch( + "swift_browser_ui.ui._convenience.swift_browser_ui.common.signature.sign_api_request", + mock_sign_api, + ) + with self.assertRaises(aiohttp.web.HTTPNotImplemented), p_setd: + await swift_browser_ui.ui._convenience.sign( + 3600, + "/testpath", + ) + mock_setd["sharing_request_token"] = "test-token" + with p_setd, p_sign: + await swift_browser_ui.ui._convenience.sign( + 3600, + "/testpath", + ) + mock_sign_api.assert_called_with( + "/testpath", + valid_for=3600, + key=b"test-token", + ) def test_disable_cache(self): """Test that the disable_cache function correctly disables cache.""" - response = Response(status=200, body=b"OK") - response = disable_cache(response) + response = aiohttp.web.Response(status=200, body=b"OK") + response = swift_browser_ui.ui._convenience.disable_cache(response) self.assertEqual( response.headers["Cache-Control"], ("no-cache, no-store, must-revalidate") ) self.assertEqual(response.headers["Pragma"], "no-Cache") self.assertEqual(response.headers["Expires"], "0") - def test_generate_cookie(self): - """Test that the cookie generation works.""" - testreq = get_request_with_fernet() - self.assertTrue(generate_cookie(testreq) is not None) - - def test_decrypt_cookie(self): - """Test that the cookie decrypt function works.""" - testreq = get_request_with_fernet() - # Generate cookie is tested separately, it can be used for testing the - # rest of the functions without mockups - cookie, testreq.cookies["S3BROW_SESSION"] = generate_cookie(testreq) - self.assertEqual(cookie, decrypt_cookie(testreq)) - - def test_session_check_nocookie(self): - """Test session check raise 401 on non-existing cookie.""" - req = get_request_with_fernet() - with self.assertRaises(HTTPUnauthorized): - session_check(req) - - def test_session_check_invtoken(self): - """Test session check raise 401 on a stale cookie.""" - req = get_request_with_fernet() - _, req.cookies["S3BROW_SESSION"] = generate_cookie(req) - req.app["Crypt"] = cryptography.fernet.Fernet( - cryptography.fernet.Fernet.generate_key() - ) - with self.assertRaises(HTTPUnauthorized): - session_check(req) - - def test_session_check_nosession(self): - """ - Test session check function raise 401 on invalid session cookie. - - (i.e. it cannot be found in the open session list) - """ - req = get_request_with_fernet() - _, req.cookies["S3BROW_SESSION"] = generate_cookie(req) - req.app["Sessions"] = {} - with self.assertRaises(HTTPUnauthorized): - session_check(req) - - def test_session_check_expired_last_used(self): - """Test session check function raise on expired last use.""" - session, req = get_request_with_mock_openstack() - req.app["Sessions"][session]["last_used"] = time.time() - 7200 - with self.assertRaises(HTTPUnauthorized): - session_check(req) - - def test_session_check_expired_max_lifetime(self): - """Test session check function raise on expired lifetime.""" - session, req = get_request_with_mock_openstack() - req.app["Sessions"][session]["max_lifetime"] = time.time() - 86400 - with self.assertRaises(HTTPUnauthorized): - session_check(req) - - def test_session_check_correct(self): - """ - Test that the ordinary session check function result is True. - - Test condition when the request is formed correctly. - """ - req = get_request_with_fernet() - cookie, _ = generate_cookie(req) - - req.cookies["S3BROW_SESSION"] = get_full_crypted_session_cookie(cookie, req.app) - - session = cookie["id"] - - req.app["Sessions"][session] = {} - req.app["Sessions"][session]["last_used"] = time.time() - 360 - req.app["Sessions"][session]["max_lifetime"] = time.time() + 86400 - self.assertIsNone(session_check(req)) - - # The api_check session check function testing – Might seem unnecessary, - # but are required since e.g. token rescoping can fail the sessions - # before the next API call, also might try to use the API - # while rescoping -> 401 - def test_api_check_raise_on_no_cookie(self): - """Test raise if there's no session cookie.""" - testreq = get_request_with_fernet() - _, testreq.cookies["S3BROW_SESSION"] = generate_cookie(testreq) - testreq.app["Sessions"] = {} - with self.assertRaises(HTTPUnauthorized): - api_check(testreq) - - def test_api_check_raise_on_invalid_cookie(self): - """Test raise if there's an invalid session cookie.""" - testreq = get_request_with_fernet() - _, testreq.cookies["S3BROW_SESSION"] = generate_cookie(testreq) - testreq.app["Sessions"] = {} - with self.assertRaises(HTTPUnauthorized): - api_check(testreq) - - def test_api_check_raise_on_invalid_fernet(self): - """Test raise if the cryptographic key has changed.""" - testreq = get_request_with_fernet() - _, testreq.cookies["S3BROW_SESSION"] = generate_cookie(testreq) - testreq.app["Crypt"] = cryptography.fernet.Fernet( - cryptography.fernet.Fernet.generate_key() - ) - with self.assertRaises(HTTPUnauthorized): - api_check(testreq) - - def test_api_check_raise_on_no_connection(self): - """Test raise if there's no existing OS connection on an API call.""" - testreq = get_request_with_fernet() - cookie, _ = generate_cookie(testreq) - testreq.cookies["S3BROW_SESSION"] = get_full_crypted_session_cookie( - cookie, testreq.app - ) - session = cookie["id"] - testreq.app["Sessions"][session] = {} - testreq.app["Sessions"][session]["Avail"] = "placeholder" - testreq.app["Sessions"][session]["OS_sess"] = "placeholder" - testreq.app["Sessions"][session]["last_used"] = time.time() - 360 - testreq.app["Sessions"][session]["max_lifetime"] = time.time() + 86400 - with self.assertRaises(HTTPUnauthorized): - api_check(testreq) - - def test_api_check_raise_on_no_session(self): - """Test raise if there's no established OS session on an API call.""" - testreq = get_request_with_fernet() - cookie, _ = generate_cookie(testreq) - testreq.cookies["S3BROW_SESSION"] = get_full_crypted_session_cookie( - cookie, testreq.app - ) - session = cookie["id"] - testreq.app["Sessions"][session] = {} - testreq.app["Sessions"][session]["ST_conn"] = "placeholder" - testreq.app["Sessions"][session]["Avail"] = "placeholder" - testreq.app["Sessions"][session]["last_used"] = time.time() - 360 - testreq.app["Sessions"][session]["max_lifetime"] = time.time() + 86400 - with self.assertRaises(HTTPUnauthorized): - api_check(testreq) - - def test_api_check_raise_on_no_avail(self): - """Test raise if the availability wasn't checked before an API call.""" - testreq = get_request_with_fernet() - cookie, _ = generate_cookie(testreq) - testreq.cookies["S3BROW_SESSION"] = get_full_crypted_session_cookie( - cookie, testreq.app + async def test_get_availability_from_token(self): + """Test token availability fetch from Openstack.""" + p_setd = unittest.mock.patch( + "swift_browser_ui.ui._convenience.setd", + {"auth_endpoint_url": "http://example.osexampleserver.com:5001/v3"}, ) - session = cookie["id"] - testreq.app["Sessions"][session] = {} - testreq.app["Sessions"][session]["ST_conn"] = "placeholder" - testreq.app["Sessions"][session]["OS_sess"] = "placeholder" - testreq.app["Sessions"][session]["last_used"] = time.time() - 360 - testreq.app["Sessions"][session]["max_lifetime"] = time.time() + 86400 - with self.assertRaises(HTTPUnauthorized): - api_check(testreq) - - def test_api_check_success(self): - """Test that the api_check function runs with correct input.""" - testreq = get_request_with_fernet() - cookie, _ = generate_cookie(testreq) - testreq.cookies["S3BROW_SESSION"] = get_full_crypted_session_cookie( - cookie, testreq.app + self.mock_client_response.json = unittest.mock.AsyncMock( + side_effect=[ + tests.common.mockups.mock_token_project_avail, + tests.common.mockups.mock_token_domain_avail, + ], ) - session = cookie["id"] - testreq.app["Sessions"][session] = {} - testreq.app["Sessions"][session]["Avail"] = "placeholder" - testreq.app["Sessions"][session]["OS_sess"] = "placeholder" - testreq.app["Sessions"][session]["ST_conn"] = "placeholder" - testreq.app["Sessions"][session]["last_used"] = time.time() - 360 - testreq.app["Sessions"][session]["max_lifetime"] = time.time() + 86400 - ret = api_check(testreq) - self.assertEqual(ret, cookie["id"]) - - def test_get_availability_from_token(self): - """Test the get_availability_from_token function.""" - with unittest.mock.patch( - "swift_browser_ui.ui._convenience.setd", - new={"auth_endpoint_url": "http://example.osexampleserver.com:5001/v3"}, - ): - - # Make the required patches to urllib.request to test the function - with unittest.mock.patch("urllib.request.urlopen", new=urlopen): - - # Test with a valid token - token = hashlib.md5(os.urandom(64)).hexdigest() # nosec - avail = get_availability_from_token(token) - - self.assertEqual(avail["projects"], mock_token_output["projects"]) - self.assertEqual(avail["domains"], mock_token_output["domains"]) - - def test_initiate_os_session(self): - """Test initiate_os_session function.""" - with unittest.mock.patch( - "swift_browser_ui.ui.settings.setd", - new={"auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3"}, - ): - ret = initiate_os_session( - hashlib.md5(os.urandom(64)).hexdigest(), "testproject" # nosec + with p_setd: + ret = await swift_browser_ui.ui._convenience.get_availability_from_token( + "test-token", + self.mock_client, ) - self.assertIsInstance(ret, Session) # nosec - - def test_initiate_os_service(self): - """Test initiate_os_servce function.""" - with unittest.mock.patch( - "swift_browser_ui.ui.settings.setd", - new={ - "auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3", - "swift_endpoint_url": "http://obj.exampleosep.com:443/v1", - }, - ): - sess_mock = unittest.mock.MagicMock(Session) - ret = initiate_os_service(sess_mock()) - self.assertIsInstance(ret, SwiftService) # nosec - - def test_check_csrf_os_skip(self): - """Test check_csrf when skipping referer from OS.""" - with unittest.mock.patch( - "swift_browser_ui.ui._convenience.setd", - new={"auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3"}, - ): - testreq = get_request_with_fernet() - cookie, _ = generate_cookie(testreq) - cookie = add_csrf_to_cookie(cookie, testreq) - encrypt_cookie(cookie, testreq) - testreq.headers["Referer"] = "http://example-auth.exampleosep.com" - self.assertTrue(check_csrf(testreq)) - - def test_check_csrf_incorrect_referer(self): - """Test check_csrf when Referer header is incorrect.""" - with unittest.mock.patch( - "swift_browser_ui.ui._convenience.setd", - new={"auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3"}, - ): - testreq = get_request_with_fernet() - cookie, _ = generate_cookie(testreq) - cookie = add_csrf_to_cookie(cookie, testreq) - encrypt_cookie(cookie, testreq) - testreq.headers["Referer"] = "http://notlocaclhost:8080" - with self.assertRaises(HTTPForbidden): - check_csrf(testreq) - - def test_check_csrf_incorrect_signature(self): - """Test check_csrf when signature doesn't match.""" - with unittest.mock.patch( - "swift_browser_ui.ui._convenience.setd", - new={"auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3"}, - ): - testreq = get_request_with_fernet() - cookie, _ = generate_cookie(testreq) - cookie = add_csrf_to_cookie(cookie, testreq, bad_sign=True) - encrypt_cookie(cookie, testreq) - testreq.headers["Referer"] = "http://localhost:8080" - with self.assertRaises(HTTPForbidden): - check_csrf(testreq) - - def test_check_csrf_no_referer(self): - """Test check_csrf when no Referer header is present.""" - with unittest.mock.patch( - "swift_browser_ui.ui._convenience.setd", - new={"auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3"}, - ): - testreq = get_request_with_fernet() - cookie, _ = generate_cookie(testreq) - cookie = add_csrf_to_cookie(cookie, testreq) - encrypt_cookie(cookie, testreq) - self.assertTrue(check_csrf(testreq)) - - def test_check_csrf_correct_referer(self): - """Test check_csrf when the session is valid.""" - with unittest.mock.patch( - "swift_browser_ui.ui._convenience.setd", - new={"auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3"}, - ): - testreq = get_request_with_fernet() - cookie, _ = generate_cookie(testreq) - cookie = add_csrf_to_cookie(cookie, testreq) - encrypt_cookie(cookie, testreq) - testreq.headers["Referer"] = "http://localhost:8080" - self.assertTrue(check_csrf(testreq)) - - def test_clear_session_info(self): - """Test if session information clear works.""" - session, req = get_request_with_mock_openstack() - sess_mock = unittest.mock.MagicMock("keystoneauth.session.Session") - sess = sess_mock() - req.app["Sessions"][session]["OS_sess"] = sess - req.app["Sessions"][session]["Token"] = "not_real_token" + self.assertEqual(ret["projects"], mock_token_output["projects"]) + self.assertEqual(ret["domains"], mock_token_output["domains"]) + + async def test_get_tempurl_key(self): + """Test tempurl key fetch from Openstack.""" + with self.p_get_sess, self.assertRaises(aiohttp.web.HTTPServerError): + ret = await swift_browser_ui.ui._convenience.get_tempurl_key( + self.mock_request, + ) + self.mock_client_response.status = 204 + with self.p_get_sess: + ret = await swift_browser_ui.ui._convenience.get_tempurl_key( + self.mock_request, + ) + self.assertIsNotNone(ret) - clear_session_info(req.app["Sessions"][session]) + self.mock_client_response.headers = {"X-Account-Meta-Temp-Url-Key": "test-key"} + with self.p_get_sess: + ret = await swift_browser_ui.ui._convenience.get_tempurl_key( + self.mock_request, + ) + self.assertEqual(ret, "test-key") - sess.invalidate.assert_called_once() - self.assertIsNone(req.app["Sessions"][session]["ST_conn"]) - self.assertIsNone(req.app["Sessions"][session]["OS_sess"]) - self.assertIsNone(req.app["Sessions"][session]["Avail"]) - self.assertIsNone(req.app["Sessions"][session]["Token"]) + self.mock_client_response.headers = {"X-Account-Meta-Temp-Url-Key-2": "test-key"} + with self.p_get_sess: + ret = await swift_browser_ui.ui._convenience.get_tempurl_key( + self.mock_request, + ) + self.assertEqual(ret, "test-key") diff --git a/tests/ui_unit/test_front.py b/tests/ui_unit/test_front.py index e72ad9518..007eefbf2 100644 --- a/tests/ui_unit/test_front.py +++ b/tests/ui_unit/test_front.py @@ -3,13 +3,17 @@ import unittest import os +import time +import aiohttp_session from aiohttp.test_utils import AioHTTPTestCase from swift_browser_ui.ui.server import servinit -class FrontendTestCase(AioHTTPTestCase): +class FrontendTestCase( + AioHTTPTestCase, +): """Test frontend.""" async def get_application(self): @@ -23,42 +27,75 @@ def return_true(_): async def test_browse(self): """Test /browse handler.""" + session_return = aiohttp_session.Session( + "test-identity", + new=True, + data={}, + ) + session_return["at"] = time.time() + session_return["token"] = "placeholder" + session_return["projects"] = "placeholder" + aiohttp_session_get_session_mock = unittest.mock.AsyncMock() + aiohttp_session_get_session_mock.return_value = session_return + p_get_sess = unittest.mock.patch( + "swift_browser_ui.ui.front.aiohttp_session.get_session", + aiohttp_session_get_session_mock, + ) patch_setd = unittest.mock.patch( "swift_browser_ui.ui.front.setd", new={"static_directory": os.getcwd() + "/swift_browser_ui_frontend/dist"}, ) - patch_check = unittest.mock.patch( - "swift_browser_ui.ui.front.session_check", new=self.return_true - ) - with patch_setd, patch_check: + with patch_setd, p_get_sess: response = await self.client.request("GET", "/browse") self.assertEqual(response.status, 200) self.assertEqual(response.headers["Content-type"], "text/html") async def test_index(self): """Test / handler.""" + session_return = aiohttp_session.Session( + "test-identity", + new=True, + data={}, + ) + session_return["at"] = time.time() + session_return["token"] = "placeholder" + session_return["projects"] = "placeholder" + aiohttp_session_get_session_mock = unittest.mock.AsyncMock() + aiohttp_session_get_session_mock.return_value = session_return + p_get_sess = unittest.mock.patch( + "swift_browser_ui.ui.front.aiohttp_session.get_session", + aiohttp_session_get_session_mock, + ) patch_setd = unittest.mock.patch( "swift_browser_ui.ui.front.setd", new={"static_directory": os.getcwd() + "/swift_browser_ui_frontend/dist"}, ) - patch_check = unittest.mock.patch( - "swift_browser_ui.ui.front.session_check", new=self.return_true - ) - with patch_setd, patch_check: + with patch_setd, p_get_sess: response = await self.client.request("GET", "/") self.assertEqual(response.status, 200) self.assertEqual(response.headers["Content-type"], "text/html") async def test_loginpassword(self): """Test /loginpassword handler.""" + session_return = aiohttp_session.Session( + "test-identity", + new=True, + data={}, + ) + session_return["at"] = time.time() + session_return["token"] = "placeholder" + session_return["projects"] = "placeholder" + aiohttp_session_get_session_mock = unittest.mock.AsyncMock() + aiohttp_session_get_session_mock.return_value = session_return + p_get_sess = unittest.mock.patch( + "swift_browser_ui.ui.front.aiohttp_session.get_session", + aiohttp_session_get_session_mock, + ) patch_setd = unittest.mock.patch( "swift_browser_ui.ui.front.setd", new={"static_directory": os.getcwd() + "/swift_browser_ui_frontend/dist"}, ) - patch_check = unittest.mock.patch( - "swift_browser_ui.ui.front.session_check", new=self.return_true - ) - with patch_setd, patch_check: + with patch_setd, p_get_sess: response = await self.client.request("GET", "/loginpassword") self.assertEqual(response.status, 200) self.assertEqual(response.headers["Content-type"], "text/html") diff --git a/tests/ui_unit/test_login.py b/tests/ui_unit/test_login.py index 11d8d4cb5..3ffda3b21 100644 --- a/tests/ui_unit/test_login.py +++ b/tests/ui_unit/test_login.py @@ -3,37 +3,35 @@ import hashlib import os import unittest -import json -import types import aiohttp import swift_browser_ui.ui.login import swift_browser_ui.ui.settings -from tests.ui_unit.creation import ( - get_request_with_fernet, - get_request_with_login_form, - get_request_with_mock_openstack, -) -from tests.common.mockups import ( - return_project_avail, - return_test_swift_endpoint, - return_invalid, - mock_token_project_avail, - return_mock_token, -) +import tests.common.mockups _path = "/auth/OS-FEDERATION/identity_providers/haka/protocols/saml2/websso" -class LoginTestClass(unittest.IsolatedAsyncioTestCase): +class LoginTestClass(tests.common.mockups.APITestBase): """Testing the Object Browser API.""" + def setUp(self): + """.""" + super().setUp() + self.setd_mock["static_directory"] = ( + __file__.replace("/settings.py", "") + "/static" + ) + self.p_get_sess = unittest.mock.patch( + "swift_browser_ui.ui.login.aiohttp_session.get_session", + self.aiohttp_session_get_session_mock, + ) + async def test_handle_login(self): """Test initial login handler.""" - mock_req = types.SimpleNamespace(**{"query": {"navto": "http://example"}}) - resp = await swift_browser_ui.ui.login.handle_login(mock_req) + self.mock_request.query["navto"] = "http://example" + resp = await swift_browser_ui.ui.login.handle_login(self.mock_request) self.assertEqual(resp.headers["Location"], "/login/front") self.assertEqual(resp.status, 302) @@ -42,11 +40,7 @@ async def test_sso_query_begin_with_trust(self): """Test sso query begin function.""" with unittest.mock.patch( "swift_browser_ui.ui.login.setd", - new={ - "auth_endpoint_url": "https://example.os.com:5001/v3", - "set_origin_address": "https://localhost/login/websso", - "has_trust": True, - }, + self.setd_mock, ): resp = await swift_browser_ui.ui.login.sso_query_begin(None) self.assertEqual(resp.status, 302) @@ -58,330 +52,280 @@ async def test_sso_query_begin_with_trust(self): async def test_sso_query_begin_without_trust(self): """Test sso query begin without trust.""" + self.setd_mock["has_trust"] = False with unittest.mock.patch( "swift_browser_ui.ui.login.setd", - new={ - "auth_endpoint_url": "https://example.os.com:5001/v3", - "origin_address": "https://localhost/login/websso", - "has_trust": False, - "static_directory": (__file__.replace("/settings.py", "") + "/static"), - }, + self.setd_mock, ): resp = await swift_browser_ui.ui.login.sso_query_begin(None) self.assertEqual(resp.status, 200) - async def test_sso_query_end_successful_http_form(self): - """ - Test sso query end function with correct execution parameters. - - This version tests the token delivery in a http encoded form. - """ - patch1 = unittest.mock.patch( - "swift_browser_ui.ui.login.setd", - new={ - "auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3", - "swift_endpoint_url": "http://obj.exampleosep.com:443/v1", - "session_lifetime": 28800, - "history_lifetime": 2592000, - }, - ) - - # Patch away the convenience function for checking project availability - patch2 = unittest.mock.patch( - "swift_browser_ui.ui.login.get_availability_from_token", - new=return_project_avail, + async def test_test_token(self): + """Test the token validity checks.""" + token_md5 = hashlib.md5(os.urandom(64)).hexdigest() # nosec + token_fernet = ( # nosec + "gAAAAABiAmI1X69b0kYq7V41NYl7RJDGIikq4rvN4nWwWeo-CNLkr08ZSLxA0aL" + "DqUhMYIhUSvkqqAbUvHXsjcHfx8gIroUY4h3y1MGBOvpHOZqdhCHq5oMuYsHE1rSpzq7UNfVsW" + "ce6" ) - patch3 = unittest.mock.patch("keystoneauth1.identity.v3.Token") - patch4 = unittest.mock.patch("keystoneauth1.session.Session") - patch5 = unittest.mock.patch("swiftclient.service.SwiftService") - - patch6 = unittest.mock.patch( - "swift_browser_ui.ui.login.test_swift_endpoint", - new=return_test_swift_endpoint, - ) - - with patch1, patch2, patch3, patch4, patch5, patch6: - req = get_request_with_fernet() - token = hashlib.md5(os.urandom(64)).hexdigest() # nosec - req.set_post({"token": token}) - - resp = await swift_browser_ui.ui.login.sso_query_end(req) + # Test with missing token + with self.assertRaises(aiohttp.web.HTTPBadRequest): + swift_browser_ui.ui.login.test_token( + {}, + self.mock_request, + ) - # Test for the correct values - assert req.app["Sessions"] # nosec - session = list(req.app["Sessions"])[0] - self.assertTrue(req.app["Sessions"][session]["Token"] is not None) - self.assertNotEqual(req.app["Sessions"][session]["Avail"], "INVALID") - self.assertEqual( - req.app["Sessions"][session]["active_project"], + # Test with malformed "fernet" token + with self.assertRaises(aiohttp.web.HTTPBadRequest): + swift_browser_ui.ui.login.test_token( { - "name": "placeholder", - "id": "placeholder", + "token": b"1_HsWO4xZLCL5NRBpvF_Fg==", }, + self.mock_request, ) - self.assertEqual(resp.status, 303) - self.assertEqual(resp.headers["Location"], "/browse") - self.assertIn("S3BROW_SESSION", resp.cookies) - - async def test_sso_query_end_successful_url_form(self): - """ - Test sso query end function with correct execution parameters. - This version tests the token delivery in a urlencoded form instead of a - http encoded one. - """ - patch1 = unittest.mock.patch( - "swift_browser_ui.ui.login.setd", - new={ - "auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3", - "swift_endpoint_url": "http://obj.exampleosep.com:443/v1", - "session_lifetime": 28800, - "history_lifetime": 2592000, + # Test with token in form + ret = swift_browser_ui.ui.login.test_token( + { + "token": token_md5, }, + self.mock_request, ) + self.assertEqual(ret, token_md5) - patch2 = unittest.mock.patch( - "swift_browser_ui.ui.login.get_availability_from_token", - new=return_project_avail, + # Test with token in query + self.mock_request.query["token"] = token_fernet + ret = swift_browser_ui.ui.login.test_token( + {}, + self.mock_request, ) - - patch3 = unittest.mock.patch("keystoneauth1.identity.v3.Token") - patch4 = unittest.mock.patch("keystoneauth1.session.Session") - patch5 = unittest.mock.patch("swiftclient.service.SwiftService") - - patch6 = unittest.mock.patch( - "swift_browser_ui.ui.login.test_swift_endpoint", - new=return_test_swift_endpoint, + self.assertEqual(ret, token_fernet) + self.mock_request.query = {} + + # Test with token in headers + self.mock_request.headers["X-Auth-Token"] = token_md5 + ret = swift_browser_ui.ui.login.test_token( + {}, + self.mock_request, ) + self.assertEqual(ret, token_md5) + + # Test with token that's malformed with both md5 and fernet + self.mock_request.headers["X-Auth-Token"] = "token-garbage" + with self.assertRaises(aiohttp.web.HTTPBadRequest): + swift_browser_ui.ui.login.test_token( + {}, + self.mock_request, + ) - with patch1, patch2, patch3, patch4, patch5, patch6: - req = get_request_with_fernet() - token = hashlib.md5(os.urandom(64)).hexdigest() # nosec + async def test_credentials_login_end(self): + """Test credentials login end handler.""" + self.mock_request.post.return_value = {} + self.mock_client_response.text.return_value = "test-reason" + # Test with missing username/password + with self.assertRaises(aiohttp.web.HTTPBadRequest): + await swift_browser_ui.ui.login.credentials_login_end( + self.mock_request, + ) - req.query["token"] = token + self.mock_request.post.return_value = { + "username": "test-username", + "password": "test-password", + } + # Test with different response failure status codes + self.mock_client_response.status = 400 + with self.assertRaises(aiohttp.web.HTTPBadRequest): + await swift_browser_ui.ui.login.credentials_login_end( + self.mock_request, + ) + self.mock_client_response.status = 401 + with self.assertRaises(aiohttp.web.HTTPUnauthorized): + await swift_browser_ui.ui.login.credentials_login_end( + self.mock_request, + ) + self.mock_client_response.status = 500 + with self.assertRaises(aiohttp.web.HTTPUnauthorized): + await swift_browser_ui.ui.login.credentials_login_end( + self.mock_request, + ) - resp = await swift_browser_ui.ui.login.sso_query_end(req) + # Test with "correct" credentials + self.mock_client_response.status = 201 + self.mock_client_response.headers["X-Subject-Token"] = "test-token" + mock_login = unittest.mock.AsyncMock() + patch_login = unittest.mock.patch( + "swift_browser_ui.ui.login.login_with_token", mock_login + ) + with patch_login: + await swift_browser_ui.ui.login.credentials_login_end( + self.mock_request, + ) + mock_login.assert_awaited_once_with( + self.mock_request, + "test-token", + ) - # Test for the correct values - assert req.app["Sessions"] # nosec - session = list(req.app["Sessions"].keys())[0] - self.assertTrue(req.app["Sessions"][session]["Token"] is not None) - self.assertNotEqual(req.app["Sessions"][session]["Avail"], "INVALID") - self.assertEqual( - req.app["Sessions"][session]["active_project"], - { - "name": "placeholder", - "id": "placeholder", - }, + async def test_sso_query_end(self): + """Test SSO query end handler.""" + self.mock_request.post.return_value = { + "token": "test-token", + } + mock_login = unittest.mock.AsyncMock() + patch_login = unittest.mock.patch( + "swift_browser_ui.ui.login.login_with_token", + mock_login, + ) + patch_test_token = unittest.mock.patch( + "swift_browser_ui.ui.login.test_token", + unittest.mock.Mock(return_value="test-token"), + ) + with patch_login, patch_test_token: + await swift_browser_ui.ui.login.sso_query_end( + self.mock_request, ) - self.assertEqual(resp.status, 303) - self.assertEqual(resp.headers["Location"], "/browse") - self.assertIn("S3BROW_SESSION", resp.cookies) + mock_login.assert_awaited_once_with( + self.mock_request, + "test-token", + ) - async def test_sso_query_end_successful_header(self): + async def test_login_with_token(self): """ Test sso query end function with correct execution parameters. - This version tests the token delivery in a HTTP header. + This version tests the token delivery in a http encoded form. """ + self.setd_mock["session_lifetime"] = 28800 + self.setd_mock["history_lifetime"] = 2592000 + self.setd_mock["swift_endpoint_url"] = ("http://obj.exampleosep.com:443/v1",) patch1 = unittest.mock.patch( "swift_browser_ui.ui.login.setd", - new={ - "auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3", - "swift_endpoint_url": "http://obj.exampleosep.com:443/v1", - "session_lifetime": 28800, - "history_lifetime": 2592000, - }, + self.setd_mock, ) # Patch away the convenience function for checking project availability - patch2 = unittest.mock.patch( - "swift_browser_ui.ui.login.get_availability_from_token", - new=return_project_avail, - ) - - patch3 = unittest.mock.patch("keystoneauth1.identity.v3.Token") - - patch4 = unittest.mock.patch("keystoneauth1.session.Session") - - patch5 = unittest.mock.patch("swiftclient.service.SwiftService") - - patch6 = unittest.mock.patch( - "swift_browser_ui.ui.login.test_swift_endpoint", - new=return_test_swift_endpoint, - ) - - with patch1, patch2, patch3, patch4, patch5, patch6: - req = get_request_with_fernet() - token = hashlib.md5(os.urandom(64)).hexdigest() # nosec - - req.headers["X-Auth-Token"] = token - - resp = await swift_browser_ui.ui.login.sso_query_end(req) - - # Test for the correct values - assert req.app["Sessions"] # nosec - session = list(req.app["Sessions"].keys())[0] - self.assertTrue(req.app["Sessions"][session]["Token"] is not None) - self.assertNotEqual(req.app["Sessions"][session]["Avail"], "INVALID") - self.assertEqual( - req.app["Sessions"][session]["active_project"], - { - "name": "placeholder", - "id": "placeholder", - }, - ) - self.assertEqual(resp.status, 303) - self.assertEqual(resp.headers["Location"], "/browse") - self.assertIn("S3BROW_SESSION", resp.cookies) - - async def test_credential_query_end(self): - """Test credential query end.""" - patch1 = unittest.mock.patch( - "swift_browser_ui.ui.login.setd", - new={ - "auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3", - "swift_endpoint_url": "http://obj.exampleosep.com:443/v1", - "session_lifetime": 28800, - "history_lifetime": 2592000, - }, + mock_get_avail = unittest.mock.AsyncMock( + return_value=tests.common.mockups.mock_token_output, ) patch2 = unittest.mock.patch( - "swift_browser_ui.ui.login.os_get_token_from_credentials", - new=return_mock_token, - ) - # Patch away the convenience function for checking project availability - patch3 = unittest.mock.patch( "swift_browser_ui.ui.login.get_availability_from_token", - new=return_project_avail, + mock_get_avail, ) - patch4 = unittest.mock.patch("keystoneauth1.identity.v3.Token") - - patch5 = unittest.mock.patch("keystoneauth1.session.Session") - - patch6 = unittest.mock.patch("swiftclient.service.SwiftService") - - patch7 = unittest.mock.patch( - "swift_browser_ui.ui.login.test_swift_endpoint", - new=return_test_swift_endpoint, - ) - - with patch1, patch2, patch3, patch4, patch5, patch6, patch7: - req = get_request_with_login_form() - resp = await swift_browser_ui.ui.login.credentials_login_end(req) - - # Test for the correct values - assert req.app["Sessions"] # nosec - session = list(req.app["Sessions"].keys())[0] - self.assertTrue(req.app["Sessions"][session]["Token"] is not None) - self.assertNotEqual(req.app["Sessions"][session]["Avail"], "INVALID") - self.assertEqual( - req.app["Sessions"][session]["active_project"], - { - "name": "placeholder", - "id": "placeholder", + self.mock_client_response.headers["X-Subject-Token"] = "test-token" # nosec + self.mock_client_json = { + "token": { + "user": { + "name": "test-user", }, - ) - self.assertEqual(resp.status, 303) - self.assertEqual(resp.headers["Location"], "/browse") - self.assertIn("S3BROW_SESSION", resp.cookies) - - async def test_sso_query_end_unsuccessful_missing_token(self): - """Test unsuccessful token delivery with token missing.""" - patch1 = unittest.mock.patch( - "swift_browser_ui.ui.login.setd", - new={ - "auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3", - "swift_endpoint_url": "http://obj.exampleosep.com:443/v1", + "roles": [ + { + "name": "object_store_user", + }, + ], + "catalog": [ + { + "type": "object-store", + "id": "test-id", + "name": "swift", + "endpoints": [ + { + "region_id": "default", + "url": "https://test-swift:443/swift/v1/AUTH_test-id-0", + "region": "default", + "interface": "admin", + "id": "test-id", + }, + { + "region_id": "default", + "url": "https://test-swift:443/swift/v1/AUTH_test-id-0", + "region": "default", + "interface": "public", + "id": "test-id", + }, + { + "region_id": "default", + "url": "https://test-swift:443/swift/v1/AUTH_test-id-0", + "region": "default", + "interface": "internal", + "id": "test-id", + }, + ], + }, + ], }, + } + self.mock_client_response.json = unittest.mock.AsyncMock( + return_value=self.mock_client_json, ) - patch2 = unittest.mock.patch("keystoneauth1.identity.v3.Token") - patch3 = unittest.mock.patch("keystoneauth1.session.Session") - patch4 = unittest.mock.patch("swiftclient.service.SwiftService") - - with patch1, patch2, patch3, patch4: - req = get_request_with_fernet() + token = hashlib.md5(os.urandom(64)).hexdigest() # nosec - with self.assertRaises(aiohttp.web.HTTPClientError): - _ = await swift_browser_ui.ui.login.sso_query_end(req) + with patch1, patch2, self.p_new_sess: + resp = await swift_browser_ui.ui.login.login_with_token( + self.mock_request, + token, + ) - async def test_sso_query_end_unsuccessful_invalid_token(self): - """Test unsuccessful token delivery with an invalid.""" - patch1 = unittest.mock.patch( - "swift_browser_ui.ui.login.setd", - new={ - "auth_endpoint_url": "http://example-auth.exampleosep.com:5001/v3", - "swift_endpoint_url": "http://obj.exampleosep.com:443/v1", - "has_trust": False, + self.assertEqual(resp.status, 303) + self.assertEqual(resp.headers["Location"], "/browse") + self.mock_client.post.assert_called_with( + "https://example.os.com:5001/v3/auth/tokens", + json={ + "auth": { + "identity": { + "methods": [ + "token", + ], + "token": { + "id": token, + }, + }, + "scope": {"project": {"id": "what"}}, + } }, ) - # Patch away the convenience function for checking project availability - patch2 = unittest.mock.patch( - "swift_browser_ui.ui.login.get_availability_from_token", new=return_invalid - ) - - patch3 = unittest.mock.patch("keystoneauth1.identity.v3.Token") - patch4 = unittest.mock.patch("keystoneauth1.session.Session") - patch5 = unittest.mock.patch("swiftclient.service.SwiftService") + self.mock_request.cookies["NAV_TO"] = "/test-nav" + with patch1, patch2, self.p_new_sess: + resp = await swift_browser_ui.ui.login.login_with_token( + self.mock_request, + token, + ) - with patch1, patch2, patch3, patch4, patch5: - req = get_request_with_fernet() - # token = hashlib.md5(os.urandom(64)).hexdigest() # nosec - token = "incorrect_token" # nosec + self.assertEqual(resp.headers["Location"], "/test-nav") - req.headers["X-Auth-Token"] = token + self.mock_client_response.status = 401 + with self.assertRaises( + aiohttp.web.HTTPUnauthorized + ), patch1, patch2, self.p_new_sess: + await swift_browser_ui.ui.login.login_with_token( + self.mock_request, + token, + ) - with self.assertRaises(aiohttp.web.HTTPClientError): - await swift_browser_ui.ui.login.sso_query_end(req) + self.mock_client_response.status = 403 + with self.assertRaises( + aiohttp.web.HTTPForbidden + ), patch1, patch2, self.p_new_sess: + await swift_browser_ui.ui.login.login_with_token( + self.mock_request, + token, + ) async def test_handle_logout(self): - """Test the logout function.""" - cookie, req = get_request_with_mock_openstack() - - sess_mock = unittest.mock.MagicMock("keystoneauth.session.Session") - req.app["Sessions"][cookie]["OS_sess"] = sess_mock() - - resp = await swift_browser_ui.ui.login.handle_logout(req) - + """Test logging out.""" + with self.p_get_sess: + resp = await swift_browser_ui.ui.login.handle_logout( + self.mock_request, + ) + self.mock_client.delete.assert_called() self.assertEqual(resp.status, 303) self.assertEqual(resp.headers["Location"], "/") - self.assertNotIn(cookie, req.app["Sessions"]) - - async def test_token_rescope_not_available(self): - """Test the token rescope function.""" - session, req = get_request_with_mock_openstack() - req.app["Sessions"][session]["Avail"] = json.loads(mock_token_project_avail) - req.query["project"] = "non-existent-project" - with self.assertRaises(aiohttp.web.HTTPForbidden): - await swift_browser_ui.ui.login.token_rescope(req) - - async def test_token_rescope_correct(self): - """Test the token rescope function with correct request.""" - session, req = get_request_with_mock_openstack() - req.app["Sessions"][session]["Avail"] = json.loads(mock_token_project_avail) - req.query["project"] = "wol" - req.app["Sessions"][session]["Token"] = "not_actually_a_token" # nosec - - # Set up mockups - sess_mock = unittest.mock.MagicMock("keystoneauth.session.Session") - req.app["Sessions"][session]["OS_sess"] = sess_mock() - patch_os_auth = unittest.mock.patch( - "swift_browser_ui.ui.login.initiate_os_service", - new=unittest.mock.MagicMock( - swift_browser_ui.ui._convenience.initiate_os_service - ), - ) - patch_os_sess = unittest.mock.patch( - "swift_browser_ui.ui.login.initiate_os_session", - new=unittest.mock.MagicMock( - swift_browser_ui.ui._convenience.initiate_os_session - ), - ) - with patch_os_auth, patch_os_sess: - resp = await swift_browser_ui.ui.login.token_rescope(req) - self.assertEqual(resp.status, 303) - self.assertEqual(resp.headers["Location"], "/browse") + + # Test with "undecryptable" session + self.aiohttp_session_get_session_mock.side_effect = aiohttp.web.HTTPUnauthorized + with self.assertRaises(aiohttp.web.HTTPUnauthorized), self.p_get_sess: + await swift_browser_ui.ui.login.handle_logout( + self.mock_request, + ) diff --git a/tests/ui_unit/test_middlewares.py b/tests/ui_unit/test_middlewares.py index aa84ef665..5a8446e3a 100644 --- a/tests/ui_unit/test_middlewares.py +++ b/tests/ui_unit/test_middlewares.py @@ -7,9 +7,11 @@ from aiohttp.web import HTTPUnauthorized, HTTPForbidden, HTTPNotFound from aiohttp.web import Response, HTTPClientError, FileResponse -from swift_browser_ui.ui.middlewares import error_middleware +import swift_browser_ui.ui.middlewares from swift_browser_ui.ui.front import index +import tests.common.mockups + async def return_401_handler(with_exception): """Return an HTTP401 error.""" @@ -39,9 +41,52 @@ async def return_400_handler(with_exception): return Response(status=400) -class MiddlewareTestClass(unittest.IsolatedAsyncioTestCase): +async def return_200_handler(_): + """Return a successful response.""" + return Response(status=200, body=b"OK") + + +class MiddlewareTestClass(tests.common.mockups.APITestBase): """Testing the error middleware.""" + def setUp(self): + """.""" + super().setUp() + self.p_get_sess = unittest.mock.patch( + "swift_browser_ui.ui.middlewares.aiohttp_session.get_session", + self.aiohttp_session_get_session_mock, + ) + + async def test_check_session_at(self): + """Test session expiration middleware.""" + with self.p_get_sess: + ret = await swift_browser_ui.ui.middlewares.check_session_at( + self.mock_request, + return_200_handler, + ) + self.assertEqual(ret.status, 200) + + async def test_check_session_fail_expired(self): + """Test session expiration middleware with expired session.""" + self.mock_request.path = "/api/test-projct/test-container" + self.session_return["at"] = 0 + + with self.p_get_sess, self.assertRaises(HTTPUnauthorized): + await swift_browser_ui.ui.middlewares.check_session_at( + self.mock_request, + return_200_handler, + ) + + async def test_check_session_fail_no_raise(self): + """Test session expiration middleware with route that shouldn't fail.""" + self.mock_request.path = "/login" + with self.p_get_sess: + ret = await swift_browser_ui.ui.middlewares.check_session_at( + self.mock_request, + return_200_handler, + ) + self.assertEqual(ret.status, 200) + async def test_401_return(self): """Test 401 middleware when the 401 status is returned.""" patch_setd = unittest.mock.patch( @@ -49,7 +94,9 @@ async def test_401_return(self): new={"static_directory": os.getcwd() + "/swift_browser_ui_frontend/dist"}, ) with patch_setd: - resp = await error_middleware(None, return_401_handler) + resp = await swift_browser_ui.ui.middlewares.error_middleware( + None, return_401_handler + ) self.assertEqual(resp.status, 401) self.assertIsInstance(resp, Response) @@ -60,7 +107,9 @@ async def test_401_exception(self): new={"static_directory": os.getcwd() + "/swift_browser_ui_frontend/dist"}, ) with patch_setd: - resp = await error_middleware(True, return_401_handler) + resp = await swift_browser_ui.ui.middlewares.error_middleware( + True, return_401_handler + ) self.assertEqual(resp.status, 401) self.assertIsInstance(resp, Response) @@ -71,7 +120,9 @@ async def test_403_return(self): new={"static_directory": os.getcwd() + "/swift_browser_ui_frontend/dist"}, ) with patch_setd: - resp = await error_middleware(None, return_403_handler) + resp = await swift_browser_ui.ui.middlewares.error_middleware( + None, return_403_handler + ) self.assertEqual(resp.status, 403) self.assertIsInstance(resp, Response) @@ -82,7 +133,9 @@ async def test_403_exception(self): new={"static_directory": os.getcwd() + "/swift_browser_ui_frontend/dist"}, ) with patch_setd: - resp = await error_middleware(True, return_403_handler) + resp = await swift_browser_ui.ui.middlewares.error_middleware( + True, return_403_handler + ) self.assertEqual(resp.status, 403) self.assertIsInstance(resp, Response) @@ -93,7 +146,9 @@ async def test_404_return(self): new={"static_directory": os.getcwd() + "/swift_browser_ui_frontend/dist"}, ) with patch_setd: - resp = await error_middleware(None, return_404_handler) + resp = await swift_browser_ui.ui.middlewares.error_middleware( + None, return_404_handler + ) self.assertEqual(resp.status, 404) self.assertIsInstance(resp, Response) @@ -104,7 +159,9 @@ async def test_404_exception(self): new={"static_directory": os.getcwd() + "/swift_browser_ui_frontend/dist"}, ) with patch_setd: - resp = await error_middleware(True, return_404_handler) + resp = await swift_browser_ui.ui.middlewares.error_middleware( + True, return_404_handler + ) self.assertEqual(resp.status, 404) self.assertIsInstance(resp, Response) @@ -115,7 +172,7 @@ async def test_error_middleware_no_error(self): new={"static_directory": os.getcwd() + "/swift_browser_ui_frontend/dist"}, ) with patch_setd: - resp = await error_middleware(None, index) + resp = await swift_browser_ui.ui.middlewares.error_middleware(None, index) self.assertEqual(resp.status, 200) self.assertIsInstance(resp, FileResponse) @@ -126,4 +183,6 @@ async def test_error_middleware_non_handled_raise(self): new={"static_directory": os.getcwd() + "/swift_browser_ui_frontend/dist"}, ) with self.assertRaises(HTTPClientError), patch_setd: - await error_middleware(True, return_400_handler) + await swift_browser_ui.ui.middlewares.error_middleware( + True, return_400_handler + ) diff --git a/tests/ui_unit/test_server.py b/tests/ui_unit/test_server.py index 77dc0beda..3f0f59911 100644 --- a/tests/ui_unit/test_server.py +++ b/tests/ui_unit/test_server.py @@ -13,11 +13,9 @@ import aiohttp from swift_browser_ui.ui.server import servinit, run_server_insecure -from swift_browser_ui.ui.server import kill_sess_on_shutdown, run_server_secure +from swift_browser_ui.ui.server import run_server_secure from swift_browser_ui.ui.settings import setd -from tests.ui_unit.creation import get_request_with_mock_openstack - # Set static folder in settings so it can be tested setd["static_directory"] = os.getcwd() + "/swift_browser_ui_frontend" @@ -34,18 +32,6 @@ async def test_servinit(self): self.assertTrue(app is not None) -class TestServerShutdownHandler(unittest.IsolatedAsyncioTestCase): - """Test case for the server graceful shutdown handler.""" - - async def test_kill_sess_on_shutdown(self): - """Test kill_sess_on_shutdown function.""" - session, req = get_request_with_mock_openstack() - - await kill_sess_on_shutdown(req.app) - - self.assertNotIn(session, req.app["Sessions"]) - - class TestRunServerFunctions(unittest.TestCase): """Test class for server run functions.""" @@ -131,22 +117,30 @@ async def test_working_routes(self): self.assertNotEqual(response.status, 404) response = await self.client.request("GET", "/login/front") self.assertNotEqual(response.status, 404) - response = await self.client.request("GET", "/login/rescope") + response = await self.client.request("GET", "/loginpassword") + self.assertNotEqual(response.status, 404) + response = await self.client.request("GET", "/api/username") + self.assertNotEqual(response.status, 404) + response = await self.client.request("GET", "/api/projects") self.assertNotEqual(response.status, 404) - response = await self.client.request("GET", "/api/buckets") + response = await self.client.request("GET", "/api/test-project") self.assertNotEqual(response.status, 404) - response = await self.client.request("GET", "/api/bucket/objects") + response = await self.client.request("GET", "/api/test-project/acl") self.assertNotEqual(response.status, 404) - response = await self.client.request("GET", "/api/object/dload") + response = await self.client.request("GET", "/api/test-project/address") self.assertNotEqual(response.status, 404) - response = await self.client.request("GET", "/api/username") + response = await self.client.request("GET", "/api/test-project/test-bucket") self.assertNotEqual(response.status, 404) - response = await self.client.request("GET", "/api/projects") + response = await self.client.request( + "GET", "/api/test-project/test-bucket/test-object" + ) self.assertNotEqual(response.status, 404) - response = await self.client.request("GET", "/api/bucket/meta") + response = await self.client.request( + "GET", "/api/meta/test-project/test-bucket" + ) self.assertNotEqual(response.status, 404) response = await self.client.request( "GET", - "/api/project/meta", + "/api/meta/test-project", ) self.assertNotEqual(response.status, 404) diff --git a/tests/ui_unit/test_signature.py b/tests/ui_unit/test_signature.py index e83635d34..4924556bb 100644 --- a/tests/ui_unit/test_signature.py +++ b/tests/ui_unit/test_signature.py @@ -10,19 +10,18 @@ from swift_browser_ui.ui.signature import handle_ext_token_create from swift_browser_ui.ui.signature import handle_ext_token_remove from swift_browser_ui.ui.signature import handle_ext_token_list -from swift_browser_ui.ui.signature import handle_form_post_signature +import tests.common.mockups -class SignatureMiscTestClass(unittest.IsolatedAsyncioTestCase): + +class SignatureMiscTestClass( + tests.common.mockups.APITestBase, +): """Class for testing the signature module misc handlers.""" def setUp(self): """Set up relevant mocks.""" - self.session_check_mock = unittest.mock.Mock() - self.session_check_patch = unittest.mock.patch( - "swift_browser_ui.ui._convenience.session_check", self.session_check_mock - ) - + super().setUp() self.sign_mock = unittest.mock.AsyncMock( return_value={ "valid": 15000000, @@ -33,38 +32,11 @@ def setUp(self): "swift_browser_ui.ui._convenience.sign", self.sign_mock ) - self.api_check_mock = unittest.mock.Mock(return_value="test-session") - self.api_check_patch = unittest.mock.patch( - "swift_browser_ui.ui._convenience.api_check", self.api_check_mock - ) - - self.mock_request = types.SimpleNamespace( - **{ - "query": { - "path": "/test/path", - "count": "60", - }, - "match_info": { - "valid": "600", - "container": "test-container", - }, - "app": { - "Sessions": { - "test-session": { - "ST_conn": None, - "OS_sess": types.SimpleNamespace( - **{ - "get_endpoint": unittest.mock.Mock( - return_value="https://test-endpoint/swift/v1/AUTH_test" # noqa - ) - } - ), - }, - } - }, - "remote": "test-remote", - } - ) + self.mock_request.match_info = {"valid": 600, "count": 60, "project": "test-id-0"} + self.mock_request.query = { + "path": "/test/path", + "count": "60", + } self.get_tempurl_key_mock = unittest.mock.AsyncMock(return_value="test-key") self.get_tempurl_key_patch = unittest.mock.patch( @@ -78,90 +50,38 @@ def setUp(self): } ) + self.p_get_sess = unittest.mock.patch( + "swift_browser_ui.ui.signature.aiohttp_session.get_session", + self.aiohttp_session_get_session_mock, + ) + + self.mock_client_text = "Test token listing." + async def test_handle_signature_request_correct(self): """Test signature request handler.""" - with self.session_check_patch, self.sign_patch: + with self.p_get_sess, self.sign_patch: resp = await handle_signature_request(self.mock_request) - - self.assertIsInstance(resp, aiohttp.web.Response) + self.assertIsInstance(resp, aiohttp.web.Response) async def test_handle_signature_request_fail_no_values(self): """Test signature request handler when failing on client error.""" - with self.session_check_patch, self.sign_patch: - with self.assertRaises(aiohttp.web_exceptions.HTTPClientError): + with self.assertRaises(aiohttp.web_exceptions.HTTPClientError): + with self.p_get_sess, self.sign_patch: await handle_signature_request(self.mock_request_noval) - async def test_handle_form_post_signature_correct(self): - """Test form post signature handler.""" - with self.get_tempurl_key_patch, self.api_check_patch: - resp = await handle_form_post_signature(self.mock_request) - self.assertIsInstance(resp, aiohttp.web.Response) - -class SignatureTokenTestClass(unittest.IsolatedAsyncioTestCase): +class SignatureTokenTestClass( + tests.common.mockups.APITestBase, +): """Class for testing the token creation proxy handlers.""" def setUp(self): """Set up relevant mocks.""" - self.mock_request = types.SimpleNamespace( - **{ - "match_info": {"id": "test-token"}, - "app": { - "Sessions": { - "test-session": { - "active_project": { - "id": "test-project", - }, - }, - }, - "api_client": types.SimpleNamespace( - **{ - "post": unittest.mock.AsyncMock( - return_value=types.SimpleNamespace(**{"status": 200}) - ), - "delete": unittest.mock.AsyncMock(), - "get": unittest.mock.AsyncMock( - return_value=types.SimpleNamespace( - **{ - "text": unittest.mock.AsyncMock( - return_value="test-token" - ) - } - ) - ), - } - ), - }, - } - ) - - self.mock_request_fail_post = types.SimpleNamespace( - **{ - "match_info": {"id": "test-token"}, - "app": { - "Sessions": { - "test-session": { - "active_project": {"id": "test-project"}, - }, - }, - "api_client": types.SimpleNamespace( - **{ - "post": unittest.mock.AsyncMock( - return_value=types.SimpleNamespace( - **{ - "status": 500, - "text": unittest.mock.AsyncMock( - return_value="Error" - ), - "url": "http://example-endpoint", - } - ) - ), - } - ), - }, - } - ) + super().setUp() + self.mock_request.match_info = { + "id": "test-token-id", + "project": "test-id-0", + } self.setd_mock = { "sharing_internal_endpoint": "http://sharing-test-endpoint", @@ -189,52 +109,54 @@ def setUp(self): "swift_browser_ui.ui._convenience.sign", self.sign_mock ) - self.api_check_mock = unittest.mock.Mock(return_value="test-session") - self.api_check_patch = unittest.mock.patch( - "swift_browser_ui.ui._convenience.api_check", self.api_check_mock + self.p_get_sess = unittest.mock.patch( + "swift_browser_ui.ui.signature.aiohttp_session.get_session", + self.aiohttp_session_get_session_mock, ) async def test_handle_ext_token_create_correct(self): """Test external API token creation handler.""" - with self.sign_patch, self.setd_patch, self.api_check_patch: + with self.sign_patch, self.setd_patch, self.p_get_sess: resp = await handle_ext_token_create(self.mock_request) self.assertIsInstance(resp, aiohttp.web.Response) self.assertEqual(resp.status, 201) async def test_handle_ext_token_create_fail_no_api_address(self): """Test external API token creation handler with no API address.""" - with self.sign_patch, self.setd_missing_patch, self.api_check_patch: + with self.sign_patch, self.setd_missing_patch, self.p_get_sess: with self.assertRaises(aiohttp.web.HTTPNotFound): await handle_ext_token_create(self.mock_request) async def test_handle_ext_token_create_fail_token_creation(self): """Test external API token creation handler in case of failure.""" - with self.sign_patch, self.setd_patch, self.api_check_patch: + self.mock_client_response.status = 500 + self.mock_client_response.text.return_value = "Error" + with self.sign_patch, self.setd_patch, self.p_get_sess: with self.assertRaises(aiohttp.web.HTTPInternalServerError): - await handle_ext_token_create(self.mock_request_fail_post) + await handle_ext_token_create(self.mock_request) async def test_handle_ext_token_remove_correct(self): """Test external API token removal handler.""" - with self.sign_patch, self.setd_patch, self.api_check_patch: + with self.sign_patch, self.setd_patch, self.p_get_sess: resp = await handle_ext_token_remove(self.mock_request) self.assertIsInstance(resp, aiohttp.web.Response) self.assertEqual(resp.status, 204) async def test_handle_ext_token_remove_fail_no_api_address(self): """Test external API token creation handler with no API address.""" - with self.sign_patch, self.setd_missing_patch, self.api_check_patch: + with self.sign_patch, self.setd_missing_patch, self.p_get_sess: with self.assertRaises(aiohttp.web.HTTPNotFound): await handle_ext_token_remove(self.mock_request) async def test_handle_ext_token_list_correct(self): """Test external API token listing handler.""" - with self.sign_patch, self.setd_patch, self.api_check_patch: + with self.sign_patch, self.setd_patch, self.p_get_sess: resp = await handle_ext_token_list(self.mock_request) self.assertIsInstance(resp, aiohttp.web.Response) self.assertEqual(resp.status, 200) async def test_handle_ext_token_list_fail_no_api_address(self): """Test external API token listing handler with no API address.""" - with self.sign_patch, self.setd_missing_patch, self.api_check_patch: + with self.sign_patch, self.setd_missing_patch, self.p_get_sess: with self.assertRaises(aiohttp.web.HTTPNotFound): await handle_ext_token_list(self.mock_request) diff --git a/tests/upload/common.py b/tests/upload/common.py deleted file mode 100644 index 2e57bf843..000000000 --- a/tests/upload/common.py +++ /dev/null @@ -1 +0,0 @@ -"""Common test utilities for upload testing.""" diff --git a/tests/upload/test_api.py b/tests/upload/test_api.py index cbd56f8cd..8a99ff1da 100644 --- a/tests/upload/test_api.py +++ b/tests/upload/test_api.py @@ -11,16 +11,17 @@ import tests.common.mockups -class APITestClass(unittest.IsolatedAsyncioTestCase): +class APITestClass(tests.common.mockups.APITestBase): """Test class for swift_browser_ui.upload.api functions.""" def setUp(self) -> None: """.""" - self.request = tests.common.mockups.Mock_Request() - - self.mock_get_auth = unittest.mock.Mock(return_value="auth") - self.patch_get_auth = unittest.mock.patch( - "swift_browser_ui.upload.api.get_auth_instance", self.mock_get_auth + super().setUp() + self.mock_get_session_id = unittest.mock.Mock( + return_value="test-id", + ) + self.p_get_sess = unittest.mock.patch( + "swift_browser_ui.upload.api.get_session_id", self.mock_get_session_id ) self.mock_upload_instance = types.SimpleNamespace( @@ -66,26 +67,19 @@ def setUp(self) -> None: ) self.mock_init_download = unittest.mock.Mock(return_value=self.mock_download) - return super().setUp() - async def test_handle_get_object(self): """Test swift_browser_ui.upload.api.handle_get_object.""" - req = tests.common.mockups.Mock_Request() - req.set_match( - { - "project": "test-project", - "container": "test-container", - "object_name": "test-object", - } - ) + self.mock_request.match_info["project"] = "test-project" + self.mock_request.match_info["container"] = "test-container" + self.mock_request.match_info["object_name"] = "test-object" patch_init_download = unittest.mock.patch( "swift_browser_ui.upload.api.FileDownloadProxy", self.mock_init_download, ) - with patch_init_download, self.patch_get_auth, self.patch_streamresponse: - resp = await swift_browser_ui.upload.api.handle_get_object(req) + with patch_init_download, self.p_get_sess, self.patch_streamresponse: + resp = await swift_browser_ui.upload.api.handle_get_object(self.mock_request) self.assertIs(resp, self.mock_response) self.mock_a_begin.assert_called_once_with( @@ -106,21 +100,21 @@ async def test_handle_replicate_container(self): "swift_browser_ui.upload.api.ObjectReplicationProxy", mock_init_replicator ) - req = tests.common.mockups.Mock_Request() - req.set_match({"project": "test-project", "container": "test-container"}) - req.set_query( - {"from_project": "other-project", "from_container": "source-container"} - ) - req.app["client"] = "client" + self.mock_request.query["from_project"] = "other-project" + self.mock_request.query["from_container"] = "source-container" + self.mock_request.match_info["project"] = "test-project" + self.mock_request.match_info["container"] = "test-container" - with self.patch_get_auth, patch_replicator: - resp = await swift_browser_ui.upload.api.handle_replicate_container(req) + with self.p_get_sess, patch_replicator: + resp = await swift_browser_ui.upload.api.handle_replicate_container( + self.mock_request, + ) self.assertIsInstance(resp, aiohttp.web.Response) self.assertEqual(resp.status, 202) mock_init_replicator.assert_called_once_with( - "auth", - "client", + "placeholder", + self.mock_client, "test-project", "test-container", "other-project", @@ -137,25 +131,22 @@ async def test_handle_replicate_object(self): "swift_browser_ui.upload.api.ObjectReplicationProxy", mock_init_replicator ) - req = tests.common.mockups.Mock_Request() - req.set_match({"project": "test-project", "container": "test-container"}) - req.set_query( - { - "from_project": "other-project", - "from_container": "source-container", - "from_object": "source-object", - } - ) - req.app["client"] = "client" + self.mock_request.match_info["project"] = "test-project" + self.mock_request.match_info["container"] = "test-container" + self.mock_request.query["from_project"] = "other-project" + self.mock_request.query["from_container"] = "source-container" + self.mock_request.query["from_object"] = "source-object" - with self.patch_get_auth, patch_replicator: - resp = await swift_browser_ui.upload.api.handle_replicate_object(req) + with self.p_get_sess, patch_replicator: + resp = await swift_browser_ui.upload.api.handle_replicate_object( + self.mock_request, + ) self.assertIsInstance(resp, aiohttp.web.Response) self.assertEqual(resp.status, 202) mock_init_replicator.assert_called_once_with( - "auth", - "client", + "placeholder", + self.mock_client, "test-project", "test-container", "other-project", @@ -217,12 +208,12 @@ async def test_handle_get_object_chunk(self): req = tests.common.mockups.Mock_Request() req.set_match({"project": "test-project", "container": "test-container"}) - with self.assertRaises(aiohttp.web.HTTPBadRequest), self.patch_get_auth: + with self.assertRaises(aiohttp.web.HTTPBadRequest), self.p_get_sess: await swift_browser_ui.upload.api.handle_get_object_chunk(req) req.set_query({"resumableChunkNumber": 100}) - with self.patch_get_auth, self.patch_get_upload_instance: + with self.p_get_sess, self.patch_get_upload_instance: resp = await swift_browser_ui.upload.api.handle_get_object_chunk(req) self.assertEqual(resp, "check-success") @@ -238,32 +229,36 @@ async def test_handle_post_object_options(self): async def test_handle_get_container(self): """Test swift_browser_ui.upload.api.handle_get_container.""" # Handle edge case of uploaded object chunk check - req = tests.common.mockups.Mock_Request() - req.set_query({"resumableChunkNumber": 1}) + self.mock_request.match_info["project"] = "test-project" + self.mock_request.match_info["container"] = "test-container" + self.mock_request.query["resumableChunkNumber"] = 1 + mock_get_object_chunk = unittest.mock.AsyncMock(return_value="get-chunk-success") patch_get_object_chunk = unittest.mock.patch( "swift_browser_ui.upload.api.handle_get_object_chunk", mock_get_object_chunk ) with patch_get_object_chunk: - resp = await swift_browser_ui.upload.api.handle_get_container(req) + resp = await swift_browser_ui.upload.api.handle_get_container( + self.mock_request, + ) self.assertEqual(resp, "get-chunk-success") # Test normal behaviour - req = tests.common.mockups.Mock_Request() - req.set_match({"project": "test-project", "container": "test-container"}) - + self.mock_request.query.pop("resumableChunkNumber") patch_init_download = unittest.mock.patch( "swift_browser_ui.upload.api.ContainerArchiveDownloadProxy", self.mock_init_download, ) - with self.patch_get_auth, self.patch_streamresponse, patch_init_download: - resp = await swift_browser_ui.upload.api.handle_get_container(req) + with self.p_get_sess, self.patch_streamresponse, patch_init_download: + resp = await swift_browser_ui.upload.api.handle_get_container( + self.mock_request, + ) self.assertIs(resp, self.mock_response) self.mock_download.a_write_to_response.assert_called_once() self.mock_init_download.assert_called_once_with( - "auth", "test-project", "test-container" + "placeholder", "test-project", "test-container" ) self.assertEqual(resp.headers["Content-Type"], "application/x-tar") self.assertIsNotNone(resp.headers["Content-Disposition"]) diff --git a/tests/upload/test_auth.py b/tests/upload/test_auth.py index 831f2d8bc..1c1342a2d 100644 --- a/tests/upload/test_auth.py +++ b/tests/upload/test_auth.py @@ -9,41 +9,69 @@ import tests.common.mockups -class AuthTestClass(unittest.IsolatedAsyncioTestCase): +class AuthTestClass(tests.common.mockups.APITestBase): """Test class for swift_browser_ui.upload.auth functions.""" def setUp(self): """.""" - self.initiate_mock = unittest.mock.Mock(return_value="OS_Session") - self.patch_initiate = unittest.mock.patch( - "swift_browser_ui.upload.auth.initiate_os_session", - self.initiate_mock, - ) super().setUp() async def test_handle_login(self): """Test swift_browser_ui.upload.auth.handle_login.""" - req = tests.common.mockups.Mock_Request() - with self.assertRaises(aiohttp.web.HTTPUnauthorized): - await swift_browser_ui.upload.auth.handle_login(req) - - req.set_match( - { - "project": "test-project", - } + await swift_browser_ui.upload.auth.handle_login(self.mock_request) + + self.mock_request.post.return_value = { + "token": "test-token", + } + + self.mock_client_response.headers["X-Subject-Token"] = "test-token" # nosec + self.mock_client_json = { + "token": { + "user": { + "name": "test-user", + }, + "catalog": [ + { + "type": "object-store", + "id": "test-id", + "name": "swift", + "endpoints": [ + { + "region_id": "default", + "url": "https://test-swift:443/swift/v1/AUTH_test-id-0", + "region": "default", + "interface": "admin", + "id": "test-id", + }, + { + "region_id": "default", + "url": "https://test-swift:443/swift/v1/AUTH_test-id-0", + "region": "default", + "interface": "public", + "id": "test-id", + }, + { + "region_id": "default", + "url": "https://test-swift:443/swift/v1/AUTH_test-id-0", + "region": "default", + "interface": "internal", + "id": "test-id", + }, + ], + }, + ], + }, + } + self.mock_client_response.json = unittest.mock.AsyncMock( + return_value=self.mock_client_json, ) - req.set_post( - { - "token": "test-token", - } - ) - with self.patch_initiate: - resp = await swift_browser_ui.upload.auth.handle_login(req) - self.assertIsNotNone(resp.cookies["RUNNER_SESSION_ID"]) - self.assertEqual(resp.status, 200) - session_key = resp.cookies["RUNNER_SESSION_ID"].value - self.assertEqual(req.app[session_key]["auth"], "OS_Session") + + resp = await swift_browser_ui.upload.auth.handle_login(self.mock_request) + self.assertIsNotNone(resp.cookies["RUNNER_SESSION_ID"]) + self.assertEqual(resp.status, 200) + session_key = resp.cookies["RUNNER_SESSION_ID"].value + self.assertIsNotNone(self.mock_request.app[session_key]) async def test_handle_validate_authentication(self): """Test swift_browser_ui.upload.auth.handle_validate_authentication.""" diff --git a/tests/upload/test_common.py b/tests/upload/test_common.py index 705d7143f..3723bafa6 100644 --- a/tests/upload/test_common.py +++ b/tests/upload/test_common.py @@ -39,9 +39,10 @@ async def test_generate_download_url(self): async def test_get_download_host(self): """Test get_download_host function.""" - auth = tests.common.mockups.Mock_Session() - - ret = swift_browser_ui.upload.common.get_download_host(auth, "AUTH_testproject") + ret = swift_browser_ui.upload.common.get_download_host( + "https://test-endpoint:443/v1/AUTH_notwhatwewant", + "AUTH_testproject", + ) self.assertIn("AUTH_testproject", ret) @@ -82,7 +83,6 @@ async def test_get_upload_instance(self): req.app["client"] = None req.app["test-session"] = {} req.app["test-session"]["uploads"] = {} - req.app["test-session"]["auth"] = tests.common.mockups.Mock_Session() req.set_query({"session": "test-session"}) query = {