aboutsummaryrefslogtreecommitdiffstats
path: root/tests/packager/test_manifest.py
blob: 7fa3474d55787eee7cc748cf6d195eba161c67a9 (plain)
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
# Copyright (c) 2018 Intel Corp. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#

import os
import os.path

import pytest

from vnfsdk_pkgtools.packager import manifest

METADATA = '\n'.join(["metadata:",
                      "vnf_product_name: test",
                      "vnf_provider_id: test",
                      "vnf_package_version:1.0",
                      "vnf_release_date_time: 2017-09-15T15:00:10+08:00",
                      ])

METADATA_241 = '\n'.join(["metadata:",
                          "vnf_product_name: test",
                          "vnf_provider_id: test",
                          "vnf_package_version: 1.0",
                          "vnf_release_data_time: 2017-09-15T15:00:10+08:00",
                        ])

METADATA_MISSING_KEY = '\n'.join(["metadata:",
                                   "vnf_product_name: test",
                                   "vnf_provider_id: test",
                                   "vnf_package_version:1.0",
                                ])

METADATA_MISSING = "vnf_product_name: test"

FILE_CONTENT = "needToBeHashed"
FILE_DIGEST = '\n'.join(['Source: digest',
                         'Algorithm: SHA-256',
                         'Hash: 20a480339aa4371099f9503511dcc5a8051ce3884846678ced5611ec64bbfc9c',
                       ])

CMS = '\n'.join(['-----BEGIN CMS-----',
                 'MIICmAYJKoZIhvcNAQcCoIICiTCCAoUCAQExDTALBglghkgBZQMEAgEwCwYJKoZI',
                 'hvcNAQcBMYICYjCCAl4CAQEwUjBFMQswCQYDVQQGEwJQVDEPMA0GA1UECAwGTGlz',
                 'Ym9hMQ8wDQYDVQQHDAZMaXNib2ExFDASBgNVBAoMC0V4YW1wbGUgT3JnAgkA6w7o',
                 '0SBbUUwwCwYJYIZIAWUDBAIBoIHkMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEw',
                 'HAYJKoZIhvcNAQkFMQ8XDTE4MDgyNzAzMjY1MlowLwYJKoZIhvcNAQkEMSIEIFDv',
                 '62qcyvy9rbeUjjg0odflTyXt7GjP7xMyQe/k/joJMHkGCSqGSIb3DQEJDzFsMGow',
                 'CwYJYIZIAWUDBAEqMAsGCWCGSAFlAwQBFjALBglghkgBZQMEAQIwCgYIKoZIhvcN',
                 'AwcwDgYIKoZIhvcNAwICAgCAMA0GCCqGSIb3DQMCAgFAMAcGBSsOAwIHMA0GCCqG',
                 'SIb3DQMCAgEoMA0GCSqGSIb3DQEBAQUABIIBAJzPsQ0tR9O7dXVJ7XywGLKrO/xG',
                 'C9z7EMqxbjCX+bfkGh5b67mSWlHnN2Yox33YBV8cTz/NzHS8UW9x3CTNvt0wJ+5m',
                 'Pcv+3w52XHu67b3LmMiJugpsyEIeB/qm1PzXPAqWAk+figwNtbhw994C6EzPQz+x',
                 'eoS386Bie7kf/y/ac+xWiOdYYdC+SFhbko6sEJSCBzOIs1m3ufrsBukMxhxema5h',
                 'pqE+DUlSFyilc9CQWnSLubkHmM4dZnU7qnNoTBqplDYpOYH3WSNN9Cv322JusAzt',
                 'SzFEv182phI2C5pmjUnf7VG1WMKCH2WNtkYwMUCDcGvbHrh8n+kR8hL/BAs=',
                 '-----END CMS-----',
                ])

FILE_SOURCE_ONLY = '\n'.join(['Source: source1',
                              'Source: source2',
                            ])

NON_MANO_ARTIFACTS = '\n'.join(['non_mano_artifact_sets:',
                                'foo_bar:',
                                'Source: foobar/foo/foo.yaml',
                                'prv.happy-nfv.cool:',
                                'Source: happy/cool/123.html',
                                'Source: happy/cool/cool.json',
                              ])


def test_metadata(tmpdir):
    p = tmpdir.mkdir('csar').join('test.mf')
    p.write(METADATA)

    m = manifest.Manifest(p.dirname, 'test.mf')
    assert m.metadata['vnf_product_name'] == 'test'
    assert m.metadata['vnf_provider_id'] == 'test'
    assert m.metadata['vnf_package_version'] == '1.0'
    assert m.metadata['vnf_release_date_time'] == '2017-09-15T15:00:10+08:00'


def test_metadata_241(tmpdir):
    # metadata for SOL004 v2.4.1
    p = tmpdir.mkdir('csar').join('test.mf')
    p.write(METADATA_241)

    m = manifest.Manifest(p.dirname, 'test.mf')
    assert m.metadata['vnf_product_name'] == 'test'
    assert m.metadata['vnf_provider_id'] == 'test'
    assert m.metadata['vnf_package_version'] == '1.0'
    assert m.metadata['vnf_release_date_time'] == '2017-09-15T15:00:10+08:00'

    m241 = manifest.Manifest(p.dirname, 'test.mf', sol241=True)
    assert METADATA_241 in m241.return_as_string()


