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.

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

[BEAM-14081] [CdapIO] Add context classes for CDAP plugins #17104

Merged
merged 37 commits into from
May 11, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
78dd87b
[BEAM-14048] Add ConfigWrapper for building CDAP PluginConfigs
Amar3tto Mar 9, 2022
30b9e38
[BEAM-14048] Fix checkstyle
Amar3tto Mar 11, 2022
9e5e6d6
[BEAM-14048] Fix warnings
Amar3tto Mar 11, 2022
2d414f4
[BEAM-14048] Fix warnings
Amar3tto Mar 15, 2022
d35acb8
[BEAM-14048] Fix warning
Amar3tto Mar 15, 2022
b7e0fca
[BEAM-14048] Fix warning
Amar3tto Mar 15, 2022
3252395
[BEAM-14048] Remove unused dependencies
Amar3tto Mar 15, 2022
f9e5675
[BEAM-14048] Add needed dependencies
Amar3tto Mar 15, 2022
65a5442
[BEAM-14048] Fix spotless
Amar3tto Mar 15, 2022
00aef64
[BEAM-14048] Fix typo
Amar3tto Mar 15, 2022
d10b84b
[BEAM-14048] Use fori instead of stream
Amar3tto Mar 16, 2022
2f9686d
[BEAM-14048] Suppress warning
Amar3tto Mar 16, 2022
119d2cc
[BEAM-14048] Add used undeclared artifacts
Amar3tto Mar 16, 2022
1f63d65
[BEAM-14048] Change dependencies to test
Amar3tto Mar 16, 2022
6207224
Add context.
Mar 16, 2022
8b5aecb
Merge branch 'BEAM-14048-cdap-config' into BEAM-14081-context-wrapper
Mar 16, 2022
1dbd4d6
Fix dependencies issue
Mar 16, 2022
0777205
Add null annotation
Mar 17, 2022
0645c7b
[BEAM-14048] Refactoring
Amar3tto Mar 22, 2022
7251307
Add SuppressWarning.
Mar 23, 2022
dec0c3c
Fix style.
Mar 23, 2022
4cacd1c
Determine dependencies.
Mar 23, 2022
44125f0
Merge branch 'apache:master' into BEAM-14048-cdap-config
AKosolapov Mar 23, 2022
8ba78c9
[BEAM-14048] Use CDAP InstantiatorFactory for creating config objects
Amar3tto Mar 30, 2022
970fe79
[BEAM-14048] Suppress warning
Amar3tto Mar 30, 2022
6b7549a
[BEAM-14081] Refactoring
Amar3tto Apr 7, 2022
d7d2042
Update maven repo
elizaveta-lomteva Apr 18, 2022
129cffe
Update build.gradle
elizaveta-lomteva Apr 18, 2022
cc2cbcb
Merge branch 'BEAM-14048-cdap-config' into BEAM-14081-context-wrapper
Amar3tto Apr 28, 2022
855122a
[BEAM-14081] Refactoring
Amar3tto Apr 28, 2022
f440da9
[BEAM-14048] Use ServiceNow CDAP dependency from Maven central
Amar3tto May 4, 2022
7c0028c
Merge remote-tracking branch 'origin/BEAM-14048-cdap-config' into BEA…
Amar3tto May 4, 2022
9df1c75
[BEAM-14048] Set macroFields
Amar3tto May 4, 2022
c5babc2
Merge branch 'BEAM-14048-cdap-config' into BEAM-14081-context-wrapper
Amar3tto May 5, 2022
9701033
Merge branch 'master' into BEAM-14081-context-wrapper
Amar3tto May 5, 2022
9e31a72
[BEAM-14081] Fix javadoc
Amar3tto May 5, 2022
2f77cc4
[BEAM-14081] Make BatchContextImpl class abstract
Amar3tto May 11, 2022
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
Original file line number Diff line number Diff line change
Expand Up @@ -538,8 +538,10 @@ class BeamModulePlugin implements Plugin<Project> {
cassandra_driver_core : "com.datastax.cassandra:cassandra-driver-core:$cassandra_driver_version",
cassandra_driver_mapping : "com.datastax.cassandra:cassandra-driver-mapping:$cassandra_driver_version",
cdap_api : "io.cdap.cdap:cdap-api:$cdap_version",
cdap_api_commons : "io.cdap.cdap:cdap-api-common:$cdap_version",
cdap_common : "io.cdap.cdap:cdap-common:$cdap_version",
cdap_etl_api : "io.cdap.cdap:cdap-etl-api:$cdap_version",
cdap_etl_api_spark : "io.cdap.cdap:cdap-etl-api-spark:$cdap_version",
cdap_plugin_service_now : "io.cdap.plugin:servicenow-plugins:1.1.0",
checker_qual : "org.checkerframework:checker-qual:$checkerframework_version",
classgraph : "io.github.classgraph:classgraph:$classgraph_version",
Expand Down Expand Up @@ -693,6 +695,7 @@ class BeamModulePlugin implements Plugin<Project> {
spark3_sql : "org.apache.spark:spark-sql_2.12:$spark3_version",
spark3_streaming : "org.apache.spark:spark-streaming_2.12:$spark3_version",
stax2_api : "org.codehaus.woodstox:stax2-api:4.2.1",
tephra : "org.apache.tephra:tephra-api:0.15.0-incubating",
testcontainers_base : "org.testcontainers:testcontainers:$testcontainers_version",
testcontainers_clickhouse : "org.testcontainers:clickhouse:$testcontainers_version",
testcontainers_elasticsearch : "org.testcontainers:elasticsearch:$testcontainers_version",
Expand Down
11 changes: 9 additions & 2 deletions sdks/java/io/cdap/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,22 @@ interface for integration with CDAP plugins."""
*/

dependencies {
implementation library.java.guava
implementation library.java.cdap_api
implementation library.java.cdap_common
implementation library.java.cdap_api_commons
implementation (library.java.cdap_common) {
exclude module: "log4j-over-slf4j"
}
implementation library.java.cdap_etl_api
implementation library.java.cdap_etl_api_spark
implementation library.java.jackson_core
implementation library.java.jackson_databind
implementation library.java.guava
implementation library.java.slf4j_api
implementation library.java.tephra
implementation project(path: ":sdks:java:core", configuration: "shadow")
testImplementation library.java.cdap_plugin_service_now
testImplementation library.java.cdap_etl_api
testImplementation library.java.vendored_guava_26_0_jre
testImplementation library.java.junit
testImplementation project(path: ":runners:direct-java", configuration: "shadow")
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,232 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.beam.sdk.io.cdap.context;

import io.cdap.cdap.api.data.DatasetInstantiationException;
import io.cdap.cdap.api.data.batch.InputFormatProvider;
import io.cdap.cdap.api.data.schema.Schema;
import io.cdap.cdap.api.dataset.Dataset;
import io.cdap.cdap.api.dataset.DatasetManagementException;
import io.cdap.cdap.api.dataset.DatasetProperties;
import io.cdap.cdap.api.metadata.Metadata;
import io.cdap.cdap.api.metadata.MetadataEntity;
import io.cdap.cdap.api.metadata.MetadataException;
import io.cdap.cdap.api.metadata.MetadataScope;
import io.cdap.cdap.api.plugin.PluginProperties;
import io.cdap.cdap.etl.api.FailureCollector;
import io.cdap.cdap.etl.api.Lookup;
import io.cdap.cdap.etl.api.StageMetrics;
import io.cdap.cdap.etl.api.SubmitterLifecycle;
import io.cdap.cdap.etl.api.action.SettableArguments;
import io.cdap.cdap.etl.api.batch.BatchContext;
import io.cdap.cdap.etl.api.lineage.field.FieldOperation;
import java.net.URL;
import java.sql.Timestamp;
import java.util.List;
import java.util.Map;
import javax.annotation.Nullable;

/** Class for Batch, Sink and Stream CDAP wrapper classes that use it to provide common details. */
@SuppressWarnings({"TypeParameterUnusedInFormals", "nullness"})
public abstract class BatchContextImpl implements BatchContext {

private final FailureCollectorWrapper failureCollector = new FailureCollectorWrapper();

/**
* This should be set after {@link SubmitterLifecycle#prepareRun(Object)} call with passing this
* context object as a param.
*/
protected InputFormatProvider inputFormatProvider;

private final Timestamp startTime = new Timestamp(System.currentTimeMillis());

public InputFormatProvider getInputFormatProvider() {
return inputFormatProvider;
}

@Override
public String getStageName() {
return null;
Copy link
Contributor

Choose a reason for hiding this comment

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

Should these methods be implemented ? What does the default implementation that mostly return null provide ? If this class is not usable as is can we make it an abstract class ?

Copy link
Collaborator

Choose a reason for hiding this comment

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

For now, this class only provides FailureCollectorWrapper and stubs all other methods as they are only needed for the CDAP environment.
Yes, it can be abstract, because we are only supposed to create objects of its child classes.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Done

}

@Override
public String getNamespace() {
return null;
}

@Override
public String getPipelineName() {
return null;
}

@Override
public long getLogicalStartTime() {
return this.startTime.getTime();
}

@Override
public StageMetrics getMetrics() {
return null;
}

@Override
public PluginProperties getPluginProperties() {
return null;
}

@Override
public PluginProperties getPluginProperties(String pluginId) {
return null;
}

@Override
public <T> Class<T> loadPluginClass(String pluginId) {
return null;
}

@Override
public <T> T newPluginInstance(String pluginId) throws InstantiationException {
return null;
}

@Nullable
@Override
public Schema getInputSchema() {
return null;
}

@Override
public @Nullable Map<String, Schema> getInputSchemas() {
return null;
}

@Override
public @Nullable Schema getOutputSchema() {
return null;
}

@Override
public Map<String, Schema> getOutputPortSchemas() {
return null;
}

@Override
public void createDataset(String datasetName, String typeName, DatasetProperties properties)
throws DatasetManagementException {}

@Override
public boolean datasetExists(String datasetName) throws DatasetManagementException {
return false;
}

@Override
public SettableArguments getArguments() {
return null;
}

@Override
public FailureCollector getFailureCollector() {
return this.failureCollector;
}

@Nullable
@Override
public URL getServiceURL(String applicationId, String serviceId) {
return null;
}

@Nullable
@Override
public URL getServiceURL(String serviceId) {
return null;
}

@Override
public Map<MetadataScope, Metadata> getMetadata(MetadataEntity metadataEntity)
throws MetadataException {
return null;
}

@Override
public Metadata getMetadata(MetadataScope scope, MetadataEntity metadataEntity)
throws MetadataException {
return null;
}

@Override
public void addProperties(MetadataEntity metadataEntity, Map<String, String> properties) {}

@Override
public void addTags(MetadataEntity metadataEntity, String... tags) {}

@Override
public void addTags(MetadataEntity metadataEntity, Iterable<String> tags) {}

@Override
public void removeMetadata(MetadataEntity metadataEntity) {}

@Override
public void removeProperties(MetadataEntity metadataEntity) {}

@Override
public void removeProperties(MetadataEntity metadataEntity, String... keys) {}

@Override
public void removeTags(MetadataEntity metadataEntity) {}

@Override
public void removeTags(MetadataEntity metadataEntity, String... tags) {}

@Override
public void record(List<FieldOperation> fieldOperations) {}

@Override
public <T extends Dataset> T getDataset(String name) throws DatasetInstantiationException {
return null;
}

@Override
public <T extends Dataset> T getDataset(String namespace, String name)
throws DatasetInstantiationException {
return null;
}

@Override
public <T extends Dataset> T getDataset(String name, Map<String, String> arguments)
throws DatasetInstantiationException {
return null;
}

@Override
public <T extends Dataset> T getDataset(
String namespace, String name, Map<String, String> arguments)
throws DatasetInstantiationException {
return null;
}

@Override
public void releaseDataset(Dataset dataset) {}

@Override
public void discardDataset(Dataset dataset) {}

@Override
public <T> Lookup<T> provide(String table, Map<String, String> arguments) {
return null;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.beam.sdk.io.cdap.context;

import io.cdap.cdap.api.data.batch.Output;
import io.cdap.cdap.etl.api.batch.BatchSinkContext;

/** Class for creating context object of different CDAP classes with batch sink type. */
public class BatchSinkContextImpl extends BatchContextImpl implements BatchSinkContext {

@Override
public void addOutput(Output output) {}

@Override
public boolean isPreviewEnabled() {
return false;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.beam.sdk.io.cdap.context;

import io.cdap.cdap.api.data.batch.Input;
import io.cdap.cdap.etl.api.batch.BatchSourceContext;

/** Class for creating context object of different CDAP classes with batch source type. */
public class BatchSourceContextImpl extends BatchContextImpl implements BatchSourceContext {

@Override
public void setInput(Input input) {
this.inputFormatProvider = ((Input.InputFormatProviderInput) input).getInputFormatProvider();
}

@Override
public boolean isPreviewEnabled() {
return false;
}

@Override
public int getMaxPreviewRecords() {
return 0;
}
}
Loading