-
Notifications
You must be signed in to change notification settings - Fork 31
feat: support kotlin redacted plugin #1594
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
99233c9
fix: align kotlin lang/api version at `2.1`
sgammon da3e233
fix: ship `base` and `core` with non-experimental kotlin
sgammon 2bc1f72
feat: provide `base`, `core`, `test`, as builtins
sgammon 3f9a34b
fix(builder): apply kotlinx serialization by default
sgammon 69dd64b
feat(base): annotations for `Secret` and `Cleartext` data
sgammon fc3ab71
feat: support for redact plugin
sgammon 8d9787e
chore: update `ktjvm` sample with serialization and redaction
sgammon 95218e8
chore: update detekt baselines
sgammon a33080e
chore: update api pins
sgammon File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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
24 changes: 24 additions & 0 deletions
24
packages/base/src/commonMain/kotlin/elide/annotations/Cleartext.kt
This file contains hidden or 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,24 @@ | ||
| /* | ||
| * Copyright (c) 2024 Elide Technologies, Inc. | ||
| * | ||
| * Licensed under the MIT license (the "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * https://opensource.org/license/mit/ | ||
| * | ||
| * 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 elide.annotations | ||
|
|
||
| /** | ||
| * # Annotation: Cleartext | ||
| * | ||
| * Marks a value which holds a non-secret, within the context of a [Secret]; reverses redaction as a result. For example | ||
| * if a full data class is annotated [Secret], [Cleartext] will allow display of one or more individual properties. | ||
| */ | ||
| @Retention(AnnotationRetention.RUNTIME) | ||
| @Target(AnnotationTarget.PROPERTY, AnnotationTarget.CLASS) | ||
| @MustBeDocumented | ||
| public annotation class Cleartext |
27 changes: 27 additions & 0 deletions
27
packages/base/src/commonMain/kotlin/elide/annotations/Secret.kt
This file contains hidden or 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,27 @@ | ||
| /* | ||
| * Copyright (c) 2024 Elide Technologies, Inc. | ||
| * | ||
| * Licensed under the MIT license (the "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * https://opensource.org/license/mit/ | ||
| * | ||
| * 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 elide.annotations | ||
|
|
||
| /** | ||
| * # Annotation: Secret | ||
| * | ||
| * Marks a value which holds some sort of secret or protected material; such material should be redacted from output as | ||
| * much as possible, and otherwise held with care. | ||
| * | ||
| * `Secret` can be applied to properties or classes; in each case, the data associated with the annotated value is | ||
| * withheld from generated output code such as `toString` (where supported). | ||
| */ | ||
| @Retention(AnnotationRetention.RUNTIME) | ||
| @Target(AnnotationTarget.PROPERTY, AnnotationTarget.CLASS) | ||
| @MustBeDocumented | ||
| public annotation class Secret |
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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
17 changes: 15 additions & 2 deletions
17
packages/cli/src/projects/ktjvm/src/main/kotlin/sample/main.kt
This file contains hidden or 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 |
|---|---|---|
| @@ -1,11 +1,24 @@ | ||
| package sample | ||
|
|
||
| import com.google.common.base.Joiner | ||
| import elide.annotations.Secret | ||
| import kotlinx.serialization.Serializable | ||
| import kotlinx.serialization.json.Json | ||
|
|
||
| fun render_greeting(): String { | ||
| @Serializable data class MyCoolData( | ||
| @Secret val name: String, | ||
| ) | ||
|
|
||
| fun renderGreeting(): String { | ||
| return Joiner.on(" ").join("Hello", "World") | ||
| } | ||
|
|
||
| fun renderData(name: String = "World"): MyCoolData { | ||
| return MyCoolData(name = name) | ||
| } | ||
|
|
||
| fun main() { | ||
| println(render_greeting()) | ||
| println(Json.encodeToString(renderData())) | ||
| println(renderData().toString()) | ||
| println(renderGreeting()) | ||
| } |
20 changes: 18 additions & 2 deletions
20
packages/cli/src/projects/ktjvm/src/test/kotlin/sample/testGreeting.kt
This file contains hidden or 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 |
|---|---|---|
| @@ -1,11 +1,27 @@ | ||
| package sample | ||
|
|
||
| import kotlinx.serialization.json.Json | ||
| import kotlin.test.* | ||
|
|
||
| class SampleTest { | ||
| @Test fun testGreeting() { | ||
| val greeting = render_greeting() | ||
| @Test fun `greeting is expected value`() { | ||
| val greeting = renderGreeting() | ||
| assertNotNull(greeting) | ||
| assertEquals("Hello World", greeting) | ||
| } | ||
|
|
||
| @Test fun `kotlinx serialization works`() { | ||
| val data = assertNotNull(renderData()).copy(name = "test") | ||
| val encoded = assertNotNull(Json.encodeToString(data)) | ||
| assertTrue(encoded.isNotEmpty()) | ||
| assertTrue("\"test\"" in encoded) | ||
| val decoded = assertNotNull(Json.decodeFromString<MyCoolData>(encoded)) | ||
| assertEquals("test", decoded.name) | ||
| } | ||
|
|
||
| @Test fun `redaction works`() { | ||
| val data = assertNotNull(renderData()).copy(name = "test") | ||
| val stringForm = assertNotNull(data.toString()) | ||
| assertFalse("test" in stringForm) | ||
| } | ||
| } |
This file contains hidden or 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 hidden or 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 hidden or 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
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.