Skip to content

Service: Add location tests for views #2496

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

Merged
flyrain merged 2 commits into from
Sep 3, 2025
Merged

Service: Add location tests for views #2496

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c835a0d
Add location tests for views
Sep 3, 2025
5e570e7
Resolve comments
Sep 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
170 changes: 170 additions & 0 deletions .../src/test/java/org/apache/polaris/service/catalog/iceberg/IcebergAllowedLocationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,35 +20,57 @@
package org.apache.polaris.service.catalog.iceberg;

import static org.apache.polaris.core.config.FeatureConfiguration.OPTIMIZED_SIBLING_CHECK;
import static org.apache.polaris.core.entity.table.IcebergTableLikeEntity.USER_SPECIFIED_WRITE_METADATA_LOCATION_KEY;
import static org.apache.polaris.service.admin.PolarisAuthzTestBase.SCHEMA;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;

import jakarta.ws.rs.core.Response;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import org.apache.iceberg.MetadataUpdate;
import org.apache.iceberg.catalog.Namespace;
import org.apache.iceberg.catalog.TableIdentifier;
import org.apache.iceberg.exceptions.ForbiddenException;
import org.apache.iceberg.rest.requests.CreateNamespaceRequest;
import org.apache.iceberg.rest.requests.CreateTableRequest;
import org.apache.iceberg.rest.requests.CreateViewRequest;
import org.apache.iceberg.rest.requests.ImmutableCreateViewRequest;
import org.apache.iceberg.rest.requests.UpdateTableRequest;
import org.apache.iceberg.view.ImmutableSQLViewRepresentation;
import org.apache.iceberg.view.ImmutableViewVersion;
import org.apache.polaris.core.admin.model.Catalog;
import org.apache.polaris.core.admin.model.CatalogProperties;
import org.apache.polaris.core.admin.model.CreateCatalogRequest;
import org.apache.polaris.core.admin.model.FileStorageConfigInfo;
import org.apache.polaris.core.admin.model.StorageConfigInfo;
import org.apache.polaris.service.TestServices;
import org.jetbrains.annotations.NotNull;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;

