warehouse/tests/unit/packaging/test_init.py at 25bc4041168dc0adf8bae53ee86e805f72aae191 · pypi/warehouse · GitHub

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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
# SPDX-License-Identifier: Apache-2.0

import pretend

from celery.schedules import crontab

from warehouse import packaging
from warehouse.accounts.models import Email, User
from warehouse.manage.tasks import update_role_invitation_status
from warehouse.organizations.models import Organization, OrganizationProject
from warehouse.packaging.interfaces import (
    IDocsStorage,
    IFileStorage,
    IProjectService,
    ISimpleStorage,
)
from warehouse.packaging.models import AlternateRepository, File, Project, Release, Role
from warehouse.packaging.services import project_service_factory
from warehouse.packaging.tasks import (
    check_file_cache_tasks_outstanding,
    update_description_html,
)


def test_includeme(monkeypatch):
    storage_class = pretend.stub(
        create_service=pretend.call_recorder(lambda *a, **kw: pretend.stub())
    )

    def key_factory(keystring, iterate_on=None, if_attr_exists=None):
        return pretend.call(
            keystring, iterate_on=iterate_on, if_attr_exists=if_attr_exists
        )

    monkeypatch.setattr(packaging, "key_factory", key_factory)
    settings = {
        "files.backend": "foo.bar",
        "archive_files.backend": "peas.carrots",
        "simple.backend": "bread.butter",
        "docs.backend": "wu.tang",
        "warehouse.packaging.project_create_user_ratelimit_string": "20 per hour",
        "warehouse.packaging.project_create_ip_ratelimit_string": "40 per hour",
    }

    config = pretend.stub(
        maybe_dotted=lambda dotted: storage_class,
        register_service_factory=pretend.call_recorder(
            lambda factory, iface, name=None: None
        ),
        register_rate_limiter=pretend.call_recorder(lambda limit_string, name: None),
        registry=pretend.stub(settings=settings),
        register_origin_cache_keys=pretend.call_recorder(lambda c, **kw: None),
        get_settings=lambda: settings,
        add_periodic_task=pretend.call_recorder(lambda *a, **kw: None),
    )

    packaging.includeme(config)

    assert config.register_service_factory.calls == [
        pretend.call(storage_class.create_service, IFileStorage, name="cache"),
        pretend.call(storage_class.create_service, IFileStorage, name="archive"),
        pretend.call(storage_class.create_service, ISimpleStorage),
        pretend.call(storage_class.create_service, IDocsStorage),
        pretend.call(project_service_factory, IProjectService),
    ]
    assert config.register_rate_limiter.calls == [
        pretend.call("20 per hour", "project.create.user"),
        pretend.call("40 per hour", "project.create.ip"),
    ]
    assert config.register_origin_cache_keys.calls == [
        pretend.call(
            File,
            cache_keys=["project/{obj.release.project.normalized_name}"],
            purge_keys=[key_factory("project/{obj.release.project.normalized_name}")],
        ),
        pretend.call(
            Project,
            cache_keys=["project/{obj.normalized_name}"],
            purge_keys=[
                key_factory("project/{obj.normalized_name}"),
                key_factory("user/{itr.username}", iterate_on="users"),
                key_factory("all-projects"),
                key_factory(
                    "org/{attr.normalized_name}", if_attr_exists="organization"
                ),
            ],
        ),
        pretend.call(
            Release,
            cache_keys=["project/{obj.project.normalized_name}"],
            purge_keys=[
                key_factory("project/{obj.project.normalized_name}"),
                key_factory("user/{itr.username}", iterate_on="project.users"),
                key_factory("all-projects"),
                key_factory(
                    "org/{attr.normalized_name}", if_attr_exists="project.organization"
                ),
            ],
        ),
        pretend.call(
            Role,
            purge_keys=[
                key_factory("user/{obj.user.username}"),
                key_factory("project/{obj.project.normalized_name}"),
            ],
        ),
        pretend.call(User, cache_keys=["user/{obj.username}"]),
        pretend.call(
            User.name,
            purge_keys=[
                key_factory("user/{obj.username}"),
                key_factory("org/{itr.normalized_name}", iterate_on="organizations"),
                key_factory("project/{itr.normalized_name}", iterate_on="projects"),
            ],
        ),
        pretend.call(
            Email.primary,
            purge_keys=[
                key_factory("user/{obj.user.username}"),
                key_factory(
                    "project/{itr.normalized_name}", iterate_on="user.projects"
                ),
            ],
        ),
        pretend.call(
            Organization,
            cache_keys=["org/{obj.normalized_name}"],
            purge_keys=[
                key_factory("org/{obj.normalized_name}"),
            ],
        ),
        pretend.call(
            Organization.name,
            purge_keys=[
                key_factory("user/{itr.username}", iterate_on="users"),
                key_factory("org/{obj.normalized_name}"),
                key_factory("project/{itr.normalized_name}", iterate_on="projects"),
            ],
        ),
        pretend.call(
            Organization.display_name,
            purge_keys=[
                key_factory("user/{itr.username}", iterate_on="users"),
                key_factory("org/{obj.normalized_name}"),
                key_factory("project/{itr.normalized_name}", iterate_on="projects"),
            ],
        ),
        pretend.call(
            AlternateRepository,
            cache_keys=["project/{obj.project.normalized_name}"],
            purge_keys=[
                key_factory("project/{obj.project.normalized_name}"),
            ],
        ),
        pretend.call(
            OrganizationProject,
            purge_keys=[
                key_factory("project/{attr.normalized_name}", if_attr_exists="project"),
                key_factory(
                    "org/{attr.normalized_name}", if_attr_exists="organization"
                ),
            ],
        ),
    ]

    assert (
        pretend.call(crontab(minute="*/1"), check_file_cache_tasks_outstanding)
        in config.add_periodic_task.calls
    )
    assert (
        pretend.call(crontab(minute="*/5"), update_description_html)
        in config.add_periodic_task.calls
    )
    assert (
        pretend.call(crontab(minute="*/5"), update_role_invitation_status)
        in config.add_periodic_task.calls
    )