diff options
author | 2023-02-09 15:51:57 +0000 | |
---|---|---|
committer | 2023-02-13 10:52:27 +0000 | |
commit | 616c359cab363e2ac4b1f3938927a9de661db12e (patch) | |
tree | 952c2882740ae5c207b556e246b80cb7b38da7f2 /cps-rest/src/test | |
parent | db90c8758d43b1daab09c760a3fe3102d772d7df (diff) |
Test for yang file archive limitation
- add new test
- fixed misleading method names
Issue-ID: CPS-1480
Change-Id: I9dd8f41d0acfc8b1c063aab65567d619670f4905
Signed-off-by: halil.cakal <halil.cakal@est.tech>
Diffstat (limited to 'cps-rest/src/test')
3 files changed, 52 insertions, 24 deletions
diff --git a/cps-rest/src/test/groovy/org/onap/cps/rest/utils/MultipartFileUtilSpec.groovy b/cps-rest/src/test/groovy/org/onap/cps/rest/utils/MultipartFileUtilSpec.groovy index 3f4729ec7..67ee50e89 100644 --- a/cps-rest/src/test/groovy/org/onap/cps/rest/utils/MultipartFileUtilSpec.groovy +++ b/cps-rest/src/test/groovy/org/onap/cps/rest/utils/MultipartFileUtilSpec.groovy @@ -1,6 +1,7 @@ /* * ============LICENSE_START======================================================= * Copyright (C) 2020 Pantheon.tech + * Modifications Copyright (C) 2023 Nordix Foundation. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -51,7 +52,7 @@ class MultipartFileUtilSpec extends Specification { def 'Extract yang resources from zip archive.'() { given: 'uploaded zip archive containing 2 yang files and 1 not yang (json) file' def multipartFile = new MockMultipartFile("file", "TEST.ZIP", "application/zip", - getClass().getResource("/yang-files-set.zip").getBytes()) + getClass().getResource("/yang-files-set.zip").getBytes()) when: 'resources are extracted from zip file' def result = MultipartFileUtil.extractYangResourcesMap(multipartFile) then: 'information from yang files is extracted, not yang file (json) is ignored' @@ -60,6 +61,32 @@ class MultipartFileUtilSpec extends Specification { assert result["component.yang"] == "fake component content 1\n" } + def 'Yang file limits in zip archive: #scenario for the bug reported in CPS-1477'() { + given: 'a yang file size (uncompressed) limit of #threshold bytes' + ZipFileSizeValidator.THRESHOLD_SIZE = threshold + and: 'an archive with a yang file of 1083 bytes' + def multipartFile = multipartZipFileFromResource('/yang-files-set-total-1083-bytes.zip') + when: 'attempt to extract yang files' + def thrownException = null + try { + MultipartFileUtil.extractYangResourcesMap(multipartFile) + } catch (Exception e) { + thrownException = e + } + then: 'ModelValidationException indicating size limit is only thrown when threshold exceeded' + if (thresholdExceeded) { + assert thrownException instanceof ModelValidationException + assert thrownException.details.contains('limit of ' + threshold + ' bytes') + } else { + assert thrownException == null + } + where: + scenario | threshold || thresholdExceeded + 'exceed limit' | 1082 || true + 'equals to limit' | 1083 || false + 'within limit' | 1084 || false + } + def 'Extract resources from zip archive having #caseDescriptor.'() { when: 'attempt to extract resources from zip file is performed' MultipartFileUtil.extractYangResourcesMap(multipartFile) @@ -91,7 +118,7 @@ class MultipartFileUtilSpec extends Specification { def multipartZipFileFromResource(resourcePath) { return new MockMultipartFile("file", "TEST.ZIP", "application/zip", - getClass().getResource(resourcePath).getBytes()) + getClass().getResource(resourcePath).getBytes()) } def multipartFileForIOException(extension) { diff --git a/cps-rest/src/test/groovy/org/onap/cps/rest/utils/ZipFileSizeValidatorSpec.groovy b/cps-rest/src/test/groovy/org/onap/cps/rest/utils/ZipFileSizeValidatorSpec.groovy index 16fbf9885..60ecb2e3b 100644 --- a/cps-rest/src/test/groovy/org/onap/cps/rest/utils/ZipFileSizeValidatorSpec.groovy +++ b/cps-rest/src/test/groovy/org/onap/cps/rest/utils/ZipFileSizeValidatorSpec.groovy @@ -1,6 +1,7 @@ /* * ============LICENSE_START======================================================= * Copyright (C) 2021 Bell Canada. + * Modifications Copyright (C) 2023 Nordix Foundation. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -32,25 +33,25 @@ class ZipFileSizeValidatorSpec extends Specification { def compressedFileSize = 100 def setup() { - objectUnderTest.setTotalEntryInArchive(0) - objectUnderTest.setTotalSizeArchive(0) + objectUnderTest.setTotalYangFileEntriesInArchive(0) + objectUnderTest.setTotalUncompressedSizeOfYangFilesInArchive(0) objectUnderTest.setCompressedSize(compressedFileSize) } - def 'Increment the total entries in Archive.'() { - when: 'the totalEntriesInArchive value is incremented' - objectUnderTest.incrementTotalEntryInArchive() - then: 'the totalEntriesInArchive is incremented by 1' - assert objectUnderTest.totalEntryInArchive == old(objectUnderTest.totalEntryInArchive) + 1 + def 'Increment the total yang file entry count in Archive.'() { + when: 'the totalYangFileEntryInArchive value is incremented' + objectUnderTest.incrementTotalYangFileEntryCountInArchive() + then: 'the totalYangFileEntryInArchive is incremented by 1' + assert objectUnderTest.totalYangFileEntriesInArchive == old(objectUnderTest.totalYangFileEntriesInArchive) + 1 } - def 'Update the total size of Archive.'() { + def 'Update the total uncompressed size of yang files in Archive.'() { given: 'the size of an entry of archive' def entrySize = 100 - when: 'the totalSizeArchive is to be updated with the latest entry Size' - objectUnderTest.updateTotalSizeArchive(entrySize) - then: 'the totalSizeArchive is updated as expected' - assert objectUnderTest.totalSizeArchive == old(objectUnderTest.totalSizeArchive) + entrySize + when: 'the totalUncompressedSizeOfYangFilesInArchive is to be updated with the latest entry Size' + objectUnderTest.updateTotalUncompressedSizeOfYangFilesInArchive(entrySize) + then: 'the totalUncompressedSizeOfYangFilesInArchive is updated as expected' + assert objectUnderTest.totalUncompressedSizeOfYangFilesInArchive == old(objectUnderTest.totalUncompressedSizeOfYangFilesInArchive) + entrySize } def 'Validate the zip archive for compression ratio less that threshold compression ratio.'() { @@ -73,29 +74,29 @@ class ZipFileSizeValidatorSpec extends Specification { def 'Validate the zip archive for thresholdSize and thresholdEntries #caseDescriptor.'() { given: - objectUnderTest.setTotalEntryInArchive(totalEntriesInArchive) - objectUnderTest.setTotalSizeArchive(totalSizeArchive) + objectUnderTest.setTotalYangFileEntriesInArchive(totalYangEntriesInArchive) + objectUnderTest.setTotalUncompressedSizeOfYangFilesInArchive(totalUncompressedSizeofYangArchive) when: 'the validation is performed against the threshold size and threshold Entries count' objectUnderTest.validateSizeAndEntries() then: 'validation passes and no exception is thrown' noExceptionThrown() where: 'following cases are tested' - caseDescriptor | totalSizeArchive | totalEntriesInArchive - 'less than threshold value' | thresholdSize - 1 | thresholdEntries - 1 - 'at threshold value' | thresholdSize | thresholdEntries + caseDescriptor | totalUncompressedSizeofYangArchive | totalYangEntriesInArchive + 'less than threshold value' | thresholdSize - 1 | thresholdEntries - 1 + 'at threshold value' | thresholdSize | thresholdEntries } def 'Validate the zip archive for thresholdSize and thresholdEntries with #caseDescriptor.'() { given: - objectUnderTest.setTotalEntryInArchive(totalEntriesInArchive) - objectUnderTest.setTotalSizeArchive(totalSizeArchive) + objectUnderTest.setTotalYangFileEntriesInArchive(totalYangEntriesInArchive) + objectUnderTest.setTotalUncompressedSizeOfYangFilesInArchive(totalUncompressedSizeofYangArchive) when: 'the validation is performed against the threshold size and threshold Entries count' objectUnderTest.validateSizeAndEntries() then: 'validation fails and exception is thrown' thrown ModelValidationException where: 'following cases are tested' - caseDescriptor | totalSizeArchive | totalEntriesInArchive - 'totalEntriesInArchive exceeds threshold value' | thresholdSize | thresholdEntries + 1 - 'totalSizeArchive exceeds threshold value' | thresholdSize + 1 | thresholdEntries + caseDescriptor | totalUncompressedSizeofYangArchive | totalYangEntriesInArchive + 'totalEntriesInArchive exceeds threshold value' | thresholdSize | thresholdEntries + 1 + 'totalSizeArchive exceeds threshold value' | thresholdSize + 1 | thresholdEntries } } diff --git a/cps-rest/src/test/resources/yang-files-set-total-1083-bytes.zip b/cps-rest/src/test/resources/yang-files-set-total-1083-bytes.zip Binary files differnew file mode 100644 index 000000000..9908055e3 --- /dev/null +++ b/cps-rest/src/test/resources/yang-files-set-total-1083-bytes.zip |