def test_metadata_missing_key(tmpdir):
    p = tmpdir.mkdir('csar').join('test.mf')
    p.write(METADATA_MISSING_KEY)

    with pytest.raises(manifest.ManifestException) as excinfo:
        manifest.Manifest(p.dirname, 'test.mf')
    excinfo.match(r"Missing metadata keys:")


def test_missing_metadata(tmpdir):
    p = tmpdir.mkdir('csar').join('test.mf')
    p.write(METADATA_MISSING)

    with pytest.raises(manifest.ManifestException) as excinfo:
        manifest.Manifest(p.dirname, 'test.mf')
    excinfo.match(r"Unrecognized file digest line vnf_product_name: test:")

def test_digest(tmpdir):
    root = tmpdir.mkdir('csar')
    mf = root.join('test.mf')
    digest = root.join('digest')
    mf.write(METADATA + '\n\n' + FILE_DIGEST)
    digest.write(FILE_CONTENT)

    m = manifest.Manifest(mf.dirname, 'test.mf')
    assert m.digests['digest'][0] == "SHA-256"
    assert m.digests['digest'][1] == "20a480339aa4371099f9503511dcc5a8051ce3884846678ced5611ec64bbfc9c"

def test_add_file(tmpdir):
    root = tmpdir.mkdir('csar')
    mf = root.join('test.mf')
    digest = root.join('digest')
    mf.write(METADATA)
    digest.write(FILE_CONTENT)

    m = manifest.Manifest(mf.dirname, 'test.mf')
    m.add_file('digest', 'SHA-256')
    assert m.digests['digest'][0] == "SHA-256"
    assert m.digests['digest'][1] == "20a480339aa4371099f9503511dcc5a8051ce3884846678ced5611ec64bbfc9c"

def test_update_to_file(tmpdir):
    root = tmpdir.mkdir('csar')
    mf = root.join('test.mf')
    digest = root.join('digest')
    mf.write(METADATA + '\n\n' + FILE_DIGEST)
    digest.write(FILE_CONTENT)
    digest2 = root.join('digest2')
    digest2.write(FILE_CONTENT)

    m1 = manifest.Manifest(mf.dirname, 'test.mf')
    m1.add_file('digest2', 'SHA-256')
    m1.signature = CMS
    m1.update_to_file()
    m2 = manifest.Manifest(mf.dirname, 'test.mf')
    assert m1.metadata['vnf_provider_id'] == m2.metadata['vnf_provider_id']
    assert m1.digests['digest'] == m2.digests['digest2']
    assert len(list(m2.digests.keys())) == 2
    assert m2.signature == CMS

def test_signature(tmpdir):
    p = tmpdir.mkdir('csar').join('test.mf')
    p.write(METADATA + "\n\n" + CMS)
    m = manifest.Manifest(p.dirname, 'test.mf')
    assert m.signature == CMS

def test_illegal_signature(tmpdir):
    p = tmpdir.mkdir('csar').join('test.mf')
    p.write(METADATA + "\n\n" + CMS[:-17])
    with pytest.raises(manifest.ManifestException) as excinfo:
        manifest.Manifest(p.dirname, 'test.mf')
    excinfo.match(r"Can NOT find end of sigature block")

def test_signature_strip(tmpdir):
    p = tmpdir.mkdir('csar').join('test.mf')
    p.write(METADATA + "\n\n" + CMS)
    m1 = manifest.Manifest(p.dirname, 'test.mf')
    newfile = m1.save_to_temp_without_cms()
    m2 = manifest.Manifest(os.path.dirname(newfile),
                           os.path.basename(newfile))
    assert m1.metadata == m2.metadata
    assert m2.signature is None
    os.unlink(newfile)

def test_source_only(tmpdir):
    p = tmpdir.mkdir('csar').join('test.mf')
    p.write(METADATA + "\n\n" + FILE_SOURCE_ONLY)
    m = manifest.Manifest(p.dirname, 'test.mf')
    assert 'source1' in m.digests.keys()
    assert 'source2' in m.digests.keys()

def test_non_mano_artifacts(tmpdir, mocker):
    mocker.patch('vnfsdk_pkgtools.packager.utils.check_file_dir')
    p = tmpdir.mkdir('csar').join('test.mf')
    p.write(METADATA + "\n\n" + NON_MANO_ARTIFACTS)
    m = manifest.Manifest(p.dirname, 'test.mf')
    assert 'prv.happy-nfv.cool' in m.non_mano_artifacts.keys()
    assert 'happy/cool/123.html' in m.non_mano_artifacts['prv.happy-nfv.cool']
    output = m.return_as_string()
    assert 'non_mano_artifact_sets:' in output
    assert 'foo_bar:' in output
    assert 'Source: happy/cool/123.html' in output