public class IcebergAllowedLocationTest {
private static final String namespace = "ns";
private static final String catalog = "test-catalog";

private static final String VIEW_QUERY = "select * from ns.tbl";
public static final ImmutableViewVersion VIEW_VERSION =
ImmutableViewVersion.builder()
.versionId(1)
.timestampMillis(System.currentTimeMillis())
.schemaId(1)
.defaultNamespace(Namespace.of(namespace))
.addRepresentations(
ImmutableSQLViewRepresentation.builder().sql(VIEW_QUERY).dialect("spark").build())
.build();

private String getTableName() {
return "table_" + UUID.randomUUID();
}
Expand Down Expand Up @@ -131,6 +153,154 @@ private static TestServices getTestServices() {
return services;
}

@Test
void testViewWithAllowedLocations(@TempDir Path tmpDir) {
var viewId = TableIdentifier.of(namespace, "view");
var services = getTestServices();
var catalogLocation = tmpDir.resolve(catalog).toAbsolutePath().toUri().toString();
createCatalog(services, Map.of(), catalogLocation, List.of(catalogLocation));
var namespaceLocation = catalogLocation + "/" + namespace;
createNamespace(services, namespaceLocation);

// create a view with allowed locations
String customAllowedLocation1 = Paths.get(namespaceLocation, "custom-location1").toString();
String customAllowedLocation2 = Paths.get(namespaceLocation, "custom-location2").toString();

CreateViewRequest createViewRequest =
getCreateViewRequest(customAllowedLocation2, viewId.name(), customAllowedLocation1);
var response =
services
.restApi()
.createView(
catalog,
namespace,
createViewRequest,
services.realmContext(),
services.securityContext());

assertEquals(response.getStatus(), Response.Status.OK.getStatusCode());

// update the view with allowed locations
String customAllowedLocation3 = Paths.get(namespaceLocation, "custom-location3").toString();

Map<String, String> updatedProperties = new HashMap<>();
updatedProperties.put(USER_SPECIFIED_WRITE_METADATA_LOCATION_KEY, customAllowedLocation3);

UpdateTableRequest updateRequest =
UpdateTableRequest.create(
viewId, List.of(), List.of(new MetadataUpdate.SetProperties(updatedProperties)));

var updateResponse =
services
.catalogAdapter()
.newHandlerWrapper(services.securityContext(), catalog)
.replaceView(viewId, updateRequest);
assertEquals(
updateResponse.metadata().properties().get(USER_SPECIFIED_WRITE_METADATA_LOCATION_KEY),
customAllowedLocation3);
}

@Test
void testViewOutsideAllowedLocations(@TempDir Path tmpDir) {
var viewId = TableIdentifier.of(namespace, "view");
var services = getTestServices();

var catalogBaseLocation = tmpDir.resolve(catalog).toAbsolutePath().toUri().toString();
var namespaceLocation = catalogBaseLocation + "/" + namespace;

createCatalog(services, Map.of(), catalogBaseLocation, List.of(catalogBaseLocation));
createNamespace(services, namespaceLocation);

var locationNotAllowed = Paths.get(tmpDir.toUri().toString()).toString();
Copy link

Copilot AI Sep 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Converting URI to string and then back to Path is unnecessary. Use tmpDir.toAbsolutePath().toString() directly for consistency with other location variables in the test.

Suggested change
var locationNotAllowed = Paths.get(tmpDir.toUri().toString()).toString();
var locationNotAllowed = tmpDir.toAbsolutePath().toString();

Copilot uses AI. Check for mistakes.
Copy link
Contributor

@dimas-b dimas-b Sep 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this comment makes sense to me... however, the code suggestion probably needs to be tmpDir.toAbsolutePath().toUri().toString() to match line 208.

Copy link
Contributor Author

@flyrain flyrain Sep 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using this to make it more explicitly

tmpDir.resolve("location-not-allowed").toAbsolutePath().toUri().toString();

var locationAllowed = Paths.get(namespaceLocation, "custom-location").toString();

// Test 1: Create a view with allowed location, and update it with a location not allowed
var properties = new HashMap<String, String>();

CreateViewRequest createViewRequest =
ImmutableCreateViewRequest.builder()
.name(viewId.name())
.schema(SCHEMA)
.viewVersion(VIEW_VERSION)
.location(locationAllowed)
.properties(properties)
.build();

var response =
services
.restApi()
.createView(
catalog,
namespace,
createViewRequest,
services.realmContext(),
services.securityContext());
assertEquals(response.getStatus(), Response.Status.OK.getStatusCode());

Map<String, String> updatedProperties = new HashMap<>();
updatedProperties.put(USER_SPECIFIED_WRITE_METADATA_LOCATION_KEY, locationNotAllowed);

var updateRequest =
UpdateTableRequest.create(
viewId,
List.of(), // requirements
List.of(new MetadataUpdate.SetProperties(updatedProperties)));

assertThatThrownBy(
() ->
services
.catalogAdapter()
.newHandlerWrapper(services.securityContext(), catalog)
.replaceView(viewId, updateRequest));

// Test 2: Try to create a view with location not allowed
var createViewRequestNotAllowed =
getCreateViewRequest(locationNotAllowed, "view2", locationNotAllowed);

assertThatThrownBy(
() ->
services
.restApi()
.createView(
catalog,
namespace,
createViewRequestNotAllowed,
services.realmContext(),
services.securityContext()))
.isInstanceOf(ForbiddenException.class)
.hasMessageContaining("Invalid locations");

// Test 3: Try to create a view with metadata location not allowed
var createViewRequestMetadataNotAllowed =
getCreateViewRequest(locationNotAllowed, "view3", locationAllowed);

assertThatThrownBy(
() ->
services
.restApi()
.createView(
catalog,
namespace,
createViewRequestMetadataNotAllowed,
services.realmContext(),
services.securityContext()))
.isInstanceOf(ForbiddenException.class)
.hasMessageContaining("Invalid locations");
}

private static @NotNull CreateViewRequest getCreateViewRequest(
String writeMetadataPath, String viewName, String location) {
var properties = new HashMap<String, String>();
properties.put(USER_SPECIFIED_WRITE_METADATA_LOCATION_KEY, writeMetadataPath);
return ImmutableCreateViewRequest.builder()
.name(viewName)
.schema(SCHEMA)
.viewVersion(VIEW_VERSION)
.location(location)
.properties(properties)
.build();
}

private void createCatalog(
TestServices services,
Map<String, String> catalogConfig,
Expand Down