Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Reframe sonar user token question #3445

Merged
merged 4 commits into from
Dec 13, 2023
Merged

Reframe sonar user token question #3445

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a4d8af7
reframe sonar user token question
Dec 12, 2023
76542cc
Update changelog #3431
Dec 12, 2023
88cfe2f
Use invalid token in hint #3431
fritschldwg Dec 13, 2023
a239c24
Rename user flag #3431
fritschldwg Dec 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/)

- Multiple values for options need to be separated by comma [#3434](https://github.com/MaibornWolff/codecharta/pull/3434)
- Changed the short-form of the `--no-issues` flag in the SourceCodeParser from `-i` to `-ni` [#3434](https://github.com/MaibornWolff/codecharta/pull/3434)
- Clarify sonar user token question [#3445](https://github.com/MaibornWolff/codecharta/pull/3445)
- Changed the `--user` flag to `--user-token` in SonarImporter [#3445](https://github.com/MaibornWolff/codecharta/pull/3445)

### Fixed 🐞

Expand Down
4 changes: 2 additions & 2 deletions analysis/import/SonarImporter/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ Generates visualisation data from SonarQube data through an API call to a SonarQ
| `--merge-modules` | merges modules in multi-module projects |
| `-nc, --not-compressed` | save uncompressed output File |
| `-o, --output-file=<outputFile>` | output File |
| `-u, --user=<user>` | user token for connecting to remote sonar instance |
| `-u, --user-token=<userToken>` | user token for connecting to remote sonar instance |

```
Usage: ccsh sonarimport [-h] [--merge-modules] [-nc] [-o=<outputFile>]
[-u=<user>] [-m=<metrics>]... URL PROJECT_ID
[-u=<userToken>] [-m=<metrics>]... URL PROJECT_ID
```

## Examples
Expand Down
10 changes: 5 additions & 5 deletions ...t/SonarImporter/src/main/kotlin/de/maibornwolff/codecharta/importer/sonar/ParserDialog.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ class ParserDialog {
hint = "de.foo:bar"
)

val user: String = KInquirer.promptInput(
message = "What is the sonar.login for connecting to the remote sonar instance?",
hint = "c123d456"
)
val userToken: String = KInquirer.promptInput(
message = "What is the sonar user token (sonar.login) required to connect to the remote Sonar instance?",
hint = "sqp_0a81f6490875e062f79ccdeace23ac3c68dac6e"
)

val outputFileName: String = KInquirer.promptInput(
message = "What is the name of the output file?",
Expand All @@ -47,7 +47,7 @@ class ParserDialog {
return listOfNotNull(
hostUrl,
projectKey,
if (user.isEmpty()) null else "--user=$user",
if (userToken.isEmpty()) null else "--user-token=$userToken",
"--output-file=$outputFileName",
if (metrics.isEmpty()) null else "--metrics=${eraseWhitespace(metrics)}",
if (isCompressed) null else "--not-compressed",
Expand Down
10 changes: 5 additions & 5 deletions ...arImporter/src/main/kotlin/de/maibornwolff/codecharta/importer/sonar/SonarImporterMain.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ class SonarImporterMain(
)
private var metrics = mutableListOf<String>()

@CommandLine.Option(names = ["-u", "--user"], description = ["user token for connecting to remote sonar instance"])
private var user = ""
@CommandLine.Option(names = ["-u", "--user-token"], description = ["user token for connecting to remote sonar instance"])
private var userToken = ""

@CommandLine.Option(
names = ["-nc", "--not-compressed"],
Expand All @@ -86,9 +86,9 @@ class SonarImporterMain(
private fun createMeasuresAPIImporter(): SonarMeasuresAPIImporter {
if (url.endsWith("/")) url = url.substring(0, url.length - 1)
val baseUrl = URL(url)
val version = SonarVersionAPIDatasource(user, baseUrl).getSonarqubeVersion()
val measuresDatasource = SonarMeasuresAPIDatasource(user, baseUrl, version)
val metricsDatasource = SonarMetricsAPIDatasource(user, baseUrl)
val version = SonarVersionAPIDatasource(userToken, baseUrl).getSonarqubeVersion()
val measuresDatasource = SonarMeasuresAPIDatasource(userToken, baseUrl, version)
val metricsDatasource = SonarMetricsAPIDatasource(userToken, baseUrl)
val sonarCodeURLLinker = SonarCodeURLLinker(baseUrl)
val translator = SonarMetricTranslatorFactory.createMetricTranslator()

Expand Down
20 changes: 10 additions & 10 deletions ...narImporter/src/test/kotlin/de/maibornwolff/codecharta/importer/sonar/ParserDialogTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class ParserDialogTest {
fun `should output correct arguments`() {
val hostUrl = "https://sonar.foo"
val projectKey = "de.foo:bar"
val user = "c123d456"
val userToken = "c123d456"
val outputFileName = "codecharta.cc.json"
val metrics = "metric1, metric2"
val compress = false
Expand All @@ -34,7 +34,7 @@ class ParserDialogTest {
mockkStatic("com.github.kinquirer.components.InputKt")
every {
KInquirer.promptInput(any(), any(), any())
} returns hostUrl andThen projectKey andThen user andThen outputFileName andThen metrics
} returns hostUrl andThen projectKey andThen userToken andThen outputFileName andThen metrics
mockkStatic("com.github.kinquirer.components.ConfirmKt")
every {
KInquirer.promptConfirm(any(), any())
Expand All @@ -46,7 +46,7 @@ class ParserDialogTest {
val parseResult = commandLine.parseArgs(*parserArguments.toTypedArray())
assertEquals(parseResult.matchedPositional(0).getValue<String>(), hostUrl)
assertEquals(parseResult.matchedPositional(1).getValue<String>(), projectKey)
assertEquals(parseResult.matchedOption("user").getValue<String>(), user)
assertEquals(parseResult.matchedOption("user-token").getValue<String>(), userToken)
assertEquals(parseResult.matchedOption("output-file").getValue<String>(), outputFileName)
assertEquals(
parseResult.matchedOption("metrics").getValue<ArrayList<String>>(),
Expand All @@ -60,7 +60,7 @@ class ParserDialogTest {
fun `should omit the metrics flag if the metrics are empty`() {
val hostUrl = "https://sonar.foo"
val projectKey = "de.foo:bar"
val user = "c123d456"
val userToken = "c123d456"
val outputFileName = "codecharta.cc.json"
val metrics = ""
val compress = false
Expand All @@ -69,7 +69,7 @@ class ParserDialogTest {
mockkStatic("com.github.kinquirer.components.InputKt")
every {
KInquirer.promptInput(any(), any(), any())
} returns hostUrl andThen projectKey andThen user andThen outputFileName andThen metrics
} returns hostUrl andThen projectKey andThen userToken andThen outputFileName andThen metrics
mockkStatic("com.github.kinquirer.components.ConfirmKt")
every {
KInquirer.promptConfirm(any(), any())
Expand All @@ -81,18 +81,18 @@ class ParserDialogTest {
val parseResult = commandLine.parseArgs(*parserArguments.toTypedArray())
assertEquals(parseResult.matchedPositional(0).getValue<String>(), hostUrl)
assertEquals(parseResult.matchedPositional(1).getValue<String>(), projectKey)
assertEquals(parseResult.matchedOption("user").getValue<String>(), user)
assertEquals(parseResult.matchedOption("user-token").getValue<String>(), userToken)
assertEquals(parseResult.matchedOption("output-file").getValue<String>(), outputFileName)
assertNull(parseResult.matchedOption("metrics"))
assertEquals(parseResult.matchedOption("not-compressed").getValue<Boolean>(), compress)
assertEquals(parseResult.matchedOption("merge-modules").getValue<Boolean>(), mergeModules)
}

@Test
fun `should omit the user flag if user is empty`() {
fun `should omit the user-tooen flag if user-token is empty`() {
val hostUrl = "https://sonar.foo"
val projectKey = "de.foo:bar"
val user = ""
val userToken = ""
val outputFileName = "codecharta.cc.json"
val metrics = "metric1, metric2"
val compress = false
Expand All @@ -101,7 +101,7 @@ class ParserDialogTest {
mockkStatic("com.github.kinquirer.components.InputKt")
every {
KInquirer.promptInput(any(), any(), any())
} returns hostUrl andThen projectKey andThen user andThen outputFileName andThen metrics
} returns hostUrl andThen projectKey andThen userToken andThen outputFileName andThen metrics
mockkStatic("com.github.kinquirer.components.ConfirmKt")
every {
KInquirer.promptConfirm(any(), any())
Expand All @@ -113,7 +113,7 @@ class ParserDialogTest {
val parseResult = commandLine.parseArgs(*parserArguments.toTypedArray())
assertEquals(parseResult.matchedPositional(0).getValue<String>(), hostUrl)
assertEquals(parseResult.matchedPositional(1).getValue<String>(), projectKey)
assertNull(parseResult.matchedOption("user"))
assertNull(parseResult.matchedOption("user-token"))
assertEquals(parseResult.matchedOption("output-file").getValue<String>(), outputFileName)
assertEquals(
parseResult.matchedOption("metrics").getValue<ArrayList<String>>(),
Expand Down
4 changes: 2 additions & 2 deletions gh-pages/_docs/04-05-sonarimporter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ The Sonar-Importer generates visualisation data from SonarQube data through an A
| `--merge-modules` | merges modules in multi-module projects |
| `-nc, --not-compressed` | save uncompressed output File |
| `-o, --output-file=<outputFile>` | output File |
| `-u, --user=<user>` | user token for connecting to remote sonar instance |
| `-u, --user-token=<userToken>` | user token for connecting to remote sonar instance |

```
Usage: ccsh sonarimport [-h] [--merge-modules] [-nc] [-o=<outputFile>]
[-u=<user>] [-m=<metrics>]... URL PROJECT_ID
[-u=<userToken>] [-m=<metrics>]... URL PROJECT_ID
```

### Examples
Expand Down