-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Feature: support
PathConditionMatcher (#48)
* Feature: support `PathConditionMatcher`
- Loading branch information
Showing
9 changed files
with
240 additions
and
5 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
38 changes: 38 additions & 0 deletions
38
cosec-core/src/main/kotlin/me/ahoo/cosec/policy/action/PathPatternParsers.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,38 @@ | ||
| /* | ||
| * Copyright [2021-present] [ahoo wang <[email protected]> (https://github.com/Ahoo-Wang)]. | ||
| * 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 me.ahoo.cosec.policy.action | ||
|
|
||
| import me.ahoo.cosec.api.configuration.Configuration | ||
| import me.ahoo.cosec.policy.condition.part.PathConditionMatcherFactory | ||
| import org.springframework.http.server.PathContainer | ||
| import org.springframework.web.util.pattern.PathPatternParser | ||
|
|
||
| internal object PathPatternParsers { | ||
| fun Configuration.asPathPatternParser(): PathPatternParser { | ||
| val pathConfiguration = get(PathConditionMatcherFactory.TYPE) ?: return PathPatternParser.defaultInstance | ||
| val caseSensitive = | ||
| pathConfiguration.get("caseSensitive")?.asBoolean() ?: PathPatternParser.defaultInstance.isCaseSensitive | ||
| val separator = pathConfiguration.get("separator")?.asString()?.trim() | ||
| ?: PathPatternParser.defaultInstance.pathOptions.separator().toString() | ||
| require(separator.length == 1) { | ||
| "separator must be a single character." | ||
| } | ||
| val decodeAndParseSegments = pathConfiguration.get("decodeAndParseSegments")?.asBoolean() | ||
| ?: PathPatternParser.defaultInstance.pathOptions.shouldDecodeAndParseSegments() | ||
| val parser = PathPatternParser() | ||
| parser.isCaseSensitive = caseSensitive | ||
| parser.pathOptions = PathContainer.Options.create(separator[0], decodeAndParseSegments) | ||
| return parser | ||
| } | ||
| } |
48 changes: 48 additions & 0 deletions
48
cosec-core/src/main/kotlin/me/ahoo/cosec/policy/condition/part/PathConditionMatcher.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,48 @@ | ||
| /* | ||
| * Copyright [2021-present] [ahoo wang <[email protected]> (https://github.com/Ahoo-Wang)]. | ||
| * 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 me.ahoo.cosec.policy.condition.part | ||
|
|
||
| import me.ahoo.cosec.api.configuration.Configuration | ||
| import me.ahoo.cosec.api.policy.ConditionMatcher | ||
| import me.ahoo.cosec.policy.action.PathPatternParsers.asPathPatternParser | ||
| import me.ahoo.cosec.policy.condition.ConditionMatcherFactory | ||
| import me.ahoo.cosec.policy.getMatcherPattern | ||
| import org.springframework.http.server.PathContainer | ||
| import org.springframework.web.util.pattern.PathPattern | ||
|
|
||
| class PathConditionMatcher(configuration: Configuration) : | ||
| PartConditionMatcher(PathConditionMatcherFactory.TYPE, configuration) { | ||
| override val type: String | ||
| get() = PathConditionMatcherFactory.TYPE | ||
| private val pathPattern: PathPattern = configuration.asPathPatternParser().parse(configuration.getMatcherPattern()) | ||
|
|
||
| override fun matchPart(partValue: String): Boolean { | ||
| PathContainer.parsePath(partValue).let { | ||
| return pathPattern.matches(it) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| class PathConditionMatcherFactory : ConditionMatcherFactory { | ||
| companion object { | ||
| const val TYPE = "path" | ||
| } | ||
|
|
||
| override val type: String | ||
| get() = TYPE | ||
|
|
||
| override fun create(configuration: Configuration): ConditionMatcher { | ||
| return PathConditionMatcher(configuration) | ||
| } | ||
| } |
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
63 changes: 63 additions & 0 deletions
63
cosec-core/src/test/kotlin/me/ahoo/cosec/policy/action/PathPatternParsersTest.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,63 @@ | ||
| /* | ||
| * Copyright [2021-present] [ahoo wang <[email protected]> (https://github.com/Ahoo-Wang)]. | ||
| * 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 me.ahoo.cosec.policy.action | ||
|
|
||
| import me.ahoo.cosec.configuration.JsonConfiguration.Companion.asConfiguration | ||
| import me.ahoo.cosec.policy.action.PathPatternParsers.asPathPatternParser | ||
| import me.ahoo.cosec.policy.condition.part.PathConditionMatcherFactory | ||
| import org.hamcrest.MatcherAssert.assertThat | ||
| import org.hamcrest.Matchers.equalTo | ||
| import org.junit.jupiter.api.Test | ||
| import org.springframework.web.util.pattern.PathPatternParser | ||
|
|
||
| class PathPatternParsersTest { | ||
|
|
||
| @Test | ||
| fun asPathPatternParserWhenPathIsNull() { | ||
| assertThat( | ||
| mapOf<String, String>().asConfiguration().asPathPatternParser(), | ||
| equalTo(PathPatternParser.defaultInstance) | ||
| ) | ||
| } | ||
|
|
||
| @Test | ||
| fun asPathPatternParser() { | ||
| val pathPatternParser = mapOf( | ||
| PathConditionMatcherFactory.TYPE to mapOf<String, Any>( | ||
| "caseSensitive" to false, | ||
| "separator" to ".", | ||
| "decodeAndParseSegments" to false | ||
| ) | ||
| ).asConfiguration().asPathPatternParser() | ||
| assertThat(pathPatternParser.isCaseSensitive, equalTo(false)) | ||
| assertThat(pathPatternParser.pathOptions.separator(), equalTo('.')) | ||
| assertThat(pathPatternParser.pathOptions.shouldDecodeAndParseSegments(), equalTo(false)) | ||
| } | ||
|
|
||
| @Test | ||
| fun asPathPatternParserWhenDefault() { | ||
| val pathPatternParser = mapOf( | ||
| PathConditionMatcherFactory.TYPE to mapOf<String, Any>() | ||
| ).asConfiguration().asPathPatternParser() | ||
| assertThat(pathPatternParser.isCaseSensitive, equalTo(PathPatternParser.defaultInstance.isCaseSensitive)) | ||
| assertThat( | ||
| pathPatternParser.pathOptions.separator(), | ||
| equalTo(PathPatternParser.defaultInstance.pathOptions.separator()) | ||
| ) | ||
| assertThat( | ||
| pathPatternParser.pathOptions.shouldDecodeAndParseSegments(), | ||
| equalTo(PathPatternParser.defaultInstance.pathOptions.shouldDecodeAndParseSegments()) | ||
| ) | ||
| } | ||
| } |
50 changes: 50 additions & 0 deletions
50
cosec-core/src/test/kotlin/me/ahoo/cosec/policy/condition/part/PathConditionMatcherTest.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,50 @@ | ||
| /* | ||
| * Copyright [2021-present] [ahoo wang <[email protected]> (https://github.com/Ahoo-Wang)]. | ||
| * 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 me.ahoo.cosec.policy.condition.part | ||
|
|
||
| import io.mockk.every | ||
| import io.mockk.mockk | ||
| import me.ahoo.cosec.api.context.request.Request | ||
| import me.ahoo.cosec.configuration.JsonConfiguration.Companion.asConfiguration | ||
| import me.ahoo.cosec.policy.MATCHER_PATTERN_KEY | ||
| import org.hamcrest.MatcherAssert.assertThat | ||
| import org.hamcrest.Matchers.* | ||
| import org.junit.jupiter.api.Test | ||
|
|
||
| class PathConditionMatcherTest { | ||
| private val conditionMatcher = | ||
| PathConditionMatcherFactory().create( | ||
| mapOf( | ||
| CONDITION_MATCHER_PART_KEY to RequestParts.REMOTE_IP, | ||
| MATCHER_PATTERN_KEY to "192.168.*.*" | ||
| ).asConfiguration() | ||
| ) | ||
|
|
||
| @Test | ||
| fun match() { | ||
| val request: Request = mockk { | ||
| every { remoteIp } returns "192.168.1.1" | ||
| } | ||
| assertThat(conditionMatcher.type, `is`(PathConditionMatcherFactory.TYPE)) | ||
| assertThat(conditionMatcher.match(request, mockk()), `is`(true)) | ||
| } | ||
|
|
||
| @Test | ||
| fun notMatch() { | ||
| val requestNotMatch: Request = mockk { | ||
| every { remoteIp } returns "remoteIp2" | ||
| } | ||
| assertThat(conditionMatcher.match(requestNotMatch, mockk()), `is`(false)) | ||
| } | ||
| } |
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
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
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