-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
[Feature][Connector-V2][Jira]Add Jira source connector #3473
Merged
Merged
Changes from 13 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
535603a
add jira source
liugddx e78956a
Merge remote-tracking branch 'upstream/dev' into connector-v2-jira
liugddx bcb777e
update jira connector
liugddx 7b34879
Merge remote-tracking branch 'upstream/dev' into connector-v2-jira
liugddx 383ce58
Update seatunnel-e2e/seatunnel-connector-v2-e2e/connector-http-e2e/sr…
liugddx b90a60c
Update seatunnel-e2e/seatunnel-connector-v2-e2e/connector-http-e2e/sr…
liugddx 264717e
Update seatunnel-e2e/seatunnel-connector-v2-e2e/connector-http-e2e/sr…
liugddx 2d256e7
fix rv error.
liugddx fec2aae
Update docs/en/connector-v2/source/Jira.md
liugddx 1e6cf13
fix ci error.
liugddx e7c11c7
fix ci error.
liugddx f718813
fix ci error.
liugddx ac65a68
fix ci error
liugddx a3e5492
Merge branch 'dev' into connector-v2-jira
liugddx File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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,160 @@ | ||
# Jira | ||
|
||
> Jira source connector | ||
|
||
## Description | ||
|
||
Used to read data from Jira. | ||
|
||
## Key features | ||
|
||
- [x] [batch](../../concept/connector-v2-features.md) | ||
- [ ] [stream](../../concept/connector-v2-features.md) | ||
- [ ] [exactly-once](../../concept/connector-v2-features.md) | ||
- [x] [schema projection](../../concept/connector-v2-features.md) | ||
- [ ] [parallelism](../../concept/connector-v2-features.md) | ||
- [ ] [support user-defined split](../../concept/connector-v2-features.md) | ||
|
||
## Options | ||
|
||
| name | type | required | default value | | ||
| --------------------------- | ------ | -------- | ------------- | | ||
| url | String | Yes | - | | ||
| email | String | Yes | - | | ||
| api_token | String | Yes | - | | ||
| method | String | No | get | | ||
| schema.fields | Config | No | - | | ||
| format | String | No | json | | ||
| params | Map | No | - | | ||
| body | String | No | - | | ||
| poll_interval_ms | int | No | - | | ||
| retry | int | No | - | | ||
| retry_backoff_multiplier_ms | int | No | 100 | | ||
| retry_backoff_max_ms | int | No | 10000 | | ||
| common-options | config | No | - | | ||
|
||
### url [String] | ||
|
||
http request url | ||
|
||
### email [String] | ||
|
||
Jira Email | ||
|
||
### api_token [String] | ||
|
||
Jira API Token | ||
|
||
https://id.atlassian.com/manage-profile/security/api-tokens | ||
|
||
### method [String] | ||
|
||
http request method, only supports GET, POST method | ||
|
||
### params [Map] | ||
|
||
http params | ||
|
||
### body [String] | ||
|
||
http body | ||
|
||
### poll_interval_ms [int] | ||
|
||
request http api interval(millis) in stream mode | ||
|
||
### retry [int] | ||
|
||
The max retry times if request http return to `IOException` | ||
|
||
### retry_backoff_multiplier_ms [int] | ||
|
||
The retry-backoff times(millis) multiplier if request http failed | ||
|
||
### retry_backoff_max_ms [int] | ||
|
||
The maximum retry-backoff times(millis) if request http failed | ||
|
||
### format [String] | ||
|
||
the format of upstream data, now only support `json` `text`, default `json`. | ||
|
||
when you assign format is `json`, you should also assign schema option, for example: | ||
|
||
upstream data is the following: | ||
|
||
```json | ||
|
||
{"code": 200, "data": "get success", "success": true} | ||
|
||
``` | ||
|
||
you should assign schema as the following: | ||
|
||
```hocon | ||
|
||
schema { | ||
fields { | ||
code = int | ||
data = string | ||
success = boolean | ||
} | ||
} | ||
|
||
``` | ||
|
||
connector will generate data as the following: | ||
|
||
| code | data | success | | ||
|------|-------------|---------| | ||
| 200 | get success | true | | ||
|
||
when you assign format is `text`, connector will do nothing for upstream data, for example: | ||
|
||
upstream data is the following: | ||
|
||
```json | ||
|
||
{"code": 200, "data": "get success", "success": true} | ||
|
||
``` | ||
|
||
connector will generate data as the following: | ||
|
||
| content | | ||
|---------| | ||
| {"code": 200, "data": "get success", "success": true} | | ||
|
||
### schema [Config] | ||
|
||
#### fields [Config] | ||
|
||
the schema fields of upstream data | ||
|
||
### common options | ||
|
||
Source plugin common parameters, please refer to [Source Common Options](common-options.md) for details | ||
|
||
## Example | ||
|
||
```hocon | ||
Jira { | ||
url = "https://liugddx.atlassian.net/rest/api/3/search" | ||
email = "test@test.com" | ||
api_token = "xxx" | ||
schema { | ||
fields { | ||
expand = string | ||
startAt = bigint | ||
maxResults = int | ||
total = int | ||
} | ||
} | ||
} | ||
``` | ||
|
||
## Changelog | ||
|
||
### next version | ||
|
||
- Add Jira Source Connector |
This file contains 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
40 changes: 40 additions & 0 deletions
40
seatunnel-connectors-v2/connector-http/connector-http-jira/pom.xml
This file contains 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,40 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<!-- | ||
|
||
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. | ||
|
||
--> | ||
<project xmlns="http://maven.apache.org/POM/4.0.0" | ||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
<parent> | ||
<artifactId>connector-http</artifactId> | ||
<groupId>org.apache.seatunnel</groupId> | ||
<version>${revision}</version> | ||
</parent> | ||
<modelVersion>4.0.0</modelVersion> | ||
|
||
<artifactId>connector-http-jira</artifactId> | ||
|
||
<dependencies> | ||
<dependency> | ||
<groupId>org.apache.seatunnel</groupId> | ||
<artifactId>connector-http-base</artifactId> | ||
<version>${project.version}</version> | ||
</dependency> | ||
</dependencies> | ||
|
||
</project> |
76 changes: 76 additions & 0 deletions
76
...-jira/src/main/java/org/apache/seatunnel/connectors/seatunnel/jira/source/JiraSource.java
This file contains 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,76 @@ | ||
/* | ||
* 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.seatunnel.connectors.seatunnel.jira.source; | ||
|
||
import static org.apache.seatunnel.connectors.seatunnel.http.util.AuthorizationUtil.getTokenByBasicAuth; | ||
|
||
import org.apache.seatunnel.api.common.PrepareFailException; | ||
import org.apache.seatunnel.api.source.Boundedness; | ||
import org.apache.seatunnel.api.source.SeaTunnelSource; | ||
import org.apache.seatunnel.api.table.type.SeaTunnelRow; | ||
import org.apache.seatunnel.common.config.CheckConfigUtil; | ||
import org.apache.seatunnel.common.config.CheckResult; | ||
import org.apache.seatunnel.common.constants.JobMode; | ||
import org.apache.seatunnel.common.constants.PluginType; | ||
import org.apache.seatunnel.connectors.seatunnel.common.source.AbstractSingleSplitReader; | ||
import org.apache.seatunnel.connectors.seatunnel.common.source.SingleSplitReaderContext; | ||
import org.apache.seatunnel.connectors.seatunnel.http.source.HttpSource; | ||
import org.apache.seatunnel.connectors.seatunnel.http.source.HttpSourceReader; | ||
import org.apache.seatunnel.connectors.seatunnel.jira.source.config.JiraSourceConfig; | ||
import org.apache.seatunnel.connectors.seatunnel.jira.source.config.JiraSourceParameter; | ||
|
||
import org.apache.seatunnel.shade.com.typesafe.config.Config; | ||
|
||
import com.google.auto.service.AutoService; | ||
import lombok.extern.slf4j.Slf4j; | ||
|
||
@Slf4j | ||
@AutoService(SeaTunnelSource.class) | ||
public class JiraSource extends HttpSource { | ||
private final JiraSourceParameter jiraSourceParameter = new JiraSourceParameter(); | ||
|
||
@Override | ||
public String getPluginName() { | ||
return "Jira"; | ||
} | ||
|
||
@Override | ||
public Boundedness getBoundedness() { | ||
if (JobMode.BATCH.equals(jobContext.getJobMode())) { | ||
return Boundedness.BOUNDED; | ||
} | ||
throw new UnsupportedOperationException("Jira source connector not support unbounded operation"); | ||
} | ||
|
||
@Override | ||
public void prepare(Config pluginConfig) throws PrepareFailException { | ||
CheckResult result = CheckConfigUtil.checkAllExists(pluginConfig, JiraSourceConfig.URL.key(), JiraSourceConfig.EMAIL.key(), JiraSourceConfig.API_TOKEN.key()); | ||
if (!result.isSuccess()) { | ||
throw new PrepareFailException(getPluginName(), PluginType.SOURCE, result.getMsg()); | ||
} | ||
//get accessToken by basic auth | ||
String accessToken = getTokenByBasicAuth(pluginConfig.getString(JiraSourceConfig.EMAIL.key()), pluginConfig.getString(JiraSourceConfig.API_TOKEN.key())); | ||
jiraSourceParameter.buildWithConfig(pluginConfig, accessToken); | ||
buildSchemaWithConfig(pluginConfig); | ||
} | ||
|
||
@Override | ||
public AbstractSingleSplitReader<SeaTunnelRow> createReader(SingleSplitReaderContext readerContext) throws Exception { | ||
return new HttpSourceReader(this.jiraSourceParameter, readerContext, this.deserializationSchema); | ||
} | ||
} |
56 changes: 56 additions & 0 deletions
56
...rc/main/java/org/apache/seatunnel/connectors/seatunnel/jira/source/JiraSourceFactory.java
This file contains 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,56 @@ | ||
/* | ||
* 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.seatunnel.connectors.seatunnel.jira.source; | ||
|
||
import org.apache.seatunnel.api.configuration.util.Condition; | ||
import org.apache.seatunnel.api.configuration.util.OptionRule; | ||
import org.apache.seatunnel.api.table.factory.Factory; | ||
import org.apache.seatunnel.api.table.factory.TableSourceFactory; | ||
import org.apache.seatunnel.connectors.seatunnel.common.schema.SeaTunnelSchema; | ||
import org.apache.seatunnel.connectors.seatunnel.http.config.HttpConfig; | ||
import org.apache.seatunnel.connectors.seatunnel.http.config.HttpRequestMethod; | ||
import org.apache.seatunnel.connectors.seatunnel.jira.source.config.JiraSourceConfig; | ||
|
||
import com.google.auto.service.AutoService; | ||
|
||
@AutoService(Factory.class) | ||
public class JiraSourceFactory implements TableSourceFactory { | ||
@Override | ||
public String factoryIdentifier() { | ||
return "Jira"; | ||
} | ||
|
||
@Override | ||
public OptionRule optionRule() { | ||
return OptionRule.builder() | ||
.required(JiraSourceConfig.URL) | ||
.required(JiraSourceConfig.EMAIL) | ||
.required(JiraSourceConfig.API_TOKEN) | ||
.optional(JiraSourceConfig.METHOD) | ||
.optional(JiraSourceConfig.HEADERS) | ||
.optional(JiraSourceConfig.PARAMS) | ||
.conditional(Condition.of(HttpConfig.METHOD, HttpRequestMethod.POST), JiraSourceConfig.BODY) | ||
.conditional(Condition.of(HttpConfig.FORMAT, "json"), SeaTunnelSchema.SCHEMA) | ||
.optional(JiraSourceConfig.FORMAT) | ||
.optional(JiraSourceConfig.POLL_INTERVAL_MILLS) | ||
.optional(JiraSourceConfig.RETRY) | ||
.optional(JiraSourceConfig.RETRY_BACKOFF_MAX_MS) | ||
.optional(JiraSourceConfig.RETRY_BACKOFF_MULTIPLIER_MS) | ||
.build(); | ||
} | ||
} |
35 changes: 35 additions & 0 deletions
35
...n/java/org/apache/seatunnel/connectors/seatunnel/jira/source/config/JiraSourceConfig.java
This file contains 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,35 @@ | ||
/* | ||
* 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.seatunnel.connectors.seatunnel.jira.source.config; | ||
|
||
import org.apache.seatunnel.api.configuration.Option; | ||
import org.apache.seatunnel.api.configuration.Options; | ||
import org.apache.seatunnel.connectors.seatunnel.http.config.HttpConfig; | ||
|
||
public class JiraSourceConfig extends HttpConfig { | ||
public static final String AUTHORIZATION = "Authorization"; | ||
public static final Option<String> EMAIL = Options.key("email") | ||
.stringType() | ||
.noDefaultValue() | ||
.withDescription("Jira email"); | ||
|
||
public static final Option<String> API_TOKEN = Options.key("api_token") | ||
.stringType() | ||
.noDefaultValue() | ||
.withDescription("Jira API Token"); | ||
} |
Oops, something went wrong.
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.
Add method?