Skip to content

Commit

Permalink
Add more info to different error status.
Browse files Browse the repository at this point in the history
  • Loading branch information
@riemanli
riemanli committed Apr 25, 2023
1 parent 62d4dd9 commit a59b9e8
Show file tree
Hide file tree
Showing 2 changed files with 84 additions and 26 deletions.
93 changes: 75 additions & 18 deletions src/main/kotlin/org/wfanet/measurement/reporting/service/api/v2alpha/MetricsService.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,21 @@ class MetricsService(
.withAuthenticationKey(principal.config.apiKey)
.createMeasurement(createMeasurementRequest)
} catch (e: StatusException) {
throw Exception("Unable to create a CMMS measurement.", e)
throw when (e.status.code) {
Status.Code.INVALID_ARGUMENT ->
Status.INVALID_ARGUMENT.withDescription("Required field unspecified or invalid.")
Status.Code.PERMISSION_DENIED ->
Status.PERMISSION_DENIED.withDescription(
"Cannot create a CMMS Measurement for another MeasurementConsumer."
)
Status.Code.FAILED_PRECONDITION ->
Status.FAILED_PRECONDITION.withDescription("Failed precondition.")
Status.Code.NOT_FOUND ->
Status.NOT_FOUND.withDescription("${measurementConsumer.name} is not found.")
else -> Status.UNKNOWN.withDescription("Unable to create a CMMS measurement.")
}
.withCause(e)
.asRuntimeException()
}
}

Expand Down Expand Up @@ -409,8 +423,8 @@ class MetricsService(
} catch (e: StatusException) {
throw when (e.status.code) {
Status.Code.NOT_FOUND ->
Status.FAILED_PRECONDITION.withDescription("$dataProviderName not found")
else -> Status.UNKNOWN.withDescription("Unable to retrieve $dataProviderName")
Status.FAILED_PRECONDITION.withDescription("$dataProviderName not found.")
else -> Status.UNKNOWN.withDescription("Unable to retrieve $dataProviderName.")
}
.withCause(e)
.asRuntimeException()
Expand All @@ -422,7 +436,16 @@ class MetricsService(
.withAuthenticationKey(apiAuthenticationKey)
.getCertificate(getCertificateRequest { name = dataProvider.certificate })
} catch (e: StatusException) {
throw Exception("Unable to retrieve Certificate ${dataProvider.certificate}", e)
throw when (e.status.code) {
Status.Code.NOT_FOUND ->
Status.NOT_FOUND.withDescription("${dataProvider.certificate} not found.")
else ->
Status.UNKNOWN.withDescription(
"Unable to retrieve Certificate ${dataProvider.certificate}."
)
}
.withCause(e)
.asRuntimeException()
}
if (
certificate.revocationState != Certificate.RevocationState.REVOCATION_STATE_UNSPECIFIED
Expand Down Expand Up @@ -539,10 +562,16 @@ class MetricsService(
getMeasurementConsumerRequest { name = principal.resourceKey.toName() }
)
} catch (e: StatusException) {
throw Exception(
"Unable to retrieve the measurement consumer " + "[${principal.resourceKey.toName()}].",
e
)
throw when (e.status.code) {
Status.Code.NOT_FOUND ->
Status.NOT_FOUND.withDescription("${principal.resourceKey.toName()} not found.")
else ->
Status.UNKNOWN.withDescription(
"Unable to retrieve the measurement consumer [${principal.resourceKey.toName()}]."
)
}
.withCause(e)
.asRuntimeException()
}
}

Expand Down Expand Up @@ -584,11 +613,19 @@ class MetricsService(
.getCertificate(getCertificateRequest { name = principal.config.signingCertificateName })
.x509Der
} catch (e: StatusException) {
throw Exception(
"Unable to retrieve the signing certificate for the measurement consumer " +
"[$principal.config.signingCertificateName].",
e
)
throw when (e.status.code) {
Status.Code.NOT_FOUND ->
Status.NOT_FOUND.withDescription(
"${principal.config.signingCertificateName} not found."
)
else ->
Status.UNKNOWN.withDescription(
"Unable to retrieve the signing certificate " +
"[${principal.config.signingCertificateName}] for the measurement consumer."
)
}
.withCause(e)
.asRuntimeException()
}
}

