Skip to content

[#5756] Bug Fix : Warehouse parameter systematically required #5923

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
jerryshao merged 13 commits into from
Dec 23, 2024
Merged

[#5756] Bug Fix : Warehouse parameter systematically required #5923

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
25bf2ac
Modify IcebergCatalogWrapper so it ignores Warehouse URI in case of a…
fsalhi2 Dec 18, 2024
ca56609
Modify the property WAREHOUSE in IcebergCatalogPropertiesMetadata to …
fsalhi2 Dec 18, 2024
6323705
Fixing WAREHOUSE parameters in IcebergCatalogPropertiesMetadata
fsalhi2 Dec 19, 2024
12d517c
Add a test that use the minimum amount of required parameter for the …
fsalhi2 Dec 19, 2024
436bbd2
Modify WAREHOUSE ConfigEntry as Optional in IcebergConfig\nModify WAR…
fsalhi2 Dec 19, 2024
27a96ba
Modify WAREHOUSE constant config in IcebergConfig as Optional
fsalhi2 Dec 19, 2024
09e9338
Fixing WAREHOUSE configEntry declaration in IcebergConfig
fsalhi2 Dec 19, 2024
ea70ac3
Fixing imports declarations in IcebergConfig
fsalhi2 Dec 19, 2024
b1ace6d
Fixing ConfigEntry instanciation for WAREHOUSE to non-optional, creat…
fsalhi2 Dec 19, 2024
c14c510
Correcting IcebergCatalogBackend for usage with non-required WAREHOUS…
fsalhi2 Dec 19, 2024
286fdbe
Re-establishing original gradle.properties\nWrapping out of style ele…
fsalhi2 Dec 21, 2024
7f8b3cf
Inverting past manual changes to gradle.properties version software v…
fsalhi2 Dec 22, 2024
44667a5
Reverting changes made to pythonVersion in gradle properties.
fsalhi2 Dec 22, 2024
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
3 changes: 2 additions & 1 deletion ...java/org/apache/gravitino/catalog/lakehouse/iceberg/IcebergCatalogPropertiesMetadata.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,11 @@ public class IcebergCatalogPropertiesMetadata extends BaseCatalogPropertiesMetad
false /* reserved */),
stringRequiredPropertyEntry(
URI, "Iceberg catalog uri config", false /* immutable */, false /* hidden */),
stringRequiredPropertyEntry(
stringOptionalPropertyEntry(
WAREHOUSE,
"Iceberg catalog warehouse config",
false /* immutable */,
null, /* defaultValue */

@tengqm tengqm Dec 21, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We could have prevented this kind of obvious errors if we apply a stricter coding style.
Can you help also wrap line 76?

@fsalhi2 fsalhi2 Dec 21, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yup

@tengqm tengqm Dec 22, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks like that this is not updated yet?

false /* hidden */),
stringOptionalPropertyEntry(
IcebergConstants.IO_IMPL,
Expand Down
47 changes: 47 additions & 0 deletions ...berg/src/test/java/org/apache/gravitino/catalog/lakehouse/iceberg/TestIcebergCatalog.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,4 +146,51 @@ void testCatalogProperty() {
throwable.getMessage().contains(IcebergCatalogPropertiesMetadata.CATALOG_BACKEND));
}
}

@Test
void testCatalogInstanciation() {
AuditInfo auditInfo =
AuditInfo.builder().withCreator("creator").withCreateTime(Instant.now()).build();

CatalogEntity entity =
CatalogEntity.builder()
.withId(1L)
.withName("catalog")
.withNamespace(Namespace.of("metalake"))
.withType(IcebergCatalog.Type.RELATIONAL)
.withProvider("iceberg")
.withAuditInfo(auditInfo)
.build();

Map<String, String> conf = Maps.newHashMap();

try (IcebergCatalogOperations ops = new IcebergCatalogOperations()) {
ops.initialize(conf, entity.toCatalogInfo(), ICEBERG_PROPERTIES_METADATA);
Map<String, String> map1 = Maps.newHashMap();
map1.put(IcebergCatalogPropertiesMetadata.CATALOG_BACKEND, "test");
PropertiesMetadata metadata = ICEBERG_PROPERTIES_METADATA.catalogPropertiesMetadata();
Assertions.assertThrows(
IllegalArgumentException.class,
() -> {
PropertiesMetadataHelpers.validatePropertyForCreate(metadata, map1);
});

Map<String, String> map2 = Maps.newHashMap();
map2.put(IcebergCatalogPropertiesMetadata.CATALOG_BACKEND, "rest");
map2.put(IcebergCatalogPropertiesMetadata.URI, "127.0.0.1");
Assertions.assertDoesNotThrow(
() -> {
PropertiesMetadataHelpers.validatePropertyForCreate(metadata, map2);
});

Map<String, String> map3 = Maps.newHashMap();
Throwable throwable =
Assertions.assertThrows(
IllegalArgumentException.class,
() -> PropertiesMetadataHelpers.validatePropertyForCreate(metadata, map3));

Assertions.assertTrue(
throwable.getMessage().contains(IcebergCatalogPropertiesMetadata.CATALOG_BACKEND));
}
}
}
1 change: 0 additions & 1 deletion iceberg/iceberg-common/src/main/java/org/apache/gravitino/iceberg/common/IcebergConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,6 @@ public class IcebergConfig extends Config implements OverwriteDefaultConfig {
.doc("Warehouse directory of catalog")
.version(ConfigConstants.VERSION_0_2_0)
.stringConf()
.checkValue(StringUtils::isNotBlank, ConfigConstants.NOT_BLANK_ERROR_MSG)
.create();

public static final ConfigEntry<String> CATALOG_URI =
Expand Down
10 changes: 8 additions & 2 deletions ...g-common/src/main/java/org/apache/gravitino/iceberg/common/ops/IcebergCatalogWrapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import java.util.function.Supplier;
import lombok.Getter;
import lombok.Setter;
import org.apache.commons.lang3.StringUtils;
import org.apache.gravitino.catalog.lakehouse.iceberg.IcebergConstants;
import org.apache.gravitino.iceberg.common.IcebergCatalogBackend;
import org.apache.gravitino.iceberg.common.IcebergConfig;
Expand Down Expand Up @@ -82,9 +83,14 @@ public IcebergCatalogWrapper(IcebergConfig icebergConfig) {
this.catalogBackend =
IcebergCatalogBackend.valueOf(
icebergConfig.get(IcebergConfig.CATALOG_BACKEND).toUpperCase(Locale.ROOT));
if (!IcebergCatalogBackend.MEMORY.equals(catalogBackend)) {
if (!IcebergCatalogBackend.MEMORY.equals(catalogBackend)
&& !IcebergCatalogBackend.REST.equals(catalogBackend)) {
// check whether IcebergConfig.CATALOG_WAREHOUSE exists
icebergConfig.get(IcebergConfig.CATALOG_WAREHOUSE);
if (StringUtils.isBlank(icebergConfig.get(IcebergConfig.CATALOG_WAREHOUSE))) {
throw new IllegalArgumentException("The 'warehouse' parameter must have a value.");
}
}
if (!IcebergCatalogBackend.MEMORY.equals(catalogBackend)) {
this.catalogUri = icebergConfig.get(IcebergConfig.CATALOG_URI);
}
this.catalog = IcebergCatalogUtil.loadCatalogBackend(catalogBackend, icebergConfig);
Expand Down