File: py_s_TestSslSetup.py

package info (click to toggle)
ecflow 5.15.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 51,868 kB
  • sloc: cpp: 269,341; python: 22,756; sh: 3,609; perl: 770; xml: 333; f90: 204; ansic: 141; makefile: 70
file content (160 lines) | stat: -rw-r--r-- 6,220 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
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
#
# Copyright 2009- ECMWF.
#
# This software is licensed under the terms of the Apache Licence version 2.0
# which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
# In applying this licence, ECMWF does not waive the privileges and immunities
# granted to it by virtue of its status as an intergovernmental organisation
# nor does it submit to any jurisdiction.
#

# This test ensures the SSL setup for the ecFlow client works as expected.

import os

import ecflow_test_util as Test
import inspect

import ecflow as ecf

port = 31415
host = os.uname()[1]


class Tests:

    @staticmethod
    def can_setup_client_without_ssl_and_get_empty_certificate():
        Test.name_this_test()

        expected_crt = ""

        client = ecf.Client(host, port)
        crt = client.get_certificate()
        assert crt is expected_crt, f"Expected certificate to be '{expected_crt}', but got '{crt}'"


    @staticmethod
    def can_setup_client_with_ssl_with_shared_certificate_solely_based_envvars_and_ecf_ssl_empty():
        Test.name_this_test()

        expected_crt = f"server.crt"

        with Test.MockFile(expected_crt) as crt_file:
            with Test.MockEnvironment({"ECF_SSL": "", "ECF_HOST": host, "ECF_PORT": str(port)}) as env:
                client = ecf.Client()
                crt = client.get_certificate()
                assert crt.endswith(expected_crt), f"Expected certificate to end with '{expected_crt}', but got {crt}"

    @staticmethod
    def can_setup_client_with_ssl_with_shared_certificate_solely_based_envvars():
        Test.name_this_test()

        expected_crt = f"server.crt"

        with Test.MockFile(expected_crt) as crt_file:
            with Test.MockEnvironment({"ECF_SSL": "1", "ECF_HOST": host, "ECF_PORT": str(port)}) as env:
                client = ecf.Client()
                crt = client.get_certificate()
                assert crt.endswith(expected_crt), f"Expected certificate to end with '{expected_crt}', but got {crt}"

    @staticmethod
    def can_setup_client_with_ssl_requesting_shared_but_finding_specific_certificate_solely_based_envvars():
        Test.name_this_test()

        expected_crt = f"{host}.{port}.crt"

        with Test.MockFile(expected_crt) as crt_file:
            with Test.MockEnvironment({"ECF_SSL": "1", "ECF_HOST": host, "ECF_PORT": str(port)}) as env:
                client = ecf.Client()
                crt = client.get_certificate()
                assert crt.endswith(expected_crt), f"Expected certificate to end with '{expected_crt}', but got {crt}"

    @staticmethod
    def can_setup_client_with_ssl_with_specific_certificate_solely_based_envvars():
        Test.name_this_test()

        expected_crt = f"{host}.{port}.crt"

        with Test.MockFile(expected_crt) as crt_file:
            with Test.MockEnvironment({"ECF_SSL": "X", "ECF_HOST": host, "ECF_PORT": str(port)}) as env:
                client = ecf.Client()
                crt = client.get_certificate()
                assert crt.endswith(expected_crt), f"Expected certificate to end with '{expected_crt}', but got {crt}"

    @staticmethod
    def can_setup_client_with_ssl_with_shared_certificate_using_envvar():
        Test.name_this_test()

        expected_crt = f"server.crt"

        with Test.MockFile(expected_crt) as crt_file:
            with Test.MockEnvironment({"ECF_SSL": "1"}) as env:
                client = ecf.Client(host, port)
                crt = client.get_certificate()
                assert crt.endswith(expected_crt), f"Expected certificate to end with '{expected_crt}', but got {crt}"

    @staticmethod
    def can_setup_client_with_ssl_with_shared_certificate_using_empty_envvar():
        Test.name_this_test()

        expected_crt = f"server.crt"

        with Test.MockFile(expected_crt) as crt_file:
            with Test.MockEnvironment({"ECF_SSL": ""}) as env:
                client = ecf.Client(host, port)
                crt = client.get_certificate()
                assert crt.endswith(expected_crt), f"Expected certificate to end with '{expected_crt}', but got {crt}"

    @staticmethod
    def can_setup_client_with_ssl_with_shared_certificate_using_explicit_option():
        Test.name_this_test()

        expected_crt = f"server.crt"

        with Test.MockFile(expected_crt) as crt_file:
            client = ecf.Client(host, port)
            client.enable_ssl()
            crt = client.get_certificate()
            assert crt.endswith(expected_crt), f"Expected certificate to end with '{expected_crt}', but got {crt}"

    @staticmethod
    def can_setup_client_with_ssl_with_specific_certificate_using_envvar():
        Test.name_this_test()

        expected_crt = f"{host}.{port}.crt"

        with Test.MockFile(expected_crt) as crt_file:
            with Test.MockEnvironment({"ECF_SSL": "X"}) as env:
                client = ecf.Client(host, port)
                crt = client.get_certificate()
                assert crt.endswith(expected_crt), f"Expected certificate to end with '{expected_crt}', but got {crt}"

    @staticmethod
    def can_setup_client_with_ssl_with_specific_certificate_using_envvar_and_explicit_option():
        Test.name_this_test()

        expected_crt = f"{host}.{port}.crt"

        with Test.MockFile(expected_crt) as crt_file:
            with Test.MockEnvironment({"ECF_SSL": "X"}) as env:
                client = ecf.Client(host, port)
                client.enable_ssl()
                crt = client.get_certificate()
                assert crt.endswith(expected_crt), f"Expected certificate to end with '{expected_crt}', but got {crt}"

    @staticmethod
    def can_setup_client_with_ssl_requesting_shared_certificate_using_envvar_but_falling_back_to_specific_certificate ():
        Test.name_this_test()

        expected_crt = f"{host}.{port}.crt"

        with Test.MockFile(expected_crt) as crt_file:
            with Test.MockEnvironment({"ECF_SSL": "1"}) as env:
                client = ecf.Client(host, port)
                crt = client.get_certificate()
                assert crt.endswith(expected_crt), f"Expected certificate to end with '{expected_crt}', but got {crt}"


if __name__ == "__main__":
    Test.execute_all(Tests)