Expand Down Expand Up @@ -724,7 +761,20 @@ class MetricsService(
.withAuthenticationKey(apiAuthenticationKey)
.getMeasurement(getMeasurementRequest { name = measurementResourceName })
} catch (e: StatusException) {
throw Exception("Unable to retrieve the measurement [$measurementResourceName].", e)
throw when (e.status.code) {
Status.Code.NOT_FOUND ->
Status.NOT_FOUND.withDescription("$measurementResourceName not found.")
Status.Code.PERMISSION_DENIED ->
Status.PERMISSION_DENIED.withDescription(
"Doesn't have permission to get $measurementResourceName."
)
else ->
Status.UNKNOWN.withDescription(
"Unable to retrieve the measurement [$measurementResourceName]."
)
}
.withCause(e)
.asRuntimeException()
}
}
}
Expand Down Expand Up @@ -770,10 +820,17 @@ class MetricsService(
.withAuthenticationKey(apiAuthenticationKey)
.getCertificate(getCertificateRequest { name = measurementResultPair.certificate })
} catch (e: StatusException) {
throw Exception(
"Unable to retrieve the certificate [${measurementResultPair.certificate}].",
e
)
throw when (e.status.code) {
Status.Code.NOT_FOUND ->
Status.NOT_FOUND.withDescription("${measurementResultPair.certificate} not found.")
else ->
Status.UNKNOWN.withDescription(
"Unable to retrieve the certificate " +
"[${measurementResultPair.certificate}] for the measurement consumer."
)
}
.withCause(e)
.asRuntimeException()
}

val signedResult =
Expand Down
17 changes: 9 additions & 8 deletions src/test/kotlin/org/wfanet/measurement/reporting/service/api/v2alpha/MetricsServiceTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ import org.wfanet.measurement.common.crypto.subjectKeyIdentifier
import org.wfanet.measurement.common.crypto.testing.loadSigningKey
import org.wfanet.measurement.common.crypto.tink.loadPrivateKey
import org.wfanet.measurement.common.getRuntimePath
import org.wfanet.measurement.common.grpc.grpcStatusCode
import org.wfanet.measurement.common.grpc.testing.GrpcTestServerRule
import org.wfanet.measurement.common.grpc.testing.mockService
import org.wfanet.measurement.common.identity.ExternalId
Expand Down Expand Up @@ -2737,7 +2738,7 @@ class MetricsServiceTest {
}

@Test
fun `createMetric throws exception when the CMMs createMeasurement throws exception`() =
fun `createMetric throws exception when the CMMs createMeasurement throws INVALID_ARGUMENT`() =
runBlocking {
whenever(measurementsMock.createMeasurement(any()))
.thenThrow(StatusRuntimeException(Status.INVALID_ARGUMENT))
Expand All @@ -2753,8 +2754,9 @@ class MetricsServiceTest {
runBlocking { service.createMetric(request) }
}
}
val expectedExceptionDescription = "Unable to create a CMMS measurement."
assertThat(exception.message).isEqualTo(expectedExceptionDescription)
assertThat(exception.grpcStatusCode()).isEqualTo(Status.Code.INVALID_ARGUMENT)
val expectedExceptionDescription = "Required field unspecified or invalid."
assertThat(exception.message).contains(expectedExceptionDescription)
}

@Test
Expand All @@ -2780,9 +2782,9 @@ class MetricsServiceTest {
}

@Test
fun `createMetric throws exception when getMeasurementConsumer throws exception`() = runBlocking {
fun `createMetric throws exception when getMeasurementConsumer throws NOT_FOUND`() = runBlocking {
whenever(measurementConsumersMock.getMeasurementConsumer(any()))
.thenThrow(StatusRuntimeException(Status.INVALID_ARGUMENT))
.thenThrow(StatusRuntimeException(Status.NOT_FOUND))

val request = createMetricRequest {
parent = MEASUREMENT_CONSUMERS.values.first().name
Expand All @@ -2795,9 +2797,8 @@ class MetricsServiceTest {
runBlocking { service.createMetric(request) }
}
}
val expectedExceptionDescription =
"Unable to retrieve the measurement consumer [${MEASUREMENT_CONSUMERS.values.first().name}]."
assertThat(exception.message).isEqualTo(expectedExceptionDescription)
assertThat(exception.grpcStatusCode()).isEqualTo(Status.Code.NOT_FOUND)
assertThat(exception.message).contains(MEASUREMENT_CONSUMERS.values.first().name)
}

@Test
Expand Down

0 comments on commit a59b9e8

Please sign in to comment.