FilesExpand file tree

 master

/

plugins.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

76 lines (56 loc) · 2.4 KB

 master

/

plugins.py

Copy path

Top

File metadata and controls

• Code
• Blame

76 lines (56 loc) · 2.4 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

import logging

import os

import sys

from pathlib import Path

import yaml

from plux import Plugin

from localstack import config

from localstack.runtime import hooks

from localstack.utils.files import rm_rf

from localstack.utils.ssl import get_cert_pem_file_path

LOG = logging.getLogger(__name__)

@hooks.on_infra_start()

def deprecation_warnings() -> None:

LOG.debug("Checking for the usage of deprecated community features and configs...")

from localstack.deprecations import log_deprecation_warnings

log_deprecation_warnings()

@hooks.on_infra_start(should_load=lambda: config.REMOVE_SSL_CERT)

def delete_cached_certificate():

LOG.debug("Removing the cached local SSL certificate")

target_file = get_cert_pem_file_path()

rm_rf(target_file)

class OASPlugin(Plugin):

"""

This plugin allows to register an arbitrary number of OpenAPI specs, e.g., the spec for the public endpoints

of localstack.core.

The OpenAPIValidator handler uses (as opt-in) all the collected specs to validate the requests and the responses

to these public endpoints.

An OAS plugin assumes the following directory layout.

my_package

├── sub_package

│ ├── __init__.py <-- spec file

│ ├── openapi.yaml

│ └── plugins.py <-- plugins

├── plugins.py <-- plugins

└── openapi.yaml <-- spec file

Each package can have its own OpenAPI yaml spec which is loaded by the correspondent plugin in plugins.py

You can simply create a plugin like the following:

class MyPackageOASPlugin(OASPlugin):

name = "my_package"

The only convention is that plugins.py and openapi.yaml have the same pathname.

"""

namespace = "localstack.openapi.spec"

def __init__(self) -> None:

# By convention a plugins.py is at the same level (i.e., same pathname) of the openapi.yaml file.

# importlib.resources would be a better approach but has issues with namespace packages in editable mode

_module = sys.modules[self.__module__]

self.spec_path = Path(

os.path.join(os.path.dirname(os.path.abspath(_module.__file__)), "openapi.yaml")

)

assert self.spec_path.exists()

self.spec = {}

def load(self):

with self.spec_path.open("r") as f:

self.spec = yaml.safe_load(f)

class CoreOASPlugin(OASPlugin):

name = "localstack"