You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by GitBox <gi...@apache.org> on 2022/09/07 08:56:02 UTC
[GitHub] [dolphinscheduler] xdu-chenrj opened a new pull request, #11831: [DSIP-13][Feature]github_resource_plugin
xdu-chenrj opened a new pull request, #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831
<!--Thanks very much for contributing to Apache DolphinScheduler. Please review https://dolphinscheduler.apache.org/en-us/community/development/pull-request.html before opening a pull request.-->
## Purpose of the pull request
<!--(For example: This pull request adds checkstyle plugin).-->
## Brief change log
<!--*(for example:)*
- *Add maven-checkstyle-plugin to root pom.xml*
-->
## Verify this pull request
<!--*(Please pick either of the following options)*-->
This pull request is code cleanup without any test coverage.
*(or)*
This pull request is already covered by existing tests, such as *(please describe tests)*.
(or)
This change added tests and can be verified as follows:
<!--*(example:)*
- *Added dolphinscheduler-dao tests for end-to-end.*
- *Added CronUtilsTest to verify the change.*
- *Manually verified the change by testing locally.* -->
(or)
If your pull request contain incompatible change, you should also add it to `docs/docs/en/guide/upgrede/incompatible.md`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] zhongjiajie commented on a diff in pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on code in PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#discussion_r967953922
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,109 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.resources_plugin.base.git import Git, GitFileInfo
+
+
+class GitHub(ResourcePlugin, Git):
Review Comment:
I also think `Github` is not the preferred name, but after we discuss it, @xdu-chenrj and I can not find any other better name for it. I think `githubhook` is too general, airflow use `hook` as an abstract mechanism before the operator, and it is not so suitable for this case
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] EricGao888 commented on a diff in pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
EricGao888 commented on code in PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#discussion_r967657919
##########
dolphinscheduler-python/pydolphinscheduler/tests/resources_plugin/test_github.py:
##########
@@ -0,0 +1,228 @@
+# 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.
+
+"""Test github resource plugin."""
+from unittest.mock import PropertyMock, patch
+
+import pytest
+
+from pydolphinscheduler.resources_plugin import GitHub
+from pydolphinscheduler.resources_plugin.base.git import GitFileInfo
+
+
+@pytest.mark.parametrize(
+ "attr, expected",
+ [
+ (
+ {
+ "user": "apache",
+ "repo_name": "dolphinscheduler",
+ "file_path": "script/install.sh",
+ "api": "https://api.github.com/repos/{user}/{repo_name}/contents/{file_path}",
+ },
+ "https://api.github.com/repos/apache/dolphinscheduler/contents/script/install.sh",
+ ),
+ ],
+)
+def test_github_build_req_api(attr, expected):
+ """Test the build_req_api function of the github resource plug-in."""
+ github = GitHub(prefix="prefix")
+ assert expected == github.build_req_api(**attr)
+
+
+@pytest.mark.parametrize(
+ "attr, expected",
+ [
+ (
+ "https://github.com/apache/dolphinscheduler/blob/dev/script/install.sh",
+ {
+ "_user": "apache",
+ "_repo_name": "dolphinscheduler",
+ "_branch": "dev",
+ "_file_path": "script/install.sh",
+ },
+ ),
+ (
+ "https://github.com/apache/dolphinscheduler/blob/master/pom.xml",
+ {
+ "_user": "apache",
+ "_repo_name": "dolphinscheduler",
+ "_branch": "master",
+ "_file_path": "pom.xml",
+ },
+ ),
+ (
+ "https://github.com/apache/dolphinscheduler/blob/1.3.9-release/docker/build/startup.sh",
+ {
+ "_user": "apache",
+ "_repo_name": "dolphinscheduler",
+ "_branch": "1.3.9-release",
+ "_file_path": "docker/build/startup.sh",
+ },
+ ),
+ ],
+)
+def test_github_get_git_file_info(attr, expected):
+ """Test the get_git_file_info function of the github resource plug-in."""
+ github = GitHub(prefix="prefix")
+ github.get_git_file_info(attr)
+ assert expected == github._git_file_info.__dict__
+
+
+@pytest.mark.parametrize(
+ "attr, expected",
+ [
+ (
+ (
+ {
+ "user": "apache",
+ "repo_name": "dolphinscheduler",
+ "file_path": "docker/build/startup.sh",
+ }
+ ),
+ "https://api.github.com/repos/apache/dolphinscheduler/contents/docker/build/startup.sh",
+ ),
+ (
+ (
+ {
+ "user": "apache",
+ "repo_name": "dolphinscheduler",
+ "file_path": "pom.xml",
+ }
+ ),
+ "https://api.github.com/repos/apache/dolphinscheduler/contents/pom.xml",
+ ),
+ (
+ (
+ {
+ "user": "apache",
+ "repo_name": "dolphinscheduler",
+ "file_path": "script/create-dolphinscheduler.sh",
+ }
+ ),
+ "https://api.github.com/repos/apache/dolphinscheduler/contents/script/create-dolphinscheduler.sh",
+ ),
+ ],
+)
+@patch(
+ "pydolphinscheduler.resources_plugin.github.GitHub._git_file_info",
+ new_callable=PropertyMock,
+)
+def test_github_get_req_url(m_git_file_info, attr, expected):
+ """Test the get_req_url function of the github resource plug-in."""
+ github = GitHub(prefix="prefix")
+ m_git_file_info.return_value = GitFileInfo(**attr)
+ assert expected == github.get_req_url()
+
+
+@pytest.mark.skip(reason="Lack of test environment, need stable repository")
Review Comment:
For unit tests, we usually decouple the external system. You may mock the interactions instead of calling the real `GitHub` APIs and focus on testing the logic within `github.read_file(attr)` function.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] xdu-chenrj commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
xdu-chenrj commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1244887188
> > > I find this is a DSIP feature, is there any design doc about this?
> >
> >
> > this is the child issue of #10911, and yes, we miss follow the DSIP process to introduce this feature to community, for more detail you can see in [#10911 (comment)](https://github.com/apache/dolphinscheduler/issues/10911#issuecomment-1243159426)
>
> Ok, it's better to add doc and flowchart, this can be added in another PR.
ok
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1242636693
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=coverage&view=list) No Coverage information
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=duplicated_lines_density&view=list) No Duplication information
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] xdu-chenrj commented on a diff in pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
xdu-chenrj commented on code in PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#discussion_r968003053
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/base/git.py:
##########
@@ -0,0 +1,110 @@
+# 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.
+
+"""DolphinScheduler GitFileInfo and Git object."""
+
+from abc import ABCMeta, abstractmethod
+from typing import Optional
+
+
+class GitFileInfo:
+ """A class that defines the details of GIT files.
+
+ :param user: A string representing the user the git file belongs to.
+ :param repo_name: A string representing the repository to which the git file belongs.
+ :param branch: A string representing the branch to which the git file belongs.
+ :param file_path: A string representing the git file path.
+ """
+
+ def __init__(
+ self,
+ user: Optional[str] = None,
+ repo_name: Optional[str] = None,
+ branch: Optional[str] = None,
+ file_path: Optional[str] = None,
+ *args,
+ **kwargs
+ ):
+ self._user = user
+ self._repo_name = repo_name
+ self._branch = branch
+ self._file_path = file_path
+
+ @property
+ def user(self) -> str:
+ """Get attribute user."""
+ return self._user
+
+ @property
+ def repo_name(self) -> str:
+ """Get attribute repo_name."""
+ return self._repo_name
+
+ @property
+ def branch(self) -> str:
+ """Get attribute branch."""
+ return self._branch
+
+ @property
+ def file_path(self) -> str:
Review Comment:
Thank you for your suggestion :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] xdu-chenrj commented on a diff in pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
xdu-chenrj commented on code in PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#discussion_r966675475
##########
dolphinscheduler-python/pydolphinscheduler/docs/source/resources_plugin/github.rst:
##########
@@ -0,0 +1,38 @@
+.. 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.
+
+GitHub
+======
+
+`GitHub` is a github resource plugin for pydolphinscheduler.
+
+When using a github resource plugin, you only need to add the `resource_plugin` parameter in the task subclass or workflow definition,
+such as `resource_plugin=GitHub(prefix="https://github.com/xxx", access_token="ghpxx")`.
+The token parameter is optional. You need to add it when your warehouse is a private warehouse.
+
+Basic auth is also supported, using such as `resource_plugin=GitHub(prefix="https://github.com/xxx", username="user", password="pwd")`.
+However, in basic auth, `password` is equal to personal access token.
+
+You can view this `document <https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token>`_
+when creating a token.
+
+For the specific use of resource plugins, you can see `How to use` in :doc:`./resource-plugin`
Review Comment:
I got it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] ruanwenjun commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
ruanwenjun commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1243861744
> > I find this is a DSIP feature, is there any design doc about this?
>
> this is the child issue of #10911, and yes, we miss follow the DSIP process to introduce this feature to community, for more detail you can see in [#10911 (comment)](https://github.com/apache/dolphinscheduler/issues/10911#issuecomment-1243159426)
Ok, it's better to add doc and flowchart, this can be added in another PR.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] xdu-chenrj commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
xdu-chenrj commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1242909382
> I find this is a DSIP feature, is there any design doc about this?
Teacher @zhongjiajie instructs me
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1242937740
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=coverage&view=list) No Coverage information
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=duplicated_lines_density&view=list) No Duplication information
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1243285431
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=coverage&view=list) No Coverage information
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=duplicated_lines_density&view=list) No Duplication information
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1242771687
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=coverage&view=list) No Coverage information
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=duplicated_lines_density&view=list) No Duplication information
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1239760458
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=coverage&view=list) No Coverage information
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=duplicated_lines_density&view=list) No Duplication information
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1240217030
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=coverage&view=list) No Coverage information
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=duplicated_lines_density&view=list) No Duplication information
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] xdu-chenrj commented on a diff in pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
xdu-chenrj commented on code in PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#discussion_r967679428
##########
dolphinscheduler-python/pydolphinscheduler/tests/resources_plugin/test_github.py:
##########
@@ -0,0 +1,228 @@
+# 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.
+
+"""Test github resource plugin."""
+from unittest.mock import PropertyMock, patch
+
+import pytest
+
+from pydolphinscheduler.resources_plugin import GitHub
+from pydolphinscheduler.resources_plugin.base.git import GitFileInfo
+
+
+@pytest.mark.parametrize(
+ "attr, expected",
+ [
+ (
+ {
+ "user": "apache",
+ "repo_name": "dolphinscheduler",
+ "file_path": "script/install.sh",
+ "api": "https://api.github.com/repos/{user}/{repo_name}/contents/{file_path}",
+ },
+ "https://api.github.com/repos/apache/dolphinscheduler/contents/script/install.sh",
+ ),
+ ],
+)
+def test_github_build_req_api(attr, expected):
+ """Test the build_req_api function of the github resource plug-in."""
+ github = GitHub(prefix="prefix")
+ assert expected == github.build_req_api(**attr)
+
+
+@pytest.mark.parametrize(
+ "attr, expected",
+ [
+ (
+ "https://github.com/apache/dolphinscheduler/blob/dev/script/install.sh",
+ {
+ "_user": "apache",
+ "_repo_name": "dolphinscheduler",
+ "_branch": "dev",
+ "_file_path": "script/install.sh",
+ },
+ ),
+ (
+ "https://github.com/apache/dolphinscheduler/blob/master/pom.xml",
+ {
+ "_user": "apache",
+ "_repo_name": "dolphinscheduler",
+ "_branch": "master",
+ "_file_path": "pom.xml",
+ },
+ ),
+ (
+ "https://github.com/apache/dolphinscheduler/blob/1.3.9-release/docker/build/startup.sh",
+ {
+ "_user": "apache",
+ "_repo_name": "dolphinscheduler",
+ "_branch": "1.3.9-release",
+ "_file_path": "docker/build/startup.sh",
+ },
+ ),
+ ],
+)
+def test_github_get_git_file_info(attr, expected):
+ """Test the get_git_file_info function of the github resource plug-in."""
+ github = GitHub(prefix="prefix")
+ github.get_git_file_info(attr)
+ assert expected == github._git_file_info.__dict__
+
+
+@pytest.mark.parametrize(
+ "attr, expected",
+ [
+ (
+ (
+ {
+ "user": "apache",
+ "repo_name": "dolphinscheduler",
+ "file_path": "docker/build/startup.sh",
+ }
+ ),
+ "https://api.github.com/repos/apache/dolphinscheduler/contents/docker/build/startup.sh",
+ ),
+ (
+ (
+ {
+ "user": "apache",
+ "repo_name": "dolphinscheduler",
+ "file_path": "pom.xml",
+ }
+ ),
+ "https://api.github.com/repos/apache/dolphinscheduler/contents/pom.xml",
+ ),
+ (
+ (
+ {
+ "user": "apache",
+ "repo_name": "dolphinscheduler",
+ "file_path": "script/create-dolphinscheduler.sh",
+ }
+ ),
+ "https://api.github.com/repos/apache/dolphinscheduler/contents/script/create-dolphinscheduler.sh",
+ ),
+ ],
+)
+@patch(
+ "pydolphinscheduler.resources_plugin.github.GitHub._git_file_info",
+ new_callable=PropertyMock,
+)
+def test_github_get_req_url(m_git_file_info, attr, expected):
+ """Test the get_req_url function of the github resource plug-in."""
+ github = GitHub(prefix="prefix")
+ m_git_file_info.return_value = GitFileInfo(**attr)
+ assert expected == github.get_req_url()
+
+
+@pytest.mark.skip(reason="Lack of test environment, need stable repository")
+@pytest.mark.parametrize(
+ "attr, expected",
+ [
+ (
+ "lombok.config",
+ "#\n"
+ "# Licensed to the Apache Software Foundation (ASF) under one or more\n"
+ "# contributor license agreements. See the NOTICE file distributed with\n"
+ "# this work for additional information regarding copyright ownership.\n"
+ "# The ASF licenses this file to You under the Apache License, Version 2.0\n"
+ '# (the "License"); you may not use this file except in compliance with\n'
+ "# the License. You may obtain a copy of the License at\n"
+ "#\n"
+ "# http://www.apache.org/licenses/LICENSE-2.0\n"
+ "#\n"
+ "# Unless required by applicable law or agreed to in writing, software\n"
+ '# distributed under the License is distributed on an "AS IS" BASIS,\n'
+ "# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n"
+ "# See the License for the specific language governing permissions and\n"
+ "# limitations under the License.\n"
+ "#\n"
+ "\n"
+ "lombok.addLombokGeneratedAnnotation = true\n",
+ ),
+ ],
+)
+def test_github_read_file(attr, expected):
+ """Test the read_file function of the github resource plug-in."""
+ github = GitHub(
+ prefix="https://github.com/apache/dolphinscheduler/blob/dev",
+ )
+ assert expected == github.read_file(attr)
+
+
+@pytest.mark.skip(reason="Lack of test environment, need stable repository")
+@pytest.mark.parametrize(
+ "attr, expected",
+ [
+ (
+ "https://github.com/apache/dolphinscheduler/blob/dev/lombok.config",
+ "#\n"
+ "# Licensed to the Apache Software Foundation (ASF) under one or more\n"
+ "# contributor license agreements. See the NOTICE file distributed with\n"
+ "# this work for additional information regarding copyright ownership.\n"
+ "# The ASF licenses this file to You under the Apache License, Version 2.0\n"
+ '# (the "License"); you may not use this file except in compliance with\n'
+ "# the License. You may obtain a copy of the License at\n"
+ "#\n"
+ "# http://www.apache.org/licenses/LICENSE-2.0\n"
+ "#\n"
+ "# Unless required by applicable law or agreed to in writing, software\n"
+ '# distributed under the License is distributed on an "AS IS" BASIS,\n'
+ "# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n"
+ "# See the License for the specific language governing permissions and\n"
+ "# limitations under the License.\n"
+ "#\n"
+ "\n"
+ "lombok.addLombokGeneratedAnnotation = true\n",
+ ),
+ ],
+)
+def test_github_req(attr, expected):
+ """Test the req function of the github resource plug-in."""
+ github = GitHub(
+ prefix="prefix",
+ )
+ assert expected == github.req(attr)
+
+
+@pytest.mark.skip(
Review Comment:
> Same as above.
Thank you for your suggestion.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1240556629
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=coverage&view=list) No Coverage information
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=duplicated_lines_density&view=list) No Duplication information
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1240555058
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=coverage&view=list) No Coverage information
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=duplicated_lines_density&view=list) No Duplication information
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] zhongjiajie commented on a diff in pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on code in PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#discussion_r967955969
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/base/git.py:
##########
@@ -0,0 +1,110 @@
+# 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.
+
+"""DolphinScheduler GitFileInfo and Git object."""
+
+from abc import ABCMeta, abstractmethod
+from typing import Optional
+
+
+class GitFileInfo:
+ """A class that defines the details of GIT files.
+
+ :param user: A string representing the user the git file belongs to.
+ :param repo_name: A string representing the repository to which the git file belongs.
+ :param branch: A string representing the branch to which the git file belongs.
+ :param file_path: A string representing the git file path.
+ """
+
+ def __init__(
+ self,
+ user: Optional[str] = None,
+ repo_name: Optional[str] = None,
+ branch: Optional[str] = None,
+ file_path: Optional[str] = None,
+ *args,
+ **kwargs
+ ):
+ self._user = user
+ self._repo_name = repo_name
+ self._branch = branch
+ self._file_path = file_path
+
+ @property
+ def user(self) -> str:
+ """Get attribute user."""
+ return self._user
+
+ @property
+ def repo_name(self) -> str:
+ """Get attribute repo_name."""
+ return self._repo_name
+
+ @property
+ def branch(self) -> str:
+ """Get attribute branch."""
+ return self._branch
+
+ @property
+ def file_path(self) -> str:
+ """Get attribute file_path."""
+ return self._file_path
+
+
+class GitHubFileInfo(GitFileInfo):
+ """A class that defines the details of GitHub files.
+
+ :param user: A string representing the user the GitHub file belongs to.
+ :param repo_name: A string representing the repository to which the GitHub file belongs.
+ :param branch: A string representing the branch to which the GitHub file belongs.
+ :param file_path: A string representing the GitHub file path.
+ """
+
+ def __init__(
+ self,
+ user: Optional[str] = None,
+ repo_name: Optional[str] = None,
+ branch: Optional[str] = None,
+ file_path: Optional[str] = None,
+ *args,
+ **kwargs
+ ):
+ super().__init__(
+ user=user,
+ repo_name=repo_name,
+ branch=branch,
+ file_path=file_path,
+ *args,
+ **kwargs
+ )
+
+
+# [start Git]
+class Git(object, metaclass=ABCMeta):
+ """An abstract class of online code warehouse based on git implementation."""
+
+ _git_file_info: Optional[GitFileInfo] = None
+
+ # [start abstractmethod git_file_info]
+ @abstractmethod
+ def get_git_file_info(self, path: str):
+ """Get the detailed information of GIT file according to the file URL."""
Review Comment:
we should better raise NotImplementedError when abstract method not implement, and do not forget to add unit test for it
```suggestion
"""Get the detailed information of GIT file according to the file URL."""
raise NotImplementedError
```
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/base/git.py:
##########
@@ -0,0 +1,110 @@
+# 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.
+
+"""DolphinScheduler GitFileInfo and Git object."""
+
+from abc import ABCMeta, abstractmethod
+from typing import Optional
+
+
+class GitFileInfo:
+ """A class that defines the details of GIT files.
+
+ :param user: A string representing the user the git file belongs to.
+ :param repo_name: A string representing the repository to which the git file belongs.
+ :param branch: A string representing the branch to which the git file belongs.
+ :param file_path: A string representing the git file path.
+ """
+
+ def __init__(
+ self,
+ user: Optional[str] = None,
+ repo_name: Optional[str] = None,
+ branch: Optional[str] = None,
+ file_path: Optional[str] = None,
+ *args,
+ **kwargs
+ ):
+ self._user = user
+ self._repo_name = repo_name
+ self._branch = branch
+ self._file_path = file_path
+
+ @property
+ def user(self) -> str:
+ """Get attribute user."""
+ return self._user
+
+ @property
+ def repo_name(self) -> str:
+ """Get attribute repo_name."""
+ return self._repo_name
+
+ @property
+ def branch(self) -> str:
+ """Get attribute branch."""
+ return self._branch
+
+ @property
+ def file_path(self) -> str:
Review Comment:
If your public and private attribute is the same, we should better use attribute name directly, like in L42 - L45 use
```py
self.user = user
self.repo_name = repo_name
self.branch = branch
self.file_path = file_path
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1240215400
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=coverage&view=list) No Coverage information
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=duplicated_lines_density&view=list) No Duplication information
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] xdu-chenrj commented on a diff in pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
xdu-chenrj commented on code in PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#discussion_r966682992
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,159 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.exceptions import PyResPluginException
+
+
+class GitHub(ResourcePlugin):
+ """GitHub object, declare GitHub resource plugin for task and workflow to dolphinscheduler.
+
+ :param prefix: A string representing the prefix of GitHub.
+
+ :param access_token: A string used for identity authentication of GitHub private warehouse.
+
+ :param username: A string representing the user of the warehouse.
+
+ :param password: A string representing the user password, it is equal to access_token.
+
+
+ """
+
+ # [start init_method]
+ def __init__(
+ self,
+ prefix: str,
+ access_token: Optional[str] = None,
+ username: Optional[str] = None,
+ password: Optional[str] = None,
+ *args,
+ **kwargs
+ ):
+ super().__init__(prefix, *args, **kwargs)
+ self.access_token = access_token
+ self.username = username
+ self.password = password
+
+ # [end init_method]
+
+ _req_api = "https://api.github.com/repos/{user}/{repo_name}/contents/{file_path}"
+
+ def build_req_api(
+ self,
+ user: str,
+ repo_name: str,
+ file_path: str,
+ api: str,
+ ):
+ """Build request file content API."""
+ api = api.replace("{user}", user)
+ api = api.replace("{repo_name}", repo_name)
+ api = api.replace("{file_path}", file_path)
+ return api
+
+ def url_join(self, prefix: str, suf: str):
+ """File url splicing."""
+ if prefix[-1] != "/":
+ prefix = prefix + "/"
+ if suf[0] == "/":
+ suf = suf[1:]
+ return urljoin(prefix + "/", suf)
Review Comment:
I totally agree.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1241608167
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=coverage&view=list) No Coverage information
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=duplicated_lines_density&view=list) No Duplication information
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] EricGao888 commented on a diff in pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
EricGao888 commented on code in PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#discussion_r967955728
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,109 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.resources_plugin.base.git import Git, GitFileInfo
+
+
+class GitHub(ResourcePlugin, Git):
Review Comment:
Sure, it make sense to me. Thanks for the explanation : )
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,109 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.resources_plugin.base.git import Git, GitFileInfo
+
+
+class GitHub(ResourcePlugin, Git):
Review Comment:
Sure, it makes sense to me. Thanks for the explanation : )
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] xdu-chenrj commented on a diff in pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
xdu-chenrj commented on code in PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#discussion_r967992218
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/base/git.py:
##########
@@ -0,0 +1,110 @@
+# 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.
+
+"""DolphinScheduler GitFileInfo and Git object."""
+
+from abc import ABCMeta, abstractmethod
+from typing import Optional
+
+
+class GitFileInfo:
+ """A class that defines the details of GIT files.
+
+ :param user: A string representing the user the git file belongs to.
+ :param repo_name: A string representing the repository to which the git file belongs.
+ :param branch: A string representing the branch to which the git file belongs.
+ :param file_path: A string representing the git file path.
+ """
+
+ def __init__(
+ self,
+ user: Optional[str] = None,
+ repo_name: Optional[str] = None,
+ branch: Optional[str] = None,
+ file_path: Optional[str] = None,
+ *args,
+ **kwargs
+ ):
+ self._user = user
+ self._repo_name = repo_name
+ self._branch = branch
+ self._file_path = file_path
+
+ @property
+ def user(self) -> str:
+ """Get attribute user."""
+ return self._user
+
+ @property
+ def repo_name(self) -> str:
+ """Get attribute repo_name."""
+ return self._repo_name
+
+ @property
+ def branch(self) -> str:
+ """Get attribute branch."""
+ return self._branch
+
+ @property
+ def file_path(self) -> str:
+ """Get attribute file_path."""
+ return self._file_path
+
+
+class GitHubFileInfo(GitFileInfo):
+ """A class that defines the details of GitHub files.
+
+ :param user: A string representing the user the GitHub file belongs to.
+ :param repo_name: A string representing the repository to which the GitHub file belongs.
+ :param branch: A string representing the branch to which the GitHub file belongs.
+ :param file_path: A string representing the GitHub file path.
+ """
+
+ def __init__(
+ self,
+ user: Optional[str] = None,
+ repo_name: Optional[str] = None,
+ branch: Optional[str] = None,
+ file_path: Optional[str] = None,
+ *args,
+ **kwargs
+ ):
+ super().__init__(
+ user=user,
+ repo_name=repo_name,
+ branch=branch,
+ file_path=file_path,
+ *args,
+ **kwargs
+ )
+
+
+# [start Git]
+class Git(object, metaclass=ABCMeta):
+ """An abstract class of online code warehouse based on git implementation."""
+
+ _git_file_info: Optional[GitFileInfo] = None
+
+ # [start abstractmethod git_file_info]
+ @abstractmethod
+ def get_git_file_info(self, path: str):
+ """Get the detailed information of GIT file according to the file URL."""
Review Comment:
Thank you for your suggestion
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] xdu-chenrj commented on a diff in pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
xdu-chenrj commented on code in PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#discussion_r967784176
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,109 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.resources_plugin.base.git import Git, GitFileInfo
+
+
+class GitHub(ResourcePlugin, Git):
Review Comment:
`GitHub` means `GitHub` resource plugin.
local resource plugin is named `Local`.
gitlab resource plugin is named `GitLab`.
It's hard to name.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] xdu-chenrj commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
xdu-chenrj commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1242909191
> I find this is a DSIP feature, is there any design doc about this?
Sorry, no
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1242918867
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=coverage&view=list) No Coverage information
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=duplicated_lines_density&view=list) No Duplication information
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] codecov-commenter commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
codecov-commenter commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1239281291
# [Codecov](https://codecov.io/gh/apache/dolphinscheduler/pull/11831?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) Report
> Merging [#11831](https://codecov.io/gh/apache/dolphinscheduler/pull/11831?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) (a9747fb) into [dev](https://codecov.io/gh/apache/dolphinscheduler/commit/444c7e6eb73d3754cf6e0d7220d373afa55457c7?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) (444c7e6) will **increase** coverage by `0.01%`.
> The diff coverage is `0.00%`.
```diff
@@ Coverage Diff @@
## dev #11831 +/- ##
============================================
+ Coverage 39.59% 39.60% +0.01%
Complexity 4711 4711
============================================
Files 1016 1016
Lines 38139 38120 -19
Branches 4259 4251 -8
============================================
- Hits 15101 15098 -3
+ Misses 21420 21405 -15
+ Partials 1618 1617 -1
```
| [Impacted Files](https://codecov.io/gh/apache/dolphinscheduler/pull/11831?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) | Coverage Δ | |
|---|---|---|
| [...org/apache/dolphinscheduler/alert/AlertServer.java](https://codecov.io/gh/apache/dolphinscheduler/pull/11831/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-ZG9scGhpbnNjaGVkdWxlci1hbGVydC9kb2xwaGluc2NoZWR1bGVyLWFsZXJ0LXNlcnZlci9zcmMvbWFpbi9qYXZhL29yZy9hcGFjaGUvZG9scGhpbnNjaGVkdWxlci9hbGVydC9BbGVydFNlcnZlci5qYXZh) | `51.28% <ø> (ø)` | |
| [.../org/apache/dolphinscheduler/common/Constants.java](https://codecov.io/gh/apache/dolphinscheduler/pull/11831/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-ZG9scGhpbnNjaGVkdWxlci1jb21tb24vc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2RvbHBoaW5zY2hlZHVsZXIvY29tbW9uL0NvbnN0YW50cy5qYXZh) | `78.26% <ø> (ø)` | |
| [...che/dolphinscheduler/common/utils/HadoopUtils.java](https://codecov.io/gh/apache/dolphinscheduler/pull/11831/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-ZG9scGhpbnNjaGVkdWxlci1jb21tb24vc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2RvbHBoaW5zY2hlZHVsZXIvY29tbW9uL3V0aWxzL0hhZG9vcFV0aWxzLmphdmE=) | `16.66% <0.00%> (+0.07%)` | :arrow_up: |
| [...er/master/dispatch/host/assign/RandomSelector.java](https://codecov.io/gh/apache/dolphinscheduler/pull/11831/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-ZG9scGhpbnNjaGVkdWxlci1tYXN0ZXIvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2RvbHBoaW5zY2hlZHVsZXIvc2VydmVyL21hc3Rlci9kaXNwYXRjaC9ob3N0L2Fzc2lnbi9SYW5kb21TZWxlY3Rvci5qYXZh) | `77.77% <0.00%> (-5.56%)` | :arrow_down: |
| [...rver/master/runner/task/BlockingTaskProcessor.java](https://codecov.io/gh/apache/dolphinscheduler/pull/11831/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-ZG9scGhpbnNjaGVkdWxlci1tYXN0ZXIvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2RvbHBoaW5zY2hlZHVsZXIvc2VydmVyL21hc3Rlci9ydW5uZXIvdGFzay9CbG9ja2luZ1Rhc2tQcm9jZXNzb3IuamF2YQ==) | `75.86% <0.00%> (-0.55%)` | :arrow_down: |
| [...eduler/api/service/impl/DataSourceServiceImpl.java](https://codecov.io/gh/apache/dolphinscheduler/pull/11831/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-ZG9scGhpbnNjaGVkdWxlci1hcGkvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2RvbHBoaW5zY2hlZHVsZXIvYXBpL3NlcnZpY2UvaW1wbC9EYXRhU291cmNlU2VydmljZUltcGwuamF2YQ==) | `27.90% <0.00%> (ø)` | |
| [...cheduler/server/master/utils/DependentExecute.java](https://codecov.io/gh/apache/dolphinscheduler/pull/11831/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-ZG9scGhpbnNjaGVkdWxlci1tYXN0ZXIvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2RvbHBoaW5zY2hlZHVsZXIvc2VydmVyL21hc3Rlci91dGlscy9EZXBlbmRlbnRFeGVjdXRlLmphdmE=) | `0.00% <0.00%> (ø)` | |
| [.../dolphinscheduler/plugin/task/datax/DataxTask.java](https://codecov.io/gh/apache/dolphinscheduler/pull/11831/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-ZG9scGhpbnNjaGVkdWxlci10YXNrLXBsdWdpbi9kb2xwaGluc2NoZWR1bGVyLXRhc2stZGF0YXgvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2RvbHBoaW5zY2hlZHVsZXIvcGx1Z2luL3Rhc2svZGF0YXgvRGF0YXhUYXNrLmphdmE=) | `0.00% <0.00%> (ø)` | |
| [...phinscheduler/plugin/task/chunjun/ChunJunTask.java](https://codecov.io/gh/apache/dolphinscheduler/pull/11831/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-ZG9scGhpbnNjaGVkdWxlci10YXNrLXBsdWdpbi9kb2xwaGluc2NoZWR1bGVyLXRhc2stY2h1bmp1bi9zcmMvbWFpbi9qYXZhL29yZy9hcGFjaGUvZG9scGhpbnNjaGVkdWxlci9wbHVnaW4vdGFzay9jaHVuanVuL0NodW5KdW5UYXNrLmphdmE=) | `0.00% <0.00%> (ø)` | |
| [...cheduler/plugin/task/api/ShellCommandExecutor.java](https://codecov.io/gh/apache/dolphinscheduler/pull/11831/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-ZG9scGhpbnNjaGVkdWxlci10YXNrLXBsdWdpbi9kb2xwaGluc2NoZWR1bGVyLXRhc2stYXBpL3NyYy9tYWluL2phdmEvb3JnL2FwYWNoZS9kb2xwaGluc2NoZWR1bGVyL3BsdWdpbi90YXNrL2FwaS9TaGVsbENvbW1hbmRFeGVjdXRvci5qYXZh) | `0.00% <0.00%> (ø)` | |
| ... and [8 more](https://codecov.io/gh/apache/dolphinscheduler/pull/11831/diff?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) | |
:mega: We’re building smart automated test selection to slash your CI/CD build times. [Learn more](https://about.codecov.io/iterative-testing/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] xdu-chenrj commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
xdu-chenrj commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1248844176
> > > I find this is a DSIP feature, is there any design doc about this?
> >
> >
> > this is the child issue of #10911, and yes, we miss follow the DSIP process to introduce this feature to community, for more detail you can see in [#10911 (comment)](https://github.com/apache/dolphinscheduler/issues/10911#issuecomment-1243159426)
>
> Ok, it's better to add doc and flowchart, this can be added in another PR.
I have sent a discussion email to dev@dolphinscheduler.apache.org, please check.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] EricGao888 commented on a diff in pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
EricGao888 commented on code in PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#discussion_r967656045
##########
dolphinscheduler-python/pydolphinscheduler/docs/source/resources_plugin/resource-plugin.rst:
##########
@@ -58,7 +58,7 @@ How to use
Resource plug-ins can be used in task subclasses and workflows. You can use the resource plug-ins by adding the `resource_plugin` parameter when they are initialized.
For example, local resource plug-ins, add `resource_plugin = Local("/tmp")`.
-The resource plug-ins we currently support is `local`.
+The resource plug-ins we currently support are `local`, 'github'.
Review Comment:
Maybe we could keep consistent with `plugins` or `plug-ins` but not use both of them in different places.
##########
dolphinscheduler-python/pydolphinscheduler/tests/resources_plugin/test_github.py:
##########
@@ -0,0 +1,228 @@
+# 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.
+
+"""Test github resource plugin."""
+from unittest.mock import PropertyMock, patch
+
+import pytest
+
+from pydolphinscheduler.resources_plugin import GitHub
+from pydolphinscheduler.resources_plugin.base.git import GitFileInfo
+
+
+@pytest.mark.parametrize(
+ "attr, expected",
+ [
+ (
+ {
+ "user": "apache",
+ "repo_name": "dolphinscheduler",
+ "file_path": "script/install.sh",
+ "api": "https://api.github.com/repos/{user}/{repo_name}/contents/{file_path}",
+ },
+ "https://api.github.com/repos/apache/dolphinscheduler/contents/script/install.sh",
+ ),
+ ],
+)
+def test_github_build_req_api(attr, expected):
+ """Test the build_req_api function of the github resource plug-in."""
+ github = GitHub(prefix="prefix")
+ assert expected == github.build_req_api(**attr)
+
+
+@pytest.mark.parametrize(
+ "attr, expected",
+ [
+ (
+ "https://github.com/apache/dolphinscheduler/blob/dev/script/install.sh",
+ {
+ "_user": "apache",
+ "_repo_name": "dolphinscheduler",
+ "_branch": "dev",
+ "_file_path": "script/install.sh",
+ },
+ ),
+ (
+ "https://github.com/apache/dolphinscheduler/blob/master/pom.xml",
+ {
+ "_user": "apache",
+ "_repo_name": "dolphinscheduler",
+ "_branch": "master",
+ "_file_path": "pom.xml",
+ },
+ ),
+ (
+ "https://github.com/apache/dolphinscheduler/blob/1.3.9-release/docker/build/startup.sh",
+ {
+ "_user": "apache",
+ "_repo_name": "dolphinscheduler",
+ "_branch": "1.3.9-release",
+ "_file_path": "docker/build/startup.sh",
+ },
+ ),
+ ],
+)
+def test_github_get_git_file_info(attr, expected):
+ """Test the get_git_file_info function of the github resource plug-in."""
+ github = GitHub(prefix="prefix")
+ github.get_git_file_info(attr)
+ assert expected == github._git_file_info.__dict__
+
+
+@pytest.mark.parametrize(
+ "attr, expected",
+ [
+ (
+ (
+ {
+ "user": "apache",
+ "repo_name": "dolphinscheduler",
+ "file_path": "docker/build/startup.sh",
+ }
+ ),
+ "https://api.github.com/repos/apache/dolphinscheduler/contents/docker/build/startup.sh",
+ ),
+ (
+ (
+ {
+ "user": "apache",
+ "repo_name": "dolphinscheduler",
+ "file_path": "pom.xml",
+ }
+ ),
+ "https://api.github.com/repos/apache/dolphinscheduler/contents/pom.xml",
+ ),
+ (
+ (
+ {
+ "user": "apache",
+ "repo_name": "dolphinscheduler",
+ "file_path": "script/create-dolphinscheduler.sh",
+ }
+ ),
+ "https://api.github.com/repos/apache/dolphinscheduler/contents/script/create-dolphinscheduler.sh",
+ ),
+ ],
+)
+@patch(
+ "pydolphinscheduler.resources_plugin.github.GitHub._git_file_info",
+ new_callable=PropertyMock,
+)
+def test_github_get_req_url(m_git_file_info, attr, expected):
+ """Test the get_req_url function of the github resource plug-in."""
+ github = GitHub(prefix="prefix")
+ m_git_file_info.return_value = GitFileInfo(**attr)
+ assert expected == github.get_req_url()
+
+
+@pytest.mark.skip(reason="Lack of test environment, need stable repository")
+@pytest.mark.parametrize(
+ "attr, expected",
+ [
+ (
+ "lombok.config",
+ "#\n"
+ "# Licensed to the Apache Software Foundation (ASF) under one or more\n"
+ "# contributor license agreements. See the NOTICE file distributed with\n"
+ "# this work for additional information regarding copyright ownership.\n"
+ "# The ASF licenses this file to You under the Apache License, Version 2.0\n"
+ '# (the "License"); you may not use this file except in compliance with\n'
+ "# the License. You may obtain a copy of the License at\n"
+ "#\n"
+ "# http://www.apache.org/licenses/LICENSE-2.0\n"
+ "#\n"
+ "# Unless required by applicable law or agreed to in writing, software\n"
+ '# distributed under the License is distributed on an "AS IS" BASIS,\n'
+ "# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n"
+ "# See the License for the specific language governing permissions and\n"
+ "# limitations under the License.\n"
+ "#\n"
+ "\n"
+ "lombok.addLombokGeneratedAnnotation = true\n",
+ ),
+ ],
+)
+def test_github_read_file(attr, expected):
+ """Test the read_file function of the github resource plug-in."""
+ github = GitHub(
+ prefix="https://github.com/apache/dolphinscheduler/blob/dev",
+ )
+ assert expected == github.read_file(attr)
+
+
+@pytest.mark.skip(reason="Lack of test environment, need stable repository")
+@pytest.mark.parametrize(
+ "attr, expected",
+ [
+ (
+ "https://github.com/apache/dolphinscheduler/blob/dev/lombok.config",
+ "#\n"
+ "# Licensed to the Apache Software Foundation (ASF) under one or more\n"
+ "# contributor license agreements. See the NOTICE file distributed with\n"
+ "# this work for additional information regarding copyright ownership.\n"
+ "# The ASF licenses this file to You under the Apache License, Version 2.0\n"
+ '# (the "License"); you may not use this file except in compliance with\n'
+ "# the License. You may obtain a copy of the License at\n"
+ "#\n"
+ "# http://www.apache.org/licenses/LICENSE-2.0\n"
+ "#\n"
+ "# Unless required by applicable law or agreed to in writing, software\n"
+ '# distributed under the License is distributed on an "AS IS" BASIS,\n'
+ "# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n"
+ "# See the License for the specific language governing permissions and\n"
+ "# limitations under the License.\n"
+ "#\n"
+ "\n"
+ "lombok.addLombokGeneratedAnnotation = true\n",
+ ),
+ ],
+)
+def test_github_req(attr, expected):
+ """Test the req function of the github resource plug-in."""
+ github = GitHub(
+ prefix="prefix",
+ )
+ assert expected == github.req(attr)
+
+
+@pytest.mark.skip(
Review Comment:
Same as above.
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,109 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.resources_plugin.base.git import Git, GitFileInfo
+
+
+class GitHub(ResourcePlugin, Git):
Review Comment:
Personally I would suggest using a different name for this class, maybe something like `GitHubHook` or other. `GitHub` is kind of ambiguous.
##########
dolphinscheduler-python/pydolphinscheduler/docs/source/resources_plugin/github.rst:
##########
@@ -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.
+
+GitHub
+======
+
+`GitHub` is a github resource plugin for pydolphinscheduler.
+
+When using a github resource plugin, you only need to add the `resource_plugin` parameter in the task subclass or workflow definition,
+such as `resource_plugin=GitHub(prefix="https://github.com/xxx", access_token="ghpxx")`.
+The token parameter is optional. You need to add it when your warehouse is a private warehouse.
Review Comment:
What is GitHub `warehouse`? Do you mean `repository`?
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,109 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.resources_plugin.base.git import Git, GitFileInfo
+
+
+class GitHub(ResourcePlugin, Git):
+ """GitHub resource plugin, a plugin for task and workflow to dolphinscheduler to read resource.
+
+ :param prefix: A string representing the prefix of GitHub.
+ :param access_token: A string used for identity authentication of GitHub private warehouse.
+ """
+
+ # [start init_method]
+ def __init__(
+ self, prefix: str, access_token: Optional[str] = None, *args, **kwargs
+ ):
+ super().__init__(prefix, *args, **kwargs)
+ self.access_token = access_token
+
+ # [end init_method]
+
+ def build_req_api(
+ self,
+ user: str,
+ repo_name: str,
+ file_path: str,
+ api: str,
+ ):
+ """Build request file content API."""
+ api = api.replace("{user}", user)
+ api = api.replace("{repo_name}", repo_name)
+ api = api.replace("{file_path}", file_path)
+ return api
+
+ def get_git_file_info(self, path: str):
+ """Get file information from the file url, like repository name, user, branch, and file path."""
+ elements = path.split("/")
+ index = self.get_index(path, "/", 7)
+ index = index + 1
+ file_info = GitFileInfo(
+ user=elements[3],
+ repo_name=elements[4],
+ branch=elements[6],
+ file_path=path[index:],
+ )
+ self._git_file_info = file_info
+
+ def get_req_url(self):
+ """Build request URL according to file information."""
+ return self.build_req_api(
+ user=self._git_file_info.user,
+ repo_name=self._git_file_info.repo_name,
+ file_path=self._git_file_info.file_path,
+ api="https://api.github.com/repos/{user}/{repo_name}/contents/{file_path}",
+ )
+
+ # [start read_file_method]
Review Comment:
Same as above. If function name has already indicated what it does, usually we do not need comments.
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,109 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.resources_plugin.base.git import Git, GitFileInfo
+
+
+class GitHub(ResourcePlugin, Git):
+ """GitHub resource plugin, a plugin for task and workflow to dolphinscheduler to read resource.
+
+ :param prefix: A string representing the prefix of GitHub.
+ :param access_token: A string used for identity authentication of GitHub private warehouse.
+ """
+
+ # [start init_method]
Review Comment:
Maybe we don't need this comment here. The same for `end init_method` comment.
##########
dolphinscheduler-python/pydolphinscheduler/tests/resources_plugin/test_github.py:
##########
@@ -0,0 +1,228 @@
+# 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.
+
+"""Test github resource plugin."""
+from unittest.mock import PropertyMock, patch
+
+import pytest
+
+from pydolphinscheduler.resources_plugin import GitHub
+from pydolphinscheduler.resources_plugin.base.git import GitFileInfo
+
+
+@pytest.mark.parametrize(
+ "attr, expected",
+ [
+ (
+ {
+ "user": "apache",
+ "repo_name": "dolphinscheduler",
+ "file_path": "script/install.sh",
+ "api": "https://api.github.com/repos/{user}/{repo_name}/contents/{file_path}",
+ },
+ "https://api.github.com/repos/apache/dolphinscheduler/contents/script/install.sh",
+ ),
+ ],
+)
+def test_github_build_req_api(attr, expected):
+ """Test the build_req_api function of the github resource plug-in."""
+ github = GitHub(prefix="prefix")
+ assert expected == github.build_req_api(**attr)
+
+
+@pytest.mark.parametrize(
+ "attr, expected",
+ [
+ (
+ "https://github.com/apache/dolphinscheduler/blob/dev/script/install.sh",
+ {
+ "_user": "apache",
+ "_repo_name": "dolphinscheduler",
+ "_branch": "dev",
+ "_file_path": "script/install.sh",
+ },
+ ),
+ (
+ "https://github.com/apache/dolphinscheduler/blob/master/pom.xml",
+ {
+ "_user": "apache",
+ "_repo_name": "dolphinscheduler",
+ "_branch": "master",
+ "_file_path": "pom.xml",
+ },
+ ),
+ (
+ "https://github.com/apache/dolphinscheduler/blob/1.3.9-release/docker/build/startup.sh",
+ {
+ "_user": "apache",
+ "_repo_name": "dolphinscheduler",
+ "_branch": "1.3.9-release",
+ "_file_path": "docker/build/startup.sh",
+ },
+ ),
+ ],
+)
+def test_github_get_git_file_info(attr, expected):
+ """Test the get_git_file_info function of the github resource plug-in."""
+ github = GitHub(prefix="prefix")
+ github.get_git_file_info(attr)
+ assert expected == github._git_file_info.__dict__
+
+
+@pytest.mark.parametrize(
+ "attr, expected",
+ [
+ (
+ (
+ {
+ "user": "apache",
+ "repo_name": "dolphinscheduler",
+ "file_path": "docker/build/startup.sh",
+ }
+ ),
+ "https://api.github.com/repos/apache/dolphinscheduler/contents/docker/build/startup.sh",
+ ),
+ (
+ (
+ {
+ "user": "apache",
+ "repo_name": "dolphinscheduler",
+ "file_path": "pom.xml",
+ }
+ ),
+ "https://api.github.com/repos/apache/dolphinscheduler/contents/pom.xml",
+ ),
+ (
+ (
+ {
+ "user": "apache",
+ "repo_name": "dolphinscheduler",
+ "file_path": "script/create-dolphinscheduler.sh",
+ }
+ ),
+ "https://api.github.com/repos/apache/dolphinscheduler/contents/script/create-dolphinscheduler.sh",
+ ),
+ ],
+)
+@patch(
+ "pydolphinscheduler.resources_plugin.github.GitHub._git_file_info",
+ new_callable=PropertyMock,
+)
+def test_github_get_req_url(m_git_file_info, attr, expected):
+ """Test the get_req_url function of the github resource plug-in."""
+ github = GitHub(prefix="prefix")
+ m_git_file_info.return_value = GitFileInfo(**attr)
+ assert expected == github.get_req_url()
+
+
+@pytest.mark.skip(reason="Lack of test environment, need stable repository")
Review Comment:
For unit tests, we usually decouple the external system. You may mock the interactions with the real `GitHub` and focus on testing the logic within `github.read_file(attr)` function.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1239287777
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=new_coverage&view=list) [0.0% Coverage](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=new_coverage&view=list)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=new_duplicated_lines_density&view=list) [0.0% Duplication](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=new_duplicated_lines_density&view=list)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] xdu-chenrj commented on a diff in pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
xdu-chenrj commented on code in PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#discussion_r965892715
##########
dolphinscheduler-python/pydolphinscheduler/docs/source/resources_plugin/github.rst:
##########
@@ -0,0 +1,38 @@
+.. 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.
+
+GitHub
+======
+
+`GitHub` is a github resource plugin for pydolphinscheduler.
+
+When using a github resource plugin, you only need to add the `resource_plugin` parameter in the task subclass or workflow definition,
+such as `resource_plugin=GitHub(prefix="https://github.com/xxx", access_token="ghpxx")`.
+The token parameter is optional. You need to add it when your warehouse is a private warehouse.
+
+Basic auth is also supported, using such as `resource_plugin=GitHub(prefix="https://github.com/xxx", username="user", password="pwd")`.
+However, in basic auth, `password` is equal to personal access token.
+
+You can view this `document <https://docs.github.com/cn/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#creating-a-token>`_
Review Comment:
>
thank you.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] xdu-chenrj commented on a diff in pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
xdu-chenrj commented on code in PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#discussion_r966686046
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,159 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.exceptions import PyResPluginException
+
+
+class GitHub(ResourcePlugin):
+ """GitHub object, declare GitHub resource plugin for task and workflow to dolphinscheduler.
+
+ :param prefix: A string representing the prefix of GitHub.
+
+ :param access_token: A string used for identity authentication of GitHub private warehouse.
+
Review Comment:
It means that only the class description is left, and the parameter description is deleted?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1242636937
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=coverage&view=list) No Coverage information
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=duplicated_lines_density&view=list) No Duplication information
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1242670860
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=coverage&view=list) No Coverage information
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=duplicated_lines_density&view=list) No Duplication information
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1242645000
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=coverage&view=list) No Coverage information
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=duplicated_lines_density&view=list) No Duplication information
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] xdu-chenrj commented on a diff in pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
xdu-chenrj commented on code in PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#discussion_r967779245
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,109 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.resources_plugin.base.git import Git, GitFileInfo
+
+
+class GitHub(ResourcePlugin, Git):
+ """GitHub resource plugin, a plugin for task and workflow to dolphinscheduler to read resource.
+
+ :param prefix: A string representing the prefix of GitHub.
+ :param access_token: A string used for identity authentication of GitHub private warehouse.
+ """
+
+ # [start init_method]
Review Comment:
Do you mean to delete [start init_method] and [end init_method]?
Or delete the class description
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1241606749
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=coverage&view=list) No Coverage information
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=duplicated_lines_density&view=list) No Duplication information
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1239289246
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=new_coverage&view=list) [0.0% Coverage](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=new_coverage&view=list)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=new_duplicated_lines_density&view=list) [0.0% Duplication](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=new_duplicated_lines_density&view=list)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1239756647
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=coverage&view=list) No Coverage information
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=duplicated_lines_density&view=list) No Duplication information
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] zhongjiajie commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1243160734
> I find this is a DSIP feature, is there any design doc about this?
this is the child issue of #10911, and yes, we miss follow the DSIP process to introduce this feature to community
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] ruanwenjun commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
ruanwenjun commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1242873884
I find this is a DSIP feature, is there any design doc about this?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] EricGao888 commented on a diff in pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
EricGao888 commented on code in PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#discussion_r967812545
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,109 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.resources_plugin.base.git import Git, GitFileInfo
+
+
+class GitHub(ResourcePlugin, Git):
Review Comment:
I do not have strong opinion here. If you could not come up with a better, we could use `GitHub` at this moment. That's fine to me.
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,109 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.resources_plugin.base.git import Git, GitFileInfo
+
+
+class GitHub(ResourcePlugin, Git):
Review Comment:
I do not have strong opinion here. If you could not come up with a better one, we could use `GitHub` at this moment. That's fine to me.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1243288589
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=coverage&view=list) No Coverage information
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=duplicated_lines_density&view=list) No Duplication information
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] zhongjiajie merged pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
zhongjiajie merged PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] kezhenxu94 commented on a diff in pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
kezhenxu94 commented on code in PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#discussion_r965881927
##########
dolphinscheduler-python/pydolphinscheduler/docs/source/resources_plugin/github.rst:
##########
@@ -0,0 +1,38 @@
+.. 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.
+
+GitHub
+======
+
+`GitHub` is a github resource plugin for pydolphinscheduler.
+
+When using a github resource plugin, you only need to add the `resource_plugin` parameter in the task subclass or workflow definition,
+such as `resource_plugin=GitHub(prefix="https://github.com/xxx", access_token="ghpxx")`.
+The token parameter is optional. You need to add it when your warehouse is a private warehouse.
+
+Basic auth is also supported, using such as `resource_plugin=GitHub(prefix="https://github.com/xxx", username="user", password="pwd")`.
+However, in basic auth, `password` is equal to personal access token.
+
+You can view this `document <https://docs.github.com/cn/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#creating-a-token>`_
Review Comment:
```suggestion
You can view this `document <https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token>`_
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] xdu-chenrj commented on a diff in pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
xdu-chenrj commented on code in PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#discussion_r966686486
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,159 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.exceptions import PyResPluginException
+
+
+class GitHub(ResourcePlugin):
+ """GitHub object, declare GitHub resource plugin for task and workflow to dolphinscheduler.
Review Comment:
ok.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] zhongjiajie commented on a diff in pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on code in PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#discussion_r966615920
##########
dolphinscheduler-python/pydolphinscheduler/docs/source/resources_plugin/resource-plugin.rst:
##########
@@ -58,7 +58,7 @@ How to use
Resource plug-ins can be used in task subclasses and workflows. You can use the resource plug-ins by adding the `resource_plugin` parameter when they are initialized.
For example, local resource plug-ins, add `resource_plugin = Local("/tmp")`.
-The resource plug-ins we currently support is `local`.
+The resource plug-ins we currently support are `local`, 'github'.
Review Comment:
Keep in the same format
```suggestion
The resource plug-ins we currently support are `local`, `github`.
```
##########
dolphinscheduler-python/pydolphinscheduler/docs/source/resources_plugin/github.rst:
##########
@@ -0,0 +1,38 @@
+.. 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.
+
+GitHub
+======
+
+`GitHub` is a github resource plugin for pydolphinscheduler.
+
+When using a github resource plugin, you only need to add the `resource_plugin` parameter in the task subclass or workflow definition,
+such as `resource_plugin=GitHub(prefix="https://github.com/xxx", access_token="ghpxx")`.
+The token parameter is optional. You need to add it when your warehouse is a private warehouse.
+
+Basic auth is also supported, using such as `resource_plugin=GitHub(prefix="https://github.com/xxx", username="user", password="pwd")`.
+However, in basic auth, `password` is equal to personal access token.
+
+You can view this `document <https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token>`_
+when creating a token.
+
+For the specific use of resource plugins, you can see `How to use` in :doc:`./resource-plugin`
Review Comment:
We can directly use `resource-plugin` in this case
```suggestion
For the specific use of resource plugins, you can see `How to use` in :doc:`resource-plugin`
```
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,159 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.exceptions import PyResPluginException
+
+
+class GitHub(ResourcePlugin):
+ """GitHub object, declare GitHub resource plugin for task and workflow to dolphinscheduler.
+
+ :param prefix: A string representing the prefix of GitHub.
+
+ :param access_token: A string used for identity authentication of GitHub private warehouse.
+
+ :param username: A string representing the user of the warehouse.
+
Review Comment:
```suggestion
```
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,159 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.exceptions import PyResPluginException
+
+
+class GitHub(ResourcePlugin):
+ """GitHub object, declare GitHub resource plugin for task and workflow to dolphinscheduler.
+
+ :param prefix: A string representing the prefix of GitHub.
+
+ :param access_token: A string used for identity authentication of GitHub private warehouse.
+
+ :param username: A string representing the user of the warehouse.
+
+ :param password: A string representing the user password, it is equal to access_token.
+
+
+ """
+
+ # [start init_method]
+ def __init__(
+ self,
+ prefix: str,
+ access_token: Optional[str] = None,
+ username: Optional[str] = None,
+ password: Optional[str] = None,
+ *args,
+ **kwargs
+ ):
+ super().__init__(prefix, *args, **kwargs)
+ self.access_token = access_token
+ self.username = username
+ self.password = password
+
+ # [end init_method]
+
+ _req_api = "https://api.github.com/repos/{user}/{repo_name}/contents/{file_path}"
+
+ def build_req_api(
+ self,
+ user: str,
+ repo_name: str,
+ file_path: str,
+ api: str,
+ ):
+ """Build request file content API."""
+ api = api.replace("{user}", user)
+ api = api.replace("{repo_name}", repo_name)
+ api = api.replace("{file_path}", file_path)
+ return api
+
+ def url_join(self, prefix: str, suf: str):
+ """File url splicing."""
+ if prefix[-1] != "/":
+ prefix = prefix + "/"
+ if suf[0] == "/":
+ suf = suf[1:]
+ return urljoin(prefix + "/", suf)
Review Comment:
Do we have other method to solve this case? it seems a little ugly by this way
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,159 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.exceptions import PyResPluginException
+
+
+class GitHub(ResourcePlugin):
+ """GitHub object, declare GitHub resource plugin for task and workflow to dolphinscheduler.
+
+ :param prefix: A string representing the prefix of GitHub.
+
+ :param access_token: A string used for identity authentication of GitHub private warehouse.
+
+ :param username: A string representing the user of the warehouse.
+
+ :param password: A string representing the user password, it is equal to access_token.
+
+
Review Comment:
```suggestion
```
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,159 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.exceptions import PyResPluginException
+
+
+class GitHub(ResourcePlugin):
+ """GitHub object, declare GitHub resource plugin for task and workflow to dolphinscheduler.
+
+ :param prefix: A string representing the prefix of GitHub.
+
Review Comment:
```suggestion
```
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,159 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.exceptions import PyResPluginException
+
+
+class GitHub(ResourcePlugin):
+ """GitHub object, declare GitHub resource plugin for task and workflow to dolphinscheduler.
+
+ :param prefix: A string representing the prefix of GitHub.
+
+ :param access_token: A string used for identity authentication of GitHub private warehouse.
+
+ :param username: A string representing the user of the warehouse.
+
+ :param password: A string representing the user password, it is equal to access_token.
+
+
+ """
+
+ # [start init_method]
+ def __init__(
+ self,
+ prefix: str,
+ access_token: Optional[str] = None,
+ username: Optional[str] = None,
+ password: Optional[str] = None,
+ *args,
+ **kwargs
+ ):
+ super().__init__(prefix, *args, **kwargs)
+ self.access_token = access_token
+ self.username = username
+ self.password = password
+
+ # [end init_method]
+
+ _req_api = "https://api.github.com/repos/{user}/{repo_name}/contents/{file_path}"
Review Comment:
I find `_req_api` only use in function `build_req_api`, can we move into this function, and then replace the replace to f-strings?
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,159 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.exceptions import PyResPluginException
+
+
+class GitHub(ResourcePlugin):
+ """GitHub object, declare GitHub resource plugin for task and workflow to dolphinscheduler.
Review Comment:
```suggestion
"""GitHub resource plugin, a plugin for task and workflow to dolphinscheduler to read resource.
```
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,159 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.exceptions import PyResPluginException
+
+
+class GitHub(ResourcePlugin):
+ """GitHub object, declare GitHub resource plugin for task and workflow to dolphinscheduler.
+
+ :param prefix: A string representing the prefix of GitHub.
+
+ :param access_token: A string used for identity authentication of GitHub private warehouse.
+
+ :param username: A string representing the user of the warehouse.
+
+ :param password: A string representing the user password, it is equal to access_token.
+
+
+ """
+
+ # [start init_method]
+ def __init__(
+ self,
+ prefix: str,
+ access_token: Optional[str] = None,
+ username: Optional[str] = None,
+ password: Optional[str] = None,
+ *args,
+ **kwargs
+ ):
+ super().__init__(prefix, *args, **kwargs)
+ self.access_token = access_token
+ self.username = username
+ self.password = password
+
+ # [end init_method]
+
+ _req_api = "https://api.github.com/repos/{user}/{repo_name}/contents/{file_path}"
+
+ def build_req_api(
+ self,
+ user: str,
+ repo_name: str,
+ file_path: str,
+ api: str,
+ ):
+ """Build request file content API."""
+ api = api.replace("{user}", user)
+ api = api.replace("{repo_name}", repo_name)
+ api = api.replace("{file_path}", file_path)
+ return api
+
+ def url_join(self, prefix: str, suf: str):
+ """File url splicing."""
+ if prefix[-1] != "/":
+ prefix = prefix + "/"
+ if suf[0] == "/":
+ suf = suf[1:]
+ return urljoin(prefix + "/", suf)
+
+ def get_index(self, s: str, x, n):
+ """Find the subscript of the nth occurrence of the X character in the string s."""
+ if n <= s.count(x):
+ all_index = [key for key, value in enumerate(s) if value == x]
+ return all_index[n - 1]
+ else:
+ return None
+
+ def get_file_info(self, path: str):
+ """Get file information from the file url, like repository name, user, branch, and file path."""
+ elements = path.split("/")
+ index = self.get_index(path, "/", 7)
+ if index is None:
+ raise PyResPluginException("Incomplete path.")
+ index = index + 1
+ file_info = {
+ "user": elements[3],
+ "repo_name": elements[4],
+ "branch": elements[6],
+ "file_path": path[index:],
+ }
+ return file_info
+
+ def get_req_url(self, file_info: dict):
+ """Build request URL according to file information."""
+ user = file_info["user"]
+ repo_name = file_info["repo_name"]
+ file_path = file_info["file_path"]
+ url = self.build_req_api(user, repo_name, file_path, self._req_api)
+ return url
+
+ # [start read_file_method]
+ def read_file(self, suf: str):
+ """Get the content of the file.
+
+ The address of the file is the prefix of the resource plugin plus the parameter suf.
+ """
+ path = self.url_join(self.prefix, suf)
+ return self.req(path)
+
+ # [end read_file_method]
+
+ def req(self, path: str):
+ """Send HTTP request, parse response data, and get file content."""
+ headers = {
+ "user-agent": "Mozilla/5.0 (X11; Linux x86_64) "
+ "AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36",
+ "Content-Type": "application/json; charset=utf-8",
+ }
+ if self.access_token is not None:
+ headers.setdefault("Authorization", "Bearer %s" % self.access_token)
+ if self.username is not None and self.password is not None:
+ base64string = base64.b64encode(
+ bytes("%s:%s" % (self.username, self.password), encoding="utf-8")
+ )
+ headers.setdefault(
+ "Authorization", "Basic %s" % base64string.decode("utf-8")
+ )
+
+ file_info = self.get_file_info(path)
+ url = self.get_req_url(file_info)
+ params = {"ref": file_info["branch"]}
+ response = requests.get(
+ headers=headers,
+ url=url,
+ params=params,
+ )
+ if response.status_code == requests.codes.ok:
+ json_response = response.json()
+ content = base64.b64decode(json_response["content"])
+ return content.decode("utf-8")
+ else:
+ if response.status_code == requests.codes.not_found:
+ raise PyResPluginException("{} is not found.".format(path))
+ if response.status_code == requests.codes.unauthorized:
+ raise PyResPluginException("unauthorized.")
+ raise PyResPluginException("Unknown exception.")
Review Comment:
we should raise the original error message from response
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,159 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.exceptions import PyResPluginException
+
+
+class GitHub(ResourcePlugin):
+ """GitHub object, declare GitHub resource plugin for task and workflow to dolphinscheduler.
+
+ :param prefix: A string representing the prefix of GitHub.
+
+ :param access_token: A string used for identity authentication of GitHub private warehouse.
+
Review Comment:
```suggestion
```
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,159 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.exceptions import PyResPluginException
+
+
+class GitHub(ResourcePlugin):
+ """GitHub object, declare GitHub resource plugin for task and workflow to dolphinscheduler.
+
+ :param prefix: A string representing the prefix of GitHub.
+
+ :param access_token: A string used for identity authentication of GitHub private warehouse.
+
+ :param username: A string representing the user of the warehouse.
+
+ :param password: A string representing the user password, it is equal to access_token.
+
+
+ """
+
+ # [start init_method]
+ def __init__(
+ self,
+ prefix: str,
+ access_token: Optional[str] = None,
+ username: Optional[str] = None,
+ password: Optional[str] = None,
+ *args,
+ **kwargs
+ ):
+ super().__init__(prefix, *args, **kwargs)
+ self.access_token = access_token
+ self.username = username
+ self.password = password
+
+ # [end init_method]
+
+ _req_api = "https://api.github.com/repos/{user}/{repo_name}/contents/{file_path}"
+
+ def build_req_api(
+ self,
+ user: str,
+ repo_name: str,
+ file_path: str,
+ api: str,
+ ):
+ """Build request file content API."""
+ api = api.replace("{user}", user)
+ api = api.replace("{repo_name}", repo_name)
+ api = api.replace("{file_path}", file_path)
+ return api
+
+ def url_join(self, prefix: str, suf: str):
+ """File url splicing."""
+ if prefix[-1] != "/":
+ prefix = prefix + "/"
+ if suf[0] == "/":
+ suf = suf[1:]
+ return urljoin(prefix + "/", suf)
+
+ def get_index(self, s: str, x, n):
+ """Find the subscript of the nth occurrence of the X character in the string s."""
+ if n <= s.count(x):
+ all_index = [key for key, value in enumerate(s) if value == x]
+ return all_index[n - 1]
+ else:
+ return None
+
+ def get_file_info(self, path: str):
+ """Get file information from the file url, like repository name, user, branch, and file path."""
+ elements = path.split("/")
+ index = self.get_index(path, "/", 7)
+ if index is None:
+ raise PyResPluginException("Incomplete path.")
+ index = index + 1
+ file_info = {
+ "user": elements[3],
+ "repo_name": elements[4],
+ "branch": elements[6],
+ "file_path": path[index:],
+ }
+ return file_info
+
+ def get_req_url(self, file_info: dict):
+ """Build request URL according to file information."""
+ user = file_info["user"]
+ repo_name = file_info["repo_name"]
+ file_path = file_info["file_path"]
+ url = self.build_req_api(user, repo_name, file_path, self._req_api)
+ return url
+
+ # [start read_file_method]
+ def read_file(self, suf: str):
+ """Get the content of the file.
+
+ The address of the file is the prefix of the resource plugin plus the parameter suf.
+ """
+ path = self.url_join(self.prefix, suf)
+ return self.req(path)
+
+ # [end read_file_method]
+
+ def req(self, path: str):
+ """Send HTTP request, parse response data, and get file content."""
+ headers = {
+ "user-agent": "Mozilla/5.0 (X11; Linux x86_64) "
+ "AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36",
+ "Content-Type": "application/json; charset=utf-8",
+ }
Review Comment:
maybe we should not specific the header, and export this parameter to user themself. WDTY?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1242670506
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=coverage&view=list) No Coverage information
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=duplicated_lines_density&view=list) No Duplication information
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1242772557
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=coverage&view=list) No Coverage information
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=duplicated_lines_density&view=list) No Duplication information
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1242644905
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=coverage&view=list) No Coverage information
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=duplicated_lines_density&view=list) No Duplication information
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1242938618
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=coverage&view=list) No Coverage information
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=duplicated_lines_density&view=list) No Duplication information
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] sonarcloud[bot] commented on pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#issuecomment-1242920105
Kudos, SonarCloud Quality Gate passed! [](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler&pullRequest=11831)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=apache-dolphinscheduler&pullRequest=11831&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=coverage&view=list) No Coverage information
[](https://sonarcloud.io/component_measures?id=apache-dolphinscheduler&pullRequest=11831&metric=duplicated_lines_density&view=list) No Duplication information
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] EricGao888 commented on a diff in pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
EricGao888 commented on code in PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#discussion_r967812662
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,109 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.resources_plugin.base.git import Git, GitFileInfo
+
+
+class GitHub(ResourcePlugin, Git):
+ """GitHub resource plugin, a plugin for task and workflow to dolphinscheduler to read resource.
+
+ :param prefix: A string representing the prefix of GitHub.
+ :param access_token: A string used for identity authentication of GitHub private warehouse.
+ """
+
+ # [start init_method]
Review Comment:
Just the comments.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] xdu-chenrj commented on a diff in pull request #11831: [DSIP-13][Feature]github_resource_plugin
Posted by GitBox <gi...@apache.org>.
xdu-chenrj commented on code in PR #11831:
URL: https://github.com/apache/dolphinscheduler/pull/11831#discussion_r967998361
##########
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/resources_plugin/github.py:
##########
@@ -0,0 +1,109 @@
+# 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.
+
+"""DolphinScheduler github resource plugin."""
+import base64
+from typing import Optional
+from urllib.parse import urljoin
+
+import requests
+
+from pydolphinscheduler.core.resource_plugin import ResourcePlugin
+from pydolphinscheduler.resources_plugin.base.git import Git, GitFileInfo
+
+
+class GitHub(ResourcePlugin, Git):
Review Comment:
Thank you, : )
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org