File: TestGalaxyUsers.py

package info (click to toggle)
python-bioblend 1.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,096 kB
  • sloc: python: 7,596; sh: 219; makefile: 158
file content (126 lines) | stat: -rw-r--r-- 6,369 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
import bioblend.galaxy
from . import (
    GalaxyTestBase,
    test_util,
)


class TestGalaxyUsers(GalaxyTestBase.GalaxyTestBase):
    def test_get_users(self):
        users = self.gi.users.get_users()
        for user in users:
            assert user["id"] is not None
            assert user["email"] is not None

    def test_show_user(self):
        current_user = self.gi.users.get_current_user()
        user = self.gi.users.show_user(current_user["id"])
        assert user["id"] == current_user["id"]
        assert user["username"] == current_user["username"]
        assert user["email"] == current_user["email"]
        # The 2 following tests randomly fail

    #        assert user["nice_total_disk_usage"] == current_user["nice_total_disk_usage"]
    #        assert user["total_disk_usage"] == current_user["total_disk_usage"]

    def test_create_remote_user(self):
        # WARNING: only admins can create users!
        # WARNING: Users cannot be purged through the Galaxy API, so execute
        # this test only on a disposable Galaxy instance!
        if not self.gi.config.get_config()["use_remote_user"]:
            self.skipTest("This Galaxy instance is not configured to use remote users")
        new_user_email = "newuser@example.org"
        user = self.gi.users.create_remote_user(new_user_email)
        assert user["email"] == new_user_email
        if self.gi.config.get_config()["allow_user_deletion"]:
            deleted_user = self.gi.users.delete_user(user["id"])
            assert deleted_user["email"] == new_user_email
            assert deleted_user["deleted"]

    def test_create_local_user(self):
        # WARNING: only admins can create users!
        # WARNING: Users cannot be purged through the Galaxy API, so execute
        # this test only on a disposable Galaxy instance!
        if self.gi.config.get_config()["use_remote_user"]:
            self.skipTest("This Galaxy instance is not configured to use local users")
        new_username = test_util.random_string()
        new_user_email = f"{new_username}@example.org"
        password = test_util.random_string(20)
        new_user = self.gi.users.create_local_user(new_username, new_user_email, password)
        assert new_user["username"] == new_username
        assert new_user["email"] == new_user_email
        # test a BioBlend GalaxyInstance can be created using username+password
        user_gi = bioblend.galaxy.GalaxyInstance(url=self.gi.base_url, email=new_user_email, password=password)
        assert user_gi.users.get_current_user()["email"] == new_user_email
        # test deletion
        if self.gi.config.get_config()["allow_user_deletion"]:
            deleted_user = self.gi.users.delete_user(new_user["id"])
            assert deleted_user["email"] == new_user_email
            assert deleted_user["deleted"]

    def test_get_current_user(self):
        user = self.gi.users.get_current_user()
        assert user["id"] is not None
        assert user["username"] is not None
        assert user["email"] is not None
        assert user["nice_total_disk_usage"] is not None
        assert user["total_disk_usage"] is not None

    def test_update_user(self):
        # WARNING: only admins can create users!
        # WARNING: Users cannot be purged through the Galaxy API, so execute
        # this test only on a disposable Galaxy instance!
        if self.gi.config.get_config()["use_remote_user"]:
            self.skipTest("This Galaxy instance is not configured to use local users")
        new_username = test_util.random_string()
        new_user = self.gi.users.create_local_user(
            new_username, f"{new_username}@example.org", test_util.random_string(20)
        )
        new_user_id = new_user["id"]
        updated_username = test_util.random_string()
        updated_user_email = f"{updated_username}@example.org"
        self.gi.users.update_user(new_user_id, username=updated_username, email=updated_user_email)
        updated_user = self.gi.users.show_user(new_user_id)
        assert updated_user["username"] == updated_username
        assert updated_user["email"] == updated_user_email

        if self.gi.config.get_config()["allow_user_deletion"]:
            self.gi.users.delete_user(new_user_id)

    def test_get_user_apikey(self):
        # Test getting the API key of the current user, which surely has one
        user_id = self.gi.users.get_current_user()["id"]
        apikey = self.gi.users.get_user_apikey(user_id)
        assert apikey and apikey != "Not available."
        # Test getting the API key of a new user, which doesn't have one
        new_username = test_util.random_string()
        new_user_id = self.gi.users.create_local_user(
            new_username, f"{new_username}@example.org", test_util.random_string(20)
        )["id"]
        assert self.gi.users.get_user_apikey(new_user_id) == "Not available."

    @test_util.skip_unless_galaxy("release_21.01")
    def test_get_or_create_user_apikey(self):
        # Check that get_or_create_user_apikey() doesn't regenerate an existing API key
        user_id = self.gi.users.get_current_user()["id"]
        apikey = self.gi.users.get_user_apikey(user_id)
        assert self.gi.users.get_or_create_user_apikey(user_id) == apikey
        # Check that get_or_create_user_apikey() generates an API key for a new user
        new_username = test_util.random_string()
        new_user_id = self.gi.users.create_local_user(
            new_username, f"{new_username}@example.org", test_util.random_string(20)
        )["id"]
        new_apikey = self.gi.users.get_or_create_user_apikey(new_user_id)
        assert new_apikey and new_apikey != "Not available."

    def test_create_user_apikey(self):
        # Test creating an API key for a new user
        new_username = test_util.random_string()
        new_user_id = self.gi.users.create_local_user(
            new_username, f"{new_username}@example.org", test_util.random_string(20)
        )["id"]
        new_apikey = self.gi.users.create_user_apikey(new_user_id)
        assert new_apikey and new_apikey != "Not available."
        # Test regenerating an API key for a user that already has one
        regenerated_apikey = self.gi.users.create_user_apikey(new_user_id)
        assert regenerated_apikey and regenerated_apikey not in (new_apikey, "Not available.")