-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update dependency io.github.detekt.sarif4k:sarif4k to v0.6.0 (#831)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Wendland, Florian <[email protected]> Co-authored-by: Robert Haimerl <[email protected]>
- Loading branch information
3 people
authored
Apr 10, 2024
1 parent
8fa2c53
commit 446b6a3
Showing
9 changed files
with
316 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
282 changes: 282 additions & 0 deletions
282
...kotlin/de/fraunhofer/aisec/codyze/specificationLanguages/coko/dsl/CokoSarifBuilderTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,282 @@ | ||
| /* | ||
| * Copyright (c) 2024, Fraunhofer AISEC. 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. | ||
| */ | ||
| package de.fraunhofer.aisec.codyze.specificationLanguages.coko.dsl | ||
|
|
||
| import de.fraunhofer.aisec.codyze.backends.cpg.CPGConfiguration | ||
| import de.fraunhofer.aisec.codyze.backends.cpg.coko.CokoCpgBackend | ||
| import de.fraunhofer.aisec.codyze.specificationLanguages.coko.core.CokoRule | ||
| import de.fraunhofer.aisec.codyze.specificationLanguages.coko.core.Evaluator | ||
| import de.fraunhofer.aisec.codyze.specificationLanguages.coko.core.dsl.Severity | ||
| import de.fraunhofer.aisec.codyze.specificationLanguages.coko.core.toResultLevel | ||
| import de.fraunhofer.aisec.codyze.specificationLanguages.coko.dsl.host.CokoExecutor | ||
| import de.fraunhofer.aisec.cpg.passes.EdgeCachePass | ||
| import de.fraunhofer.aisec.cpg.passes.UnreachableEOGPass | ||
| import org.junit.jupiter.api.Assertions.* | ||
| import org.junit.jupiter.api.Test | ||
| import kotlin.io.path.toPath | ||
| import kotlin.reflect.KParameter | ||
| import kotlin.reflect.KType | ||
| import kotlin.reflect.KTypeParameter | ||
| import kotlin.reflect.KVisibility | ||
|
|
||
| class CokoSarifBuilderTest { | ||
|
|
||
| private val cpgConfiguration = | ||
| CPGConfiguration( | ||
| source = emptyList(), | ||
| useUnityBuild = false, | ||
| debugParser = false, | ||
| disableCleanup = false, | ||
| codeInNodes = true, | ||
| matchCommentsToNodes = false, | ||
| processAnnotations = false, | ||
| failOnError = false, | ||
| useParallelFrontends = false, | ||
| defaultPasses = true, | ||
| additionalLanguages = setOf(), | ||
| symbols = mapOf(), | ||
| includeBlocklist = listOf(), | ||
| includePaths = listOf(), | ||
| includeAllowlist = listOf(), | ||
| loadIncludes = false, | ||
| passes = listOf(UnreachableEOGPass::class, EdgeCachePass::class), | ||
| ) | ||
|
|
||
| private val cokoRulewithoutRuleAnnotation = object : CokoRule { | ||
| override val annotations: List<Annotation> | ||
| get() = emptyList() | ||
| override val name: String | ||
| get() = "norule" | ||
|
|
||
| // remaining methods are not required in this test | ||
| override val isAbstract: Boolean | ||
| get() = throw UnsupportedOperationException("Not required for this test") | ||
| override val isExternal: Boolean | ||
| get() = throw UnsupportedOperationException("Not required for this test") | ||
| override val isFinal: Boolean | ||
| get() = throw UnsupportedOperationException("Not required for this test") | ||
| override val isInfix: Boolean | ||
| get() = throw UnsupportedOperationException("Not required for this test") | ||
| override val isInline: Boolean | ||
| get() = throw UnsupportedOperationException("Not required for this test") | ||
| override val isOpen: Boolean | ||
| get() = throw UnsupportedOperationException("Not required for this test") | ||
| override val isOperator: Boolean | ||
| get() = throw UnsupportedOperationException("Not required for this test") | ||
| override val isSuspend: Boolean | ||
| get() = throw UnsupportedOperationException("Not required for this test") | ||
| override val parameters: List<KParameter> | ||
| get() = throw UnsupportedOperationException("Not required for this test") | ||
| override val returnType: KType | ||
| get() = throw UnsupportedOperationException("Not required for this test") | ||
| override val typeParameters: List<KTypeParameter> | ||
| get() = throw UnsupportedOperationException("Not required for this test") | ||
| override val visibility: KVisibility? | ||
| get() = throw UnsupportedOperationException("Not required for this test") | ||
|
|
||
| override fun call(vararg args: Any?): Evaluator = | ||
| throw UnsupportedOperationException("Not required for this test") | ||
|
|
||
| override fun callBy(args: Map<KParameter, Any?>): Evaluator = | ||
| throw UnsupportedOperationException("Not required for this test") | ||
| } | ||
|
|
||
| @Test | ||
| fun `test empty rules list causes empty reportingDescriptors list`() { | ||
| val backend = CokoCpgBackend(cpgConfiguration) | ||
| val csb = CokoSarifBuilder(rules = emptyList(), backend = backend) | ||
|
|
||
| assertTrue(csb.reportingDescriptors.isEmpty()) | ||
| } | ||
|
|
||
| @Test | ||
| fun `test spec without rule annotation`() { | ||
| val backend = CokoCpgBackend(cpgConfiguration) | ||
| val csb = CokoSarifBuilder(rules = listOf(cokoRulewithoutRuleAnnotation), backend = backend) | ||
|
|
||
| val reportingDescriptor = csb.reportingDescriptors.first() | ||
| assertNotNull(reportingDescriptor) | ||
| assertNull(reportingDescriptor.shortDescription) | ||
| assertNull(reportingDescriptor.fullDescription) | ||
| assertNull(reportingDescriptor.defaultConfiguration) | ||
| assertNull(reportingDescriptor.help) | ||
| assertNull(reportingDescriptor.properties) | ||
| } | ||
|
|
||
| @Test | ||
| fun `test rule with default shortDescription`() { | ||
| val specFiles = listOfNotNull( | ||
| CokoSarifBuilderTest::class.java.classLoader | ||
| .getResource("sarif/ruledefaults.codyze.kts") | ||
| ).map { it.toURI().toPath() } | ||
|
|
||
| val backend = CokoCpgBackend(cpgConfiguration) | ||
| val specEvaluator = CokoExecutor.compileScriptsIntoSpecEvaluator(backend = backend, specFiles = specFiles) | ||
| val csb = CokoSarifBuilder(rules = specEvaluator.rules, backend = backend) | ||
|
|
||
| val shortDescription = csb.reportingDescriptors.first().shortDescription | ||
| assertNotNull(shortDescription) | ||
| assertTrue(shortDescription?.text!!.isEmpty()) | ||
| } | ||
|
|
||
| @Test | ||
| fun `test rule with some shortDescription`() { | ||
| val specFiles = listOfNotNull( | ||
| CokoSarifBuilderTest::class.java.classLoader | ||
| .getResource("sarif/ruleshortdescription.codyze.kts") | ||
| ).map { it.toURI().toPath() } | ||
|
|
||
| val backend = CokoCpgBackend(cpgConfiguration) | ||
| val specEvaluator = CokoExecutor.compileScriptsIntoSpecEvaluator(backend = backend, specFiles = specFiles) | ||
| val csb = CokoSarifBuilder(rules = specEvaluator.rules, backend = backend) | ||
|
|
||
| val shortDescription = csb.reportingDescriptors.first().shortDescription | ||
| assertNotNull(shortDescription) | ||
| assertEquals(shortDescription?.text, "test") | ||
| } | ||
|
|
||
| @Test | ||
| fun `test rule with default description`() { | ||
| val specFiles = listOfNotNull( | ||
| CokoSarifBuilderTest::class.java.classLoader | ||
| .getResource("sarif/ruledefaults.codyze.kts") | ||
| ).map { it.toURI().toPath() } | ||
|
|
||
| val backend = CokoCpgBackend(cpgConfiguration) | ||
| val specEvaluator = CokoExecutor.compileScriptsIntoSpecEvaluator(backend = backend, specFiles = specFiles) | ||
| val csb = CokoSarifBuilder(rules = specEvaluator.rules, backend = backend) | ||
|
|
||
| val fullDescription = csb.reportingDescriptors.first().fullDescription | ||
| assertNotNull(fullDescription) | ||
| assertTrue(fullDescription?.text!!.isEmpty()) | ||
| } | ||
|
|
||
| @Test | ||
| fun `test rule with some description`() { | ||
| val specFiles = listOfNotNull( | ||
| CokoSarifBuilderTest::class.java.classLoader | ||
| .getResource("sarif/rulefulldescription.codyze.kts") | ||
| ).map { it.toURI().toPath() } | ||
|
|
||
| val backend = CokoCpgBackend(cpgConfiguration) | ||
| val specEvaluator = CokoExecutor.compileScriptsIntoSpecEvaluator(backend = backend, specFiles = specFiles) | ||
| val csb = CokoSarifBuilder(rules = specEvaluator.rules, backend = backend) | ||
|
|
||
| val fullDescription = csb.reportingDescriptors.first().fullDescription | ||
| assertNotNull(fullDescription) | ||
| assertEquals(fullDescription?.text, "some description") | ||
| } | ||
|
|
||
| @Test | ||
| fun `test rule with default severity`() { | ||
| val specFiles = listOfNotNull( | ||
| CokoSarifBuilderTest::class.java.classLoader | ||
| .getResource("sarif/ruledefaults.codyze.kts") | ||
| ).map { it.toURI().toPath() } | ||
|
|
||
| val backend = CokoCpgBackend(cpgConfiguration) | ||
| val specEvaluator = CokoExecutor.compileScriptsIntoSpecEvaluator(backend = backend, specFiles = specFiles) | ||
| val csb = CokoSarifBuilder(rules = specEvaluator.rules, backend = backend) | ||
|
|
||
| val defaultConfiguration = csb.reportingDescriptors.first().defaultConfiguration | ||
| assertNotNull(defaultConfiguration) | ||
|
|
||
| val level = defaultConfiguration?.level | ||
| assertNotNull(level) | ||
| assertTrue(level == Severity.WARNING.toResultLevel()) | ||
| } | ||
|
|
||
| @Test | ||
| fun `test rule with some severity`() { | ||
| val specFiles = listOfNotNull( | ||
| CokoSarifBuilderTest::class.java.classLoader | ||
| .getResource("sarif/ruleseverity.codyze.kts") | ||
| ).map { it.toURI().toPath() } | ||
|
|
||
| val backend = CokoCpgBackend(cpgConfiguration) | ||
| val specEvaluator = CokoExecutor.compileScriptsIntoSpecEvaluator(backend = backend, specFiles = specFiles) | ||
| val csb = CokoSarifBuilder(rules = specEvaluator.rules, backend = backend) | ||
|
|
||
| val defaultConfiguration = csb.reportingDescriptors.first().defaultConfiguration | ||
| assertNotNull(defaultConfiguration) | ||
|
|
||
| val level = defaultConfiguration?.level | ||
| assertNotNull(level) | ||
| assertTrue(level != Severity.WARNING.toResultLevel()) | ||
| } | ||
|
|
||
| @Test | ||
| fun `test rule with default help`() { | ||
| val specFiles = listOfNotNull( | ||
| CokoSarifBuilderTest::class.java.classLoader | ||
| .getResource("sarif/ruledefaults.codyze.kts") | ||
| ).map { it.toURI().toPath() } | ||
|
|
||
| val backend = CokoCpgBackend(cpgConfiguration) | ||
| val specEvaluator = CokoExecutor.compileScriptsIntoSpecEvaluator(backend = backend, specFiles = specFiles) | ||
| val csb = CokoSarifBuilder(rules = specEvaluator.rules, backend = backend) | ||
|
|
||
| val help = csb.reportingDescriptors.first().help | ||
| assertNotNull(help) | ||
| assertTrue(help?.text!!.isEmpty()) | ||
| } | ||
|
|
||
| @Test | ||
| fun `test rule with some help`() { | ||
| val specFiles = listOfNotNull( | ||
| CokoSarifBuilderTest::class.java.classLoader | ||
| .getResource("sarif/rulehelp.codyze.kts") | ||
| ).map { it.toURI().toPath() } | ||
|
|
||
| val backend = CokoCpgBackend(cpgConfiguration) | ||
| val specEvaluator = CokoExecutor.compileScriptsIntoSpecEvaluator(backend = backend, specFiles = specFiles) | ||
| val csb = CokoSarifBuilder(rules = specEvaluator.rules, backend = backend) | ||
|
|
||
| val help = csb.reportingDescriptors.first().help | ||
| assertNotNull(help) | ||
| assertEquals(help?.text, "some help") | ||
| } | ||
|
|
||
| @Test | ||
| fun `test rule with default empty tags`() { | ||
| val specFiles = listOfNotNull( | ||
| CokoSarifBuilderTest::class.java.classLoader | ||
| .getResource("sarif/ruledefaults.codyze.kts") | ||
| ).map { it.toURI().toPath() } | ||
|
|
||
| val backend = CokoCpgBackend(cpgConfiguration) | ||
| val specEvaluator = CokoExecutor.compileScriptsIntoSpecEvaluator(backend = backend, specFiles = specFiles) | ||
| val csb = CokoSarifBuilder(rules = specEvaluator.rules, backend = backend) | ||
|
|
||
| val alternative = csb.reportingDescriptors.first().properties?.tags?.let { assertTrue(it.isEmpty()) } | ||
| assertNotNull(alternative) | ||
| } | ||
|
|
||
| @Test | ||
| fun `test rules with some tags`() { | ||
| val specFiles = listOfNotNull( | ||
| CokoSarifBuilderTest::class.java.classLoader | ||
| .getResource("sarif/ruletags.codyze.kts") | ||
| ).map { it.toURI().toPath() } | ||
|
|
||
| val backend = CokoCpgBackend(cpgConfiguration) | ||
| val specEvaluator = CokoExecutor.compileScriptsIntoSpecEvaluator(backend = backend, specFiles = specFiles) | ||
| val csb = CokoSarifBuilder(rules = specEvaluator.rules, backend = backend) | ||
|
|
||
| val alternative = csb.reportingDescriptors.first().properties?.tags?.let { assertTrue(it.isNotEmpty()) } | ||
| assertNotNull(alternative) | ||
| } | ||
| } |
3 changes: 3 additions & 0 deletions
3
...ze-specification-languages/coko/coko-dsl/src/test/resources/sarif/ruledefaults.codyze.kts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| @Rule() | ||
| fun rule() = | ||
| Unit |
3 changes: 3 additions & 0 deletions
3
...ification-languages/coko/coko-dsl/src/test/resources/sarif/rulefulldescription.codyze.kts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| @Rule(description = "some description") | ||
| fun rule() = | ||
| Unit |
3 changes: 3 additions & 0 deletions
3
codyze-specification-languages/coko/coko-dsl/src/test/resources/sarif/rulehelp.codyze.kts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| @Rule(help = "some help") | ||
| fun rule() = | ||
| Unit |
3 changes: 3 additions & 0 deletions
3
...ze-specification-languages/coko/coko-dsl/src/test/resources/sarif/ruleseverity.codyze.kts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| @Rule(severity = Severity.INFO) | ||
| fun rule() = | ||
| Unit |
3 changes: 3 additions & 0 deletions
3
...fication-languages/coko/coko-dsl/src/test/resources/sarif/ruleshortdescription.codyze.kts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| @Rule(shortDescription = "test") | ||
| fun rule() = | ||
| Unit |
3 changes: 3 additions & 0 deletions
3
codyze-specification-languages/coko/coko-dsl/src/test/resources/sarif/ruletags.codyze.kts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| @Rule(tags = ["one", "two"]) | ||
| fun rule() = | ||
| Unit |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters