Enforce access on program run-record endpoints in ProgramLifecycleHttpHandler #16171
+137
−1
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| /* | ||
| * Copyright © 2026 Cask Data, Inc. | ||
| * | ||
| * 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 io.cdap.cdap.gateway.handlers; | ||
|
|
||
| import static org.mockito.Matchers.any; | ||
| import static org.mockito.Matchers.anyString; | ||
| import static org.mockito.Matchers.eq; | ||
| import static org.mockito.Mockito.mock; | ||
| import static org.mockito.Mockito.never; | ||
| import static org.mockito.Mockito.verify; | ||
| import static org.mockito.Mockito.when; | ||
|
|
||
| import io.cdap.cdap.app.mapreduce.MRJobInfoFetcher; | ||
| import io.cdap.cdap.app.store.Store; | ||
| import io.cdap.cdap.common.namespace.NamespaceQueryAdmin; | ||
| import io.cdap.cdap.internal.app.services.ProgramLifecycleService; | ||
| import io.cdap.cdap.internal.app.store.RunRecordDetail; | ||
| import io.cdap.cdap.proto.ProgramRunCluster; | ||
| import io.cdap.cdap.proto.ProgramRunClusterStatus; | ||
| import io.cdap.cdap.proto.ProgramRunStatus; | ||
| import io.cdap.cdap.proto.ProgramType; | ||
| import io.cdap.cdap.proto.id.ApplicationReference; | ||
| import io.cdap.cdap.proto.id.NamespaceId; | ||
| import io.cdap.cdap.proto.id.ProfileId; | ||
| import io.cdap.cdap.proto.id.ProgramReference; | ||
| import io.cdap.cdap.proto.security.Authorizable; | ||
| import io.cdap.cdap.proto.security.Principal; | ||
| import io.cdap.cdap.proto.security.StandardPermission; | ||
| import io.cdap.cdap.security.auth.context.AuthenticationTestContext; | ||
| import io.cdap.cdap.security.authorization.DefaultContextAccessEnforcer; | ||
| import io.cdap.cdap.security.authorization.InMemoryAccessController; | ||
| import io.cdap.cdap.security.spi.authorization.ContextAccessEnforcer; | ||
| import io.cdap.cdap.security.spi.authorization.UnauthorizedException; | ||
| import io.cdap.http.HttpResponder; | ||
| import io.netty.handler.codec.http.HttpRequest; | ||
| import io.netty.handler.codec.http.HttpResponseStatus; | ||
| import java.util.Collections; | ||
| import org.apache.twill.discovery.DiscoveryServiceClient; | ||
| import org.junit.Assert; | ||
| import org.junit.Test; | ||
|
|
||
| /** | ||
| * Authorization tests for {@link ProgramLifecycleHttpHandler}. | ||
| */ | ||
| public class ProgramLifecycleHttpHandlerAuthorizationTest { | ||
|
|
||
| private static final Principal ALICE = new Principal("alice", Principal.PrincipalType.USER); | ||
| private static final Principal BOB = new Principal("bob", Principal.PrincipalType.USER); | ||
|
|
||
| @Test | ||
| public void testProgramRunRecordRequiresProgramGetPermission() throws Exception { | ||
|
There was a problem hiding this comment. The pull request adds authorization enforcement to three endpoints: |
||
| String namespaceId = NamespaceId.DEFAULT.getNamespace(); | ||
| String appName = "app"; | ||
| String programName = "worker"; | ||
| String runId = "run"; | ||
| ProgramReference programRef = new ApplicationReference(namespaceId, appName) | ||
| .program(ProgramType.WORKER, programName); | ||
| Authorizable programAuthorizable = Authorizable.fromEntityId(programRef); | ||
| RunRecordDetail runRecord = createRunRecord(namespaceId, appName, programName, runId); | ||
|
|
||
| Store store = mock(Store.class); | ||
| when(store.getRun(eq(programRef), eq(runId))).thenReturn(runRecord); | ||
| InMemoryAccessController accessController = new InMemoryAccessController(); | ||
| accessController.revoke(programAuthorizable); | ||
| ProgramLifecycleHttpHandler handler = createHandler(store, | ||
| new DefaultContextAccessEnforcer(new AuthenticationTestContext(), accessController)); | ||
| HttpRequest request = mock(HttpRequest.class); | ||
| HttpResponder responder = mock(HttpResponder.class); | ||
|
|
||
| try { | ||
| AuthenticationTestContext.actAsPrincipal(BOB); | ||
| handler.programRunRecord(request, responder, namespaceId, appName, "workers", programName, runId); | ||
| Assert.fail(); | ||
| } catch (UnauthorizedException e) { | ||
| // expected | ||
| } | ||
|
Comment on lines
+84
to
+90
There was a problem hiding this comment. Using a AuthenticationTestContext.actAsPrincipal(BOB);
Assert.assertThrows(UnauthorizedException.class, () ->
handler.programRunRecord(request, responder, namespaceId, appName, "workers", programName, runId)
); |
||
| verify(store, never()).getRun(any(ProgramReference.class), anyString()); | ||
|
|
||
| try { | ||
| accessController.grant(programAuthorizable, ALICE, Collections.singleton(StandardPermission.GET)); | ||
| AuthenticationTestContext.actAsPrincipal(ALICE); | ||
| handler.programRunRecord(request, responder, namespaceId, appName, "workers", programName, runId); | ||
| } finally { | ||
| accessController.revoke(programAuthorizable); | ||
| } | ||
|
|
||
| verify(store).getRun(eq(programRef), eq(runId)); | ||
| verify(responder).sendJson(eq(HttpResponseStatus.OK), anyString()); | ||
| } | ||
|
|
||
| private static ProgramLifecycleHttpHandler createHandler(Store store, | ||
| ContextAccessEnforcer contextAccessEnforcer) { | ||
| return new ProgramLifecycleHttpHandler( | ||
| store, | ||
| mock(DiscoveryServiceClient.class), | ||
| mock(ProgramLifecycleService.class), | ||
| mock(MRJobInfoFetcher.class), | ||
| mock(NamespaceQueryAdmin.class), | ||
| contextAccessEnforcer); | ||
| } | ||
|
|
||
| private static RunRecordDetail createRunRecord(String namespaceId, String appName, | ||
| String programName, String runId) { | ||
| return RunRecordDetail.builder() | ||
| .setProgramRunId(new NamespaceId(namespaceId).app(appName).worker(programName).run(runId)) | ||
| .setStartTime(1L) | ||
| .setRunTime(1L) | ||
| .setStatus(ProgramRunStatus.RUNNING) | ||
| .setCluster(new ProgramRunCluster(ProgramRunClusterStatus.PROVISIONED, null, null)) | ||
| .setProfileId(ProfileId.NATIVE) | ||
| .setSourceId(new byte[] { 0 }) | ||
| .build(); | ||
| } | ||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The class
org.mockito.Matchersis deprecated in Mockito 2.x and completely removed in Mockito 3.x. To ensure compatibility with newer Mockito versions and avoid deprecation warnings, please useorg.mockito.ArgumentMatchersinstead.