graphcore-kernel 0.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (343) hide show
  1. graphcore/__init__.py +5 -0
  2. graphcore/agent_frontend/__init__.py +8 -0
  3. graphcore/agent_frontend/api.py +69 -0
  4. graphcore/agent_frontend/base/__init__.py +11 -0
  5. graphcore/agent_frontend/base/views.py +167 -0
  6. graphcore/agent_frontend/client.py +31 -0
  7. graphcore/agent_frontend/context.py +157 -0
  8. graphcore/agent_frontend/errors.py +12 -0
  9. graphcore/agent_frontend/loading.py +54 -0
  10. graphcore/agent_frontend/registry.py +42 -0
  11. graphcore/agent_frontend/render.py +207 -0
  12. graphcore/agent_frontend/server.py +103 -0
  13. graphcore/agent_frontend/signatures.py +35 -0
  14. graphcore/agent_frontend/testing.py +45 -0
  15. graphcore/agent_frontend/tests/__init__.py +0 -0
  16. graphcore/agent_frontend/tests/fakes.py +114 -0
  17. graphcore/agent_frontend/tests/test_frontend.py +447 -0
  18. graphcore/agent_frontend/tests/test_loading.py +83 -0
  19. graphcore/agent_frontend/tests/test_server.py +109 -0
  20. graphcore/agent_frontend/tools.py +137 -0
  21. graphcore/api/__init__.py +4 -0
  22. graphcore/api/graph_api.py +378 -0
  23. graphcore/api/predicate_codec.py +81 -0
  24. graphcore/api/tests/__init__.py +0 -0
  25. graphcore/api/tests/test_changed_entities.py +109 -0
  26. graphcore/api/tests/test_graph_api.py +290 -0
  27. graphcore/api/tests/test_graph_api_access.py +94 -0
  28. graphcore/api/tests/test_graph_api_grants.py +90 -0
  29. graphcore/api/tests/test_predicate_codec.py +83 -0
  30. graphcore/api/tests/test_subtree_query.py +79 -0
  31. graphcore/apps.py +71 -0
  32. graphcore/auth/__init__.py +1 -0
  33. graphcore/auth/authn/README.md +178 -0
  34. graphcore/auth/authn/__init__.py +3 -0
  35. graphcore/auth/authn/authenticator.py +120 -0
  36. graphcore/auth/authn/onboarding.py +105 -0
  37. graphcore/auth/authn/principals.py +20 -0
  38. graphcore/auth/authn/resource_metadata.py +43 -0
  39. graphcore/auth/authn/service_accounts.py +96 -0
  40. graphcore/auth/authn/testing.py +96 -0
  41. graphcore/auth/authn/tests/__init__.py +0 -0
  42. graphcore/auth/authn/tests/test_authenticator.py +145 -0
  43. graphcore/auth/authn/tests/test_onboarding.py +145 -0
  44. graphcore/auth/authn/tests/test_service_accounts.py +180 -0
  45. graphcore/auth/authn/users.py +59 -0
  46. graphcore/auth/authz/__init__.py +0 -0
  47. graphcore/auth/authz/access_port.py +120 -0
  48. graphcore/auth/authz/adapter/__init__.py +0 -0
  49. graphcore/auth/authz/adapter/default_access_adapter.py +556 -0
  50. graphcore/auth/authz/adapter/tests/__init__.py +0 -0
  51. graphcore/auth/authz/adapter/tests/test_default_adapter.py +543 -0
  52. graphcore/auth/authz/adapter/tests/test_entity_write_hooks.py +207 -0
  53. graphcore/auth/authz/adapter/tests/test_group_types.py +70 -0
  54. graphcore/auth/authz/adapter/tests/test_sync_support.py +209 -0
  55. graphcore/auth/authz/defaults.py +26 -0
  56. graphcore/auth/authz/kernel_policy.py +191 -0
  57. graphcore/auth/authz/kernel_writes.py +31 -0
  58. graphcore/auth/authz/lookups.py +25 -0
  59. graphcore/auth/authz/policy.py +403 -0
  60. graphcore/auth/authz/tests/__init__.py +0 -0
  61. graphcore/auth/authz/tests/test_can_contain.py +150 -0
  62. graphcore/auth/authz/tests/test_contained_by.py +167 -0
  63. graphcore/auth/authz/tests/test_creation.py +391 -0
  64. graphcore/auth/authz/tests/test_delete_permission.py +82 -0
  65. graphcore/auth/authz/tests/test_granted_to_me.py +160 -0
  66. graphcore/auth/authz/tests/test_integration.py +637 -0
  67. graphcore/auth/authz/tests/test_invites.py +184 -0
  68. graphcore/auth/authz/tests/test_kernel_policy.py +140 -0
  69. graphcore/auth/authz/tests/test_lockout.py +132 -0
  70. graphcore/auth/authz/tests/test_policy.py +329 -0
  71. graphcore/auth/authz/tests/test_primitives.py +73 -0
  72. graphcore/auth/authz/tests/test_principal_creation.py +62 -0
  73. graphcore/bootstrap/__init__.py +0 -0
  74. graphcore/bootstrap/deployment.py +67 -0
  75. graphcore/bootstrap/signals.py +16 -0
  76. graphcore/bootstrap/tests/__init__.py +0 -0
  77. graphcore/bootstrap/tests/test_deployment_seed.py +154 -0
  78. graphcore/broadcast/__init__.py +4 -0
  79. graphcore/broadcast/broadcaster.py +201 -0
  80. graphcore/broadcast/channels.py +56 -0
  81. graphcore/broadcast/tests/__init__.py +0 -0
  82. graphcore/broadcast/tests/test_broadcaster.py +444 -0
  83. graphcore/celery.py +14 -0
  84. graphcore/docs/AGENT_FRONTEND_TDD.md +389 -0
  85. graphcore/docs/ARCHITECTURE_PRINCIPLES.md +152 -0
  86. graphcore/docs/AUTHORIZATION_TECHNICAL_TDD.md +1379 -0
  87. graphcore/docs/ENTITY_REFERENCE_TDD.md +561 -0
  88. graphcore/docs/GRAPHAPI_FRONT_DOOR.md +173 -0
  89. graphcore/docs/RUNTIME.md +90 -0
  90. graphcore/docs/SCHEDULING_TDD.md +244 -0
  91. graphcore/docs/STRATEGY_EXECUTION_TDD.md +1043 -0
  92. graphcore/docs/VIEW_ENTITY_TDD.md +522 -0
  93. graphcore/docs/VIEW_SYSTEM_TDD.md +307 -0
  94. graphcore/docs/__init__.py +0 -0
  95. graphcore/docs/doc_topics.py +97 -0
  96. graphcore/docs/docs_discovery.py +64 -0
  97. graphcore/docs/public_api.py +56 -0
  98. graphcore/domain/__init__.py +0 -0
  99. graphcore/domain/entity/Entity.py +204 -0
  100. graphcore/domain/entity/__init__.py +0 -0
  101. graphcore/domain/entity/deployment/Deployment.py +25 -0
  102. graphcore/domain/entity/deployment/__init__.py +0 -0
  103. graphcore/domain/entity/grant/Grant.py +31 -0
  104. graphcore/domain/entity/grant/__init__.py +0 -0
  105. graphcore/domain/entity/group/Group.py +48 -0
  106. graphcore/domain/entity/group/README.md +88 -0
  107. graphcore/domain/entity/group/__init__.py +0 -0
  108. graphcore/domain/entity/invite/Invite.py +31 -0
  109. graphcore/domain/entity/invite/__init__.py +0 -0
  110. graphcore/domain/entity/request_template/RequestTemplate.py +48 -0
  111. graphcore/domain/entity/request_template/__init__.py +0 -0
  112. graphcore/domain/entity/request_template/tests/__init__.py +0 -0
  113. graphcore/domain/entity/request_template/tests/test_request_template.py +52 -0
  114. graphcore/domain/entity/service_account/ServiceAccount.py +41 -0
  115. graphcore/domain/entity/service_account/__init__.py +0 -0
  116. graphcore/domain/entity/strategy_request/StrategyRequest.py +61 -0
  117. graphcore/domain/entity/strategy_request/__init__.py +0 -0
  118. graphcore/domain/entity/strategy_request/tests/__init__.py +0 -0
  119. graphcore/domain/entity/strategy_request/tests/test_strategy_request_entity.py +35 -0
  120. graphcore/domain/entity/tests/__init__.py +0 -0
  121. graphcore/domain/entity/tests/test_entity.py +227 -0
  122. graphcore/domain/entity/tests/test_grant_group_entities.py +36 -0
  123. graphcore/domain/entity/tests/test_write_once_fields.py +98 -0
  124. graphcore/domain/entity/user/User.py +39 -0
  125. graphcore/domain/entity/user/__init__.py +0 -0
  126. graphcore/domain/entity/user/tests/__init__.py +0 -0
  127. graphcore/domain/entity/user/tests/test_user_entity.py +33 -0
  128. graphcore/domain/entity/view/View.py +37 -0
  129. graphcore/domain/entity/view/__init__.py +0 -0
  130. graphcore/domain/entity/view/position.py +78 -0
  131. graphcore/domain/entity/view/tests/__init__.py +0 -0
  132. graphcore/domain/entity/view/tests/test_position.py +71 -0
  133. graphcore/domain/entity/view/tests/test_view_entity.py +134 -0
  134. graphcore/domain/strategy/BaseStrategy.py +759 -0
  135. graphcore/domain/strategy/DeploymentStrategies.py +55 -0
  136. graphcore/domain/strategy/GrantStrategies.py +189 -0
  137. graphcore/domain/strategy/GroupStrategies.py +193 -0
  138. graphcore/domain/strategy/InviteStrategies.py +84 -0
  139. graphcore/domain/strategy/RequestTemplateStrategies.py +126 -0
  140. graphcore/domain/strategy/ViewStrategies.py +219 -0
  141. graphcore/domain/strategy/__init__.py +0 -0
  142. graphcore/domain/strategy/runner.py +84 -0
  143. graphcore/domain/strategy/session.py +56 -0
  144. graphcore/domain/strategy/tests/BaseStrategyTest.py +167 -0
  145. graphcore/domain/strategy/tests/__init__.py +0 -0
  146. graphcore/domain/strategy/tests/test_BaseStrategies.py +870 -0
  147. graphcore/domain/strategy/tests/test_grant_strategies.py +245 -0
  148. graphcore/domain/strategy/tests/test_group_strategies.py +99 -0
  149. graphcore/domain/strategy/tests/test_runner.py +220 -0
  150. graphcore/domain/strategy/tests/test_strategy_locks.py +446 -0
  151. graphcore/domain/strategy/tests/test_utils.py +95 -0
  152. graphcore/domain/strategy/tests/test_view_strategies.py +436 -0
  153. graphcore/errors.py +145 -0
  154. graphcore/execution/README.md +97 -0
  155. graphcore/execution/StrategyExecutorService.py +333 -0
  156. graphcore/execution/__init__.py +0 -0
  157. graphcore/execution/dispatcher.py +19 -0
  158. graphcore/execution/environments/__init__.py +0 -0
  159. graphcore/execution/environments/celery.py +59 -0
  160. graphcore/execution/environments/in_process.py +55 -0
  161. graphcore/execution/local_session.py +117 -0
  162. graphcore/execution/redis_run_events.py +74 -0
  163. graphcore/execution/requests.py +22 -0
  164. graphcore/execution/run_events.py +85 -0
  165. graphcore/execution/strategy_context.py +54 -0
  166. graphcore/execution/tasks.py +34 -0
  167. graphcore/execution/tests/__init__.py +5 -0
  168. graphcore/execution/tests/contract.py +171 -0
  169. graphcore/execution/tests/support.py +310 -0
  170. graphcore/execution/tests/test_dispatchers.py +76 -0
  171. graphcore/execution/tests/test_executor.py +368 -0
  172. graphcore/execution/tests/test_local_session.py +95 -0
  173. graphcore/execution/tests/test_reconcile_runs.py +134 -0
  174. graphcore/execution/tests/test_run_events.py +106 -0
  175. graphcore/execution/tests/test_strategy_context.py +62 -0
  176. graphcore/gateway/__init__.py +1 -0
  177. graphcore/gateway/remote.py +35 -0
  178. graphcore/gateway/tests/__init__.py +0 -0
  179. graphcore/gateway/tests/test_remote.py +30 -0
  180. graphcore/graph/EntityService.py +710 -0
  181. graphcore/graph/__init__.py +0 -0
  182. graphcore/graph/entity_cache.py +152 -0
  183. graphcore/graph/tests/__init__.py +4 -0
  184. graphcore/graph/tests/test_EntityService.py +908 -0
  185. graphcore/graph/tests/test_EntityService_list.py +170 -0
  186. graphcore/graph/tests/test_EntityService_model_resolution.py +339 -0
  187. graphcore/graph/tests/test_EntityService_referrers.py +236 -0
  188. graphcore/graph/tests/test_EntityService_routing.py +119 -0
  189. graphcore/graph/tests/test_dependent_on.py +141 -0
  190. graphcore/graph/tests/test_engine_is_type_agnostic.py +25 -0
  191. graphcore/graph/tests/test_engine_resolves_read_permission.py +93 -0
  192. graphcore/graph/tests/test_entity_cache.py +159 -0
  193. graphcore/graph/tests/test_null_entity_cache.py +12 -0
  194. graphcore/management/__init__.py +0 -0
  195. graphcore/management/commands/__init__.py +0 -0
  196. graphcore/management/commands/dev_reset.py +18 -0
  197. graphcore/management/commands/graphcore_createadmin.py +65 -0
  198. graphcore/management/commands/graphcore_policy.py +59 -0
  199. graphcore/management/commands/graphcore_status.py +98 -0
  200. graphcore/management/tests/__init__.py +0 -0
  201. graphcore/management/tests/test_createadmin.py +78 -0
  202. graphcore/management/tests/test_policy_command.py +46 -0
  203. graphcore/management/tests/test_status_command.py +85 -0
  204. graphcore/migrations/0001_initial.py +186 -0
  205. graphcore/migrations/0002_invite.py +26 -0
  206. graphcore/migrations/__init__.py +0 -0
  207. graphcore/models.py +11 -0
  208. graphcore/persistence/ENTITY_REPOSITORY_TECHNICAL_TDD.md +396 -0
  209. graphcore/persistence/__init__.py +6 -0
  210. graphcore/persistence/django/__init__.py +0 -0
  211. graphcore/persistence/django/backends.py +43 -0
  212. graphcore/persistence/django/bindings.py +28 -0
  213. graphcore/persistence/django/cache.py +38 -0
  214. graphcore/persistence/django/compiler.py +214 -0
  215. graphcore/persistence/django/identity.py +18 -0
  216. graphcore/persistence/django/models.py +252 -0
  217. graphcore/persistence/django/repository.py +525 -0
  218. graphcore/persistence/django/tests/__init__.py +0 -0
  219. graphcore/persistence/django/tests/test_backends.py +68 -0
  220. graphcore/persistence/django/tests/test_compiler.py +269 -0
  221. graphcore/persistence/django/tests/test_repository.py +472 -0
  222. graphcore/persistence/django/tests/test_shared_column.py +120 -0
  223. graphcore/persistence/django/tests/test_threads.py +50 -0
  224. graphcore/persistence/django/tests/test_update_shape.py +175 -0
  225. graphcore/persistence/django/threads.py +38 -0
  226. graphcore/persistence/repository.py +172 -0
  227. graphcore/persistence/tests/__init__.py +0 -0
  228. graphcore/persistence/tests/contract.py +688 -0
  229. graphcore/persistence/tests/evaluate.py +51 -0
  230. graphcore/persistence/tests/fixtures.py +32 -0
  231. graphcore/persistence/tests/memory.py +263 -0
  232. graphcore/persistence/tests/test_memory_repository.py +10 -0
  233. graphcore/persistence/tests/test_query_types.py +127 -0
  234. graphcore/public/__init__.py +9 -0
  235. graphcore/public/api.py +9 -0
  236. graphcore/public/apps.py +10 -0
  237. graphcore/public/auth/__init__.py +1 -0
  238. graphcore/public/auth/grants.py +7 -0
  239. graphcore/public/auth/onboarding.py +8 -0
  240. graphcore/public/auth/perms.py +7 -0
  241. graphcore/public/auth/policy.py +10 -0
  242. graphcore/public/auth/roles.py +8 -0
  243. graphcore/public/auth/subjects.py +7 -0
  244. graphcore/public/entities/__init__.py +32 -0
  245. graphcore/public/errors.py +19 -0
  246. graphcore/public/persistence/__init__.py +44 -0
  247. graphcore/public/persistence/django.py +24 -0
  248. graphcore/public/scheduling.py +23 -0
  249. graphcore/public/strategies/__init__.py +85 -0
  250. graphcore/public/test_settings.py +16 -0
  251. graphcore/public/testing.py +47 -0
  252. graphcore/registry/EntityDirectory.py +246 -0
  253. graphcore/registry/README.md +147 -0
  254. graphcore/registry/StrategyDirectory.py +308 -0
  255. graphcore/registry/TYPE_METADATA_PLACEMENT.md +66 -0
  256. graphcore/registry/__init__.py +0 -0
  257. graphcore/registry/app_discovery.py +108 -0
  258. graphcore/registry/decorators.py +77 -0
  259. graphcore/registry/discovery.py +111 -0
  260. graphcore/registry/registry.py +79 -0
  261. graphcore/registry/tests/__init__.py +0 -0
  262. graphcore/registry/tests/test_agent_frontend_discovery.py +56 -0
  263. graphcore/registry/tests/test_app_config.py +36 -0
  264. graphcore/registry/tests/test_discovery.py +147 -0
  265. graphcore/registry/tests/test_entity_directory_storage.py +73 -0
  266. graphcore/registry/tests/test_import_package.py +87 -0
  267. graphcore/registry/tests/test_principal_flag.py +67 -0
  268. graphcore/registry/tests/test_strategy_directory.py +29 -0
  269. graphcore/routes/__init__.py +116 -0
  270. graphcore/routes/tests/__init__.py +0 -0
  271. graphcore/routes/tests/test_routes.py +90 -0
  272. graphcore/runtime.py +243 -0
  273. graphcore/scheduling/__init__.py +0 -0
  274. graphcore/scheduling/beat_scheduler.py +164 -0
  275. graphcore/scheduling/beat_tasks.py +63 -0
  276. graphcore/scheduling/scheduler.py +37 -0
  277. graphcore/scheduling/tests/__init__.py +0 -0
  278. graphcore/scheduling/tests/contract.py +136 -0
  279. graphcore/scheduling/tests/memory.py +42 -0
  280. graphcore/scheduling/tests/test_beat_scheduler.py +87 -0
  281. graphcore/scheduling/tests/test_memory_scheduler.py +15 -0
  282. graphcore/scheduling/tests/test_ticks.py +143 -0
  283. graphcore/tasks.py +9 -0
  284. graphcore/test_settings.py +78 -0
  285. graphcore/testing/__init__.py +0 -0
  286. graphcore/testing/case.py +112 -0
  287. graphcore/testing/runner.py +32 -0
  288. graphcore/testing/settings.py +26 -0
  289. graphcore/testing/tests/__init__.py +0 -0
  290. graphcore/testing/tests/agent_view_fixture.py +19 -0
  291. graphcore/testing/tests/test_case_and_runner.py +219 -0
  292. graphcore/testing/tests/test_settings_for_apps.py +50 -0
  293. graphcore/tests/__init__.py +0 -0
  294. graphcore/tests/ids.py +14 -0
  295. graphcore/tests/public_api_manifest.py +102 -0
  296. graphcore/tests/runs.py +7 -0
  297. graphcore/tests/test_app_discovery.py +90 -0
  298. graphcore/tests/test_composition_boundaries.py +231 -0
  299. graphcore/tests/test_docs_discovery.py +108 -0
  300. graphcore/tests/test_no_print.py +70 -0
  301. graphcore/tests/test_packaging.py +64 -0
  302. graphcore/tests/test_public_api_boundaries.py +229 -0
  303. graphcore/tests/test_public_api_contract.py +62 -0
  304. graphcore/tests/test_public_api_docs.py +28 -0
  305. graphcore/tests/test_runtime.py +42 -0
  306. graphcore/tests/test_shared_type_boundaries.py +128 -0
  307. graphcore/tests/test_shared_types.py +144 -0
  308. graphcore/tests/test_test_settings.py +45 -0
  309. graphcore/transport/__init__.py +0 -0
  310. graphcore/transport/agent_asgi.py +68 -0
  311. graphcore/transport/agent_client.py +85 -0
  312. graphcore/transport/channel_layer.py +68 -0
  313. graphcore/transport/consumers.py +507 -0
  314. graphcore/transport/routing.py +6 -0
  315. graphcore/transport/tests/__init__.py +0 -0
  316. graphcore/transport/tests/test_agent_client.py +31 -0
  317. graphcore/transport/tests/test_api_views.py +733 -0
  318. graphcore/transport/tests/test_channel_layer.py +96 -0
  319. graphcore/transport/tests/test_consumers.py +963 -0
  320. graphcore/transport/tests/test_resource_metadata.py +67 -0
  321. graphcore/transport/urls.py +29 -0
  322. graphcore/transport/views.py +358 -0
  323. graphcore/types/__init__.py +4 -0
  324. graphcore/types/access.py +114 -0
  325. graphcore/types/api.py +76 -0
  326. graphcore/types/entities.py +100 -0
  327. graphcore/types/entity_id.py +85 -0
  328. graphcore/types/execution.py +41 -0
  329. graphcore/types/identity.py +20 -0
  330. graphcore/types/onboarding.py +20 -0
  331. graphcore/types/query.py +116 -0
  332. graphcore/types/schedules.py +91 -0
  333. graphcore/types/strategy.py +73 -0
  334. graphcore/types/tests/__init__.py +0 -0
  335. graphcore/types/tests/test_entity_id.py +50 -0
  336. graphcore/urls.py +5 -0
  337. graphcore_kernel-0.1.0.dist-info/METADATA +94 -0
  338. graphcore_kernel-0.1.0.dist-info/RECORD +343 -0
  339. graphcore_kernel-0.1.0.dist-info/WHEEL +5 -0
  340. graphcore_kernel-0.1.0.dist-info/entry_points.txt +2 -0
  341. graphcore_kernel-0.1.0.dist-info/licenses/LICENSE +202 -0
  342. graphcore_kernel-0.1.0.dist-info/licenses/NOTICE +2 -0
  343. graphcore_kernel-0.1.0.dist-info/top_level.txt +1 -0
@@ -0,0 +1,444 @@
1
+ """Step 9: Broadcaster - all delivery mechanics (channel naming, publish,
2
+ presence). Uses a fake AccessPort so these tests exercise only the
3
+ broadcaster's own logic, not the adapter's scopes()/covers() queries (see
4
+ access/tests/test_sync_support.py for those). Exercised against
5
+ `ChannelsBroadcaster` - the only concrete implementation - but every
6
+ assertion is about `Broadcaster`'s engine-neutral routing."""
7
+ import asyncio
8
+ from types import SimpleNamespace
9
+
10
+ from channels.layers import get_channel_layer
11
+ from django.test import SimpleTestCase, TransactionTestCase
12
+
13
+ from graphcore.registry.registry import DEFAULT_REGISTRY
14
+ from graphcore.types.access import AccessChange, ManageAccess, Read
15
+ from graphcore.auth.authz.defaults import ADMIN, EDITOR, VIEWER
16
+ from graphcore.broadcast.channels import ChannelsBroadcaster, owner_channel, scope_channel
17
+ from graphcore.tests.ids import fixture_id
18
+ from graphcore.types.entities import view_etag
19
+ from graphcore.types.entity_id import new_entity_id
20
+
21
+
22
+ def _wire(view: dict) -> dict:
23
+ return {**view, 'etag': view_etag(view)}
24
+
25
+
26
+ class FakeAccessAdapter:
27
+ """Returns whatever scopes/covers the test configures, independent of
28
+ any registered entity type or persisted grant."""
29
+
30
+ def __init__(self, scopes=None, covers=None, owners=None, allows=False, holders=None, everyone=False):
31
+ self._scopes = scopes if scopes is not None else set()
32
+ self._covers = covers if covers is not None else set()
33
+ self._owners = owners if owners is not None else set()
34
+ self._allows = allows
35
+ self._holders = holders if holders is not None else set()
36
+ self._everyone = everyone
37
+ self.asked_perms = []
38
+
39
+ async def scopes(self, entity_id, ancestor_ids):
40
+ return self._scopes
41
+
42
+ async def covers(self, subject_id, principal_ids):
43
+ return self._covers
44
+
45
+ async def allows(self, principal, perm, entity_id):
46
+ self.asked_perms.append(perm)
47
+ return self._allows
48
+
49
+ async def owner_principals(self, resource_ids):
50
+ return self._owners
51
+
52
+ async def holders(self, perm, scope_ids):
53
+ return set(self._holders), self._everyone
54
+
55
+
56
+ class BroadcasterTestCase(TransactionTestCase):
57
+ def setUp(self):
58
+ self.channel_layer = get_channel_layer()
59
+
60
+ def _make_broadcaster(self, **adapter_kwargs) -> ChannelsBroadcaster:
61
+ return ChannelsBroadcaster(
62
+ FakeAccessAdapter(**adapter_kwargs), DEFAULT_REGISTRY, channel_layer=self.channel_layer,
63
+ )
64
+
65
+ async def _assert_nothing_received(self, channel_name: str) -> None:
66
+ with self.assertRaises(asyncio.TimeoutError):
67
+ await asyncio.wait_for(self.channel_layer.receive(channel_name), timeout=0.1)
68
+
69
+
70
+ class ChannelNameTests(SimpleTestCase):
71
+ """Channels rejects a group name outside `[a-zA-Z0-9\-_.]`, and an entity
72
+ identifier carries `:` and `/`."""
73
+
74
+ def test_a_channel_name_is_a_legal_group_name(self):
75
+ for name in (scope_channel(fixture_id()),
76
+ owner_channel(fixture_id())):
77
+ with self.subTest(name=name):
78
+ self.assertRegex(name, r'^[a-zA-Z0-9\-_.]+$')
79
+ self.assertLess(len(name), 100)
80
+
81
+ def test_distinct_identifiers_never_share_a_channel(self):
82
+ first, second = fixture_id(), fixture_id()
83
+
84
+ self.assertNotEqual(scope_channel(first), scope_channel(second))
85
+
86
+ def test_a_non_identifier_subject_still_names_a_channel(self):
87
+ self.assertEqual(owner_channel('*'), 'owner__')
88
+
89
+
90
+ class PublishSaveTests(BroadcasterTestCase):
91
+ async def test_sends_to_owner_channel(self):
92
+ broadcaster = self._make_broadcaster(scopes={'scope-a'}, owners={'alice'})
93
+ channel = await self.channel_layer.new_channel()
94
+ await self.channel_layer.group_add(owner_channel('alice'), channel)
95
+
96
+ entity = SimpleNamespace(
97
+ entity_id='e1', entity_type_id='test.Thing', ancestor_ids=(),
98
+ to_client=lambda: {'id': 'e1'},
99
+ )
100
+ await broadcaster.publish_save(entity)
101
+
102
+ message = await self.channel_layer.receive(channel)
103
+ self.assertEqual(message['entities'], {'e1': _wire({'id': 'e1'})})
104
+
105
+ async def test_sends_to_every_scope_channel(self):
106
+ broadcaster = self._make_broadcaster(scopes={'scope-a', 'scope-b'})
107
+ channel_a = await self.channel_layer.new_channel()
108
+ channel_b = await self.channel_layer.new_channel()
109
+ await self.channel_layer.group_add(scope_channel('scope-a'), channel_a)
110
+ await self.channel_layer.group_add(scope_channel('scope-b'), channel_b)
111
+
112
+ entity = SimpleNamespace(entity_id='e1', entity_type_id='test.Thing', ancestor_ids=(), to_client=lambda: {'id': 'e1'})
113
+ await broadcaster.publish_save(entity)
114
+
115
+ msg_a = await self.channel_layer.receive(channel_a)
116
+ msg_b = await self.channel_layer.receive(channel_b)
117
+ self.assertEqual(msg_a['entities'], {'e1': _wire({'id': 'e1'})})
118
+ self.assertEqual(msg_b['entities'], {'e1': _wire({'id': 'e1'})})
119
+
120
+ async def test_does_not_send_to_public_by_default(self):
121
+ broadcaster = self._make_broadcaster(scopes={'scope-a'})
122
+ public_channel = await self.channel_layer.new_channel()
123
+ await self.channel_layer.group_add('public', public_channel)
124
+
125
+ entity = SimpleNamespace(entity_id='e1', entity_type_id='test.Thing', ancestor_ids=(), to_client=lambda: {'id': 'e1'})
126
+ await broadcaster.publish_save(entity)
127
+
128
+ await self._assert_nothing_received(public_channel)
129
+
130
+
131
+ class PublishDeleteTests(BroadcasterTestCase):
132
+ async def test_sends_tombstone_to_owner_channel(self):
133
+ broadcaster = self._make_broadcaster(scopes={'e1'}, owners={'alice'})
134
+ owner = await self.channel_layer.new_channel()
135
+ await self.channel_layer.group_add(owner_channel('alice'), owner)
136
+
137
+ entity = SimpleNamespace(
138
+ entity_id='e1', entity_type_id='test.Thing', ancestor_ids=(), owner='alice',
139
+ )
140
+ await broadcaster.publish_delete(entity)
141
+
142
+ message = await self.channel_layer.receive(owner)
143
+ self.assertTrue(message['entities']['e1']['deleted'])
144
+
145
+ async def test_sends_tombstone_to_scope_channels(self):
146
+ broadcaster = self._make_broadcaster(scopes={'scope-a'})
147
+ channel_a = await self.channel_layer.new_channel()
148
+ await self.channel_layer.group_add(scope_channel('scope-a'), channel_a)
149
+
150
+ entity = SimpleNamespace(entity_id='e1', entity_type_id='test.Thing', ancestor_ids=())
151
+ await broadcaster.publish_delete(entity)
152
+
153
+ message = await self.channel_layer.receive(channel_a)
154
+ self.assertEqual(message['entities']['e1']['deleted'], True)
155
+
156
+
157
+ class GrantRoutingTests(BroadcasterTestCase):
158
+ """A grant is read with ManageAccess, so it goes to the principals who
159
+ hold that, never to the Read-carrying scope channels."""
160
+
161
+ def _grant(self):
162
+ return SimpleNamespace(
163
+ entity_id='g1', entity_type_id='graphcore.Grant', ancestor_ids=('scope-a',),
164
+ parent_id='scope-a', owner=None, to_client=lambda: {'id': 'g1'},
165
+ )
166
+
167
+ async def test_a_grant_save_reaches_only_the_holders(self):
168
+ broadcaster = self._make_broadcaster(scopes={'scope-a'}, owners={'alice'}, holders={'bob'})
169
+ holder = await self.channel_layer.new_channel()
170
+ owner = await self.channel_layer.new_channel()
171
+ scope = await self.channel_layer.new_channel()
172
+ await self.channel_layer.group_add(owner_channel('bob'), holder)
173
+ await self.channel_layer.group_add(owner_channel('alice'), owner)
174
+ await self.channel_layer.group_add(scope_channel('scope-a'), scope)
175
+
176
+ await broadcaster.publish_save(self._grant())
177
+
178
+ message = await self.channel_layer.receive(holder)
179
+ self.assertEqual(message['entities'], {'g1': _wire({'id': 'g1'})})
180
+ await self._assert_nothing_received(owner)
181
+ await self._assert_nothing_received(scope)
182
+
183
+ async def test_a_grant_tombstone_reaches_holders_and_readers(self):
184
+ broadcaster = self._make_broadcaster(scopes={'scope-a'}, holders={'bob'})
185
+ holder = await self.channel_layer.new_channel()
186
+ scope = await self.channel_layer.new_channel()
187
+ await self.channel_layer.group_add(owner_channel('bob'), holder)
188
+ await self.channel_layer.group_add(scope_channel('scope-a'), scope)
189
+
190
+ await broadcaster.publish_delete(self._grant())
191
+
192
+ self.assertTrue((await self.channel_layer.receive(holder))['entities']['g1']['deleted'])
193
+ self.assertTrue((await self.channel_layer.receive(scope))['entities']['g1']['deleted'])
194
+
195
+ async def test_a_grant_everyone_can_manage_goes_to_public(self):
196
+ # Other tests leave full channels in the shared in-memory `public` group.
197
+ await self.channel_layer.flush()
198
+ broadcaster = self._make_broadcaster(scopes={'scope-a'}, everyone=True)
199
+ public = await self.channel_layer.new_channel()
200
+ await self.channel_layer.group_add('public', public)
201
+
202
+ await broadcaster.publish_save(self._grant())
203
+
204
+ self.assertEqual((await self.channel_layer.receive(public))['entities'], {'g1': _wire({'id': 'g1'})})
205
+
206
+ async def test_a_type_readable_by_the_public_goes_to_public(self):
207
+ # Other tests leave full channels in the shared in-memory `public` group.
208
+ await self.channel_layer.flush()
209
+ from graphcore.domain.entity.Entity import Entity
210
+ from graphcore.types.access import ManageAccess
211
+
212
+ registry = DEFAULT_REGISTRY.fork_open()
213
+ secret = type('_PublicSecret', (Entity,), {})
214
+ registry.entities.register_entity(secret, app_label='broadcasttest')
215
+ registry.policy.define(secret, read=ManageAccess(), public=[ManageAccess()])
216
+ broadcaster = ChannelsBroadcaster(
217
+ FakeAccessAdapter(scopes={'s1'}), registry, channel_layer=self.channel_layer,
218
+ )
219
+ public = await self.channel_layer.new_channel()
220
+ await self.channel_layer.group_add('public', public)
221
+
222
+ await broadcaster.publish_save(SimpleNamespace(
223
+ entity_id='s1', entity_type_id=registry.entities.get_entity_type_id(secret),
224
+ ancestor_ids=(), to_client=lambda: {'id': 's1'},
225
+ ))
226
+
227
+ self.assertEqual((await self.channel_layer.receive(public))['entities'], {'s1': _wire({'id': 's1'})})
228
+
229
+
230
+ class CountingAccessAdapter(FakeAccessAdapter):
231
+ def __init__(self, **kwargs):
232
+ super().__init__(**kwargs)
233
+ self.calls = []
234
+
235
+ async def scopes(self, entity_id, ancestor_ids):
236
+ self.calls.append('scopes')
237
+ return await super().scopes(entity_id, ancestor_ids)
238
+
239
+ async def owner_principals(self, resource_ids):
240
+ self.calls.append('owner_principals')
241
+ return await super().owner_principals(resource_ids)
242
+
243
+
244
+ class PublishReferenceChangesTests(BroadcasterTestCase):
245
+ """Routed on the source, so a target's readers never learn about a
246
+ source they cannot see - and routed once per save, however many
247
+ references it changed."""
248
+
249
+ SOURCE = SimpleNamespace(
250
+ entity_id='source-1', entity_type_id='test.Thing', ancestor_ids=(), owner='alice',
251
+ )
252
+
253
+ def _counting_broadcaster(self, **adapter_kwargs):
254
+ access = CountingAccessAdapter(**adapter_kwargs)
255
+ return ChannelsBroadcaster(access, DEFAULT_REGISTRY, channel_layer=self.channel_layer), access
256
+
257
+ @staticmethod
258
+ def _message(target, change):
259
+ return {
260
+ 'type': 'reference_update', 'target_entity_id': target,
261
+ 'source_entity_id': 'source-1', 'change': change,
262
+ }
263
+
264
+ async def test_sends_every_change_to_the_sources_scope_and_owner(self):
265
+ broadcaster = self._make_broadcaster(scopes={'source-scope'}, owners=set())
266
+ scope = await self.channel_layer.new_channel()
267
+ owner = await self.channel_layer.new_channel()
268
+ await self.channel_layer.group_add(scope_channel('source-scope'), scope)
269
+ await self.channel_layer.group_add(owner_channel('alice'), owner)
270
+
271
+ await broadcaster.publish_reference_changes(
272
+ self.SOURCE, added=['target-1', 'target-2'], removed=['target-3'],
273
+ )
274
+
275
+ for channel in (scope, owner):
276
+ received = [await self.channel_layer.receive(channel) for _ in range(3)]
277
+ self.assertEqual(received, [
278
+ self._message('target-1', 'added'),
279
+ self._message('target-2', 'added'),
280
+ self._message('target-3', 'removed'),
281
+ ])
282
+
283
+ async def test_never_sends_to_a_targets_scope(self):
284
+ broadcaster = self._make_broadcaster(scopes={'source-scope'})
285
+ target_channel = await self.channel_layer.new_channel()
286
+ await self.channel_layer.group_add(scope_channel('target-1'), target_channel)
287
+
288
+ await broadcaster.publish_reference_changes(self.SOURCE, added=[], removed=['target-1'])
289
+
290
+ await self._assert_nothing_received(target_channel)
291
+
292
+ async def test_resolves_recipients_once_per_save(self):
293
+ broadcaster, access = self._counting_broadcaster(scopes={'source-scope'})
294
+
295
+ await broadcaster.publish_reference_changes(
296
+ self.SOURCE, added=['target-1', 'target-2'], removed=['target-3'],
297
+ )
298
+
299
+ self.assertEqual(sorted(access.calls), ['owner_principals', 'scopes'])
300
+
301
+ async def test_no_changes_sends_nothing_and_resolves_nothing(self):
302
+ broadcaster, access = self._counting_broadcaster(scopes={'source-scope'})
303
+ scope = await self.channel_layer.new_channel()
304
+ await self.channel_layer.group_add(scope_channel('source-scope'), scope)
305
+
306
+ await broadcaster.publish_reference_changes(self.SOURCE, added=[], removed=[])
307
+
308
+ self.assertEqual(access.calls, [])
309
+ await self._assert_nothing_received(scope)
310
+
311
+
312
+ class PublishAccessChangeTests(BroadcasterTestCase):
313
+ async def test_fresh_grant_joins_scope_and_notifies(self):
314
+ broadcaster = self._make_broadcaster(covers={'alice'})
315
+ channel_name = await self.channel_layer.new_channel()
316
+ broadcaster.register_connection('alice', channel_name)
317
+
318
+ change = AccessChange(resource_id='res-1', subject_id='alice', old_role=None, new_role=VIEWER)
319
+ await broadcaster.publish_access_change(change)
320
+
321
+ message = await self.channel_layer.receive(channel_name)
322
+ self.assertEqual(message['type'], 'access_granted')
323
+ self.assertEqual(message['resource_id'], 'res-1')
324
+
325
+ # The join took effect - a subsequent save to that scope now reaches alice.
326
+ await self.channel_layer.group_send(scope_channel('res-1'), {'type': 'entity_update', 'entities': {}})
327
+ joined_message = await self.channel_layer.receive(channel_name)
328
+ self.assertEqual(joined_message['type'], 'entity_update')
329
+
330
+ async def test_revoke_leaves_scope_and_notifies(self):
331
+ broadcaster = self._make_broadcaster(covers={'alice'})
332
+ channel_name = await self.channel_layer.new_channel()
333
+ broadcaster.register_connection('alice', channel_name)
334
+ await self.channel_layer.group_add(scope_channel('res-1'), channel_name)
335
+
336
+ change = AccessChange(resource_id='res-1', subject_id='alice', old_role=EDITOR, new_role=None)
337
+ await broadcaster.publish_access_change(change)
338
+
339
+ message = await self.channel_layer.receive(channel_name)
340
+ self.assertEqual(message['type'], 'access_revoked')
341
+
342
+ # The leave took effect - a subsequent save to that scope no longer reaches alice.
343
+ await self.channel_layer.group_send(scope_channel('res-1'), {'type': 'entity_update', 'entities': {}})
344
+ await self._assert_nothing_received(channel_name)
345
+
346
+ async def test_revoke_skipped_for_principal_with_independent_access(self):
347
+ """Alice loses this grant (e.g. public read toggled off) but still
348
+ reads the resource via some other grant (e.g. her own direct role)
349
+ - she must not be tombstoned or dropped from the scope channel."""
350
+ broadcaster = self._make_broadcaster(covers={'alice'}, allows=True)
351
+ channel_name = await self.channel_layer.new_channel()
352
+ broadcaster.register_connection('alice', channel_name)
353
+ await self.channel_layer.group_add(scope_channel('res-1'), channel_name)
354
+
355
+ change = AccessChange(resource_id='res-1', subject_id='*', old_role=VIEWER, new_role=None)
356
+ await broadcaster.publish_access_change(change)
357
+
358
+ await self._assert_nothing_received(channel_name)
359
+
360
+ # Still in the scope channel - a subsequent save still reaches her.
361
+ await self.channel_layer.group_send(scope_channel('res-1'), {'type': 'entity_update', 'entities': {}})
362
+ joined_message = await self.channel_layer.receive(channel_name)
363
+ self.assertEqual(joined_message['type'], 'entity_update')
364
+
365
+ async def test_the_revoke_check_asks_for_the_resources_read_permission(self):
366
+ broadcaster = self._make_broadcaster(covers={'alice'}, allows=True)
367
+ channel_name = await self.channel_layer.new_channel()
368
+ broadcaster.register_connection('alice', channel_name)
369
+
370
+ for resource_type_id, expected in (
371
+ ('graphcore.Grant', ManageAccess()),
372
+ ('graphcore.Entity', Read()),
373
+ (None, Read()),
374
+ ):
375
+ broadcaster.access.asked_perms.clear()
376
+ await broadcaster.publish_access_change(AccessChange(
377
+ resource_id='res-1', subject_id='alice', old_role=VIEWER, new_role=None,
378
+ resource_type_id=resource_type_id,
379
+ ))
380
+ with self.subTest(resource_type_id=resource_type_id):
381
+ self.assertEqual(broadcaster.access.asked_perms, [expected])
382
+
383
+ async def test_role_change_notifies_without_join_or_leave(self):
384
+ broadcaster = self._make_broadcaster(covers={'alice'})
385
+ channel_name = await self.channel_layer.new_channel()
386
+ broadcaster.register_connection('alice', channel_name)
387
+
388
+ change = AccessChange(resource_id='res-1', subject_id='alice', old_role=VIEWER, new_role=ADMIN)
389
+ await broadcaster.publish_access_change(change)
390
+
391
+ message = await self.channel_layer.receive(channel_name)
392
+ self.assertEqual(message['type'], 'access_changed')
393
+ self.assertEqual(message['role'], 'admin')
394
+
395
+ async def test_disconnected_principal_receives_nothing(self):
396
+ broadcaster = self._make_broadcaster(covers=set())
397
+ channel_name = await self.channel_layer.new_channel()
398
+ # Not registered as connected.
399
+
400
+ change = AccessChange(resource_id='res-1', subject_id='alice', old_role=None, new_role=VIEWER)
401
+ await broadcaster.publish_access_change(change)
402
+
403
+ await self._assert_nothing_received(channel_name)
404
+
405
+ async def test_no_connected_principals_is_a_noop(self):
406
+ broadcaster = self._make_broadcaster(covers={'alice'})
407
+ change = AccessChange(resource_id='res-1', subject_id='alice', old_role=None, new_role=VIEWER)
408
+ # Should not raise even though covers() is never reached (no connections to test against).
409
+ await broadcaster.publish_access_change(change)
410
+
411
+
412
+ class PresenceRegistryTests(BroadcasterTestCase):
413
+ def test_register_and_deregister_connection(self):
414
+ broadcaster = self._make_broadcaster()
415
+ broadcaster.register_connection('alice', 'channel-1')
416
+ broadcaster.register_connection('alice', 'channel-2')
417
+ self.assertEqual(broadcaster.connected_principals(), ['alice'])
418
+
419
+ broadcaster.deregister_connection('alice', 'channel-1')
420
+ self.assertEqual(broadcaster.connected_principals(), ['alice'])
421
+
422
+ broadcaster.deregister_connection('alice', 'channel-2')
423
+ self.assertEqual(broadcaster.connected_principals(), [])
424
+
425
+ def test_deregister_unknown_connection_is_a_noop(self):
426
+ broadcaster = self._make_broadcaster()
427
+ broadcaster.deregister_connection('nobody', 'channel-x')
428
+
429
+
430
+ class BestEffortDeliveryTests(BroadcasterTestCase):
431
+ async def test_publish_save_swallows_a_missing_channel_layer(self):
432
+ broadcaster = ChannelsBroadcaster(
433
+ FakeAccessAdapter(scopes={'scope-a'}), DEFAULT_REGISTRY, channel_layer=None,
434
+ )
435
+ entity = SimpleNamespace(entity_id='e1', entity_type_id='test.Thing', ancestor_ids=(), to_client=lambda: {'id': 'e1'})
436
+ await broadcaster.publish_save(entity) # must not raise
437
+
438
+ async def test_publish_access_change_swallows_a_missing_channel_layer(self):
439
+ broadcaster = ChannelsBroadcaster(
440
+ FakeAccessAdapter(covers={'alice'}), DEFAULT_REGISTRY, channel_layer=None,
441
+ )
442
+ broadcaster.register_connection('alice', 'channel-1')
443
+ change = AccessChange(resource_id='res-1', subject_id='alice', old_role=None, new_role=VIEWER)
444
+ await broadcaster.publish_access_change(change) # must not raise
graphcore/celery.py ADDED
@@ -0,0 +1,14 @@
1
+ """
2
+ The framework's Celery app.
3
+
4
+ Deployments configure it through their Django settings under the ``CELERY``
5
+ namespace; the generated project's ``manage.py``/``asgi.py`` set
6
+ ``DJANGO_SETTINGS_MODULE`` before this is imported.
7
+ """
8
+
9
+ from celery import Celery
10
+
11
+ app = Celery('graphcore')
12
+ app.conf.beat_scheduler = 'django_celery_beat.schedulers:DatabaseScheduler'
13
+ app.config_from_object('django.conf:settings', namespace='CELERY')
14
+ app.autodiscover_tasks()