test/DolphinScheduler
1
0
Fork 0
mirror of https://gitee.com/dolphinscheduler/DolphinScheduler.git synced 2024-11-29 18:58:05 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

[Feature][PyDolphinScheduler] Support DVC task in pyds #11922 (#11941)

Browse Source 
* add dvc task in pyds

* add BaseDVC class
This commit is contained in:
JieguangZhou 2022-09-17 16:55:51 +08:00 committed by GitHub
parent e50a32d9cc
commit bbc228e93f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with 487 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
dolphinscheduler-python/pydolphinscheduler/docs/source/tasks/dvc.rst Normal file
View File

@ -0,0 +1,41 @@
.. 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.
DVC
===
A DVC task type's example and dive into information of **PyDolphinScheduler**.
Example
-------
.. literalinclude:: ../../../src/pydolphinscheduler/examples/task_dvc_example.py
:start-after: [start workflow_declare]
:end-before: [end workflow_declare]
Dive Into
---------
.. automodule:: pydolphinscheduler.tasks.dvc
YAML file example
-----------------
.. literalinclude:: ../../../examples/yaml_define/Dvc.yaml
:start-after: # under the License.
:language: yaml

1
dolphinscheduler-python/pydolphinscheduler/docs/source/tasks/index.rst
View File

@ -44,3 +44,4 @@ In this section
sagemaker
openmldb
pytorch
dvc

46
dolphinscheduler-python/pydolphinscheduler/examples/yaml_define/Dvc.yaml Normal file
View File

@ -0,0 +1,46 @@
# 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.
# Define variable `repository`
repository: &repository "git@github.com:<YOUR-NAME-OR-ORG>/dvc-data-repository-example.git"
# Define the workflow
workflow:
name: "DVC"
release_state: "offline"
# Define the tasks under the process
tasks:
- name: init_dvc
task_type: DVCInit
repository: *repository
store_url: ~/dvc_data
- name: upload_data
task_type: DVCUpload
repository: *repository
data_path_in_dvc_repository: "iris"
data_path_in_worker: ~/source/iris
version: v1
message: upload iris data v1
- name: download_data
task_type: DVCDownload
repository: *repository
data_path_in_dvc_repository: "iris"
data_path_in_worker: ~/target/iris
version: v1

1
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/constants.py
View File

@ -60,6 +60,7 @@ class TaskType(str):
SAGEMAKER = "SAGEMAKER"
OPENMLDB = "OPENMLDB"
PYTORCH = "PYTORCH"
DVC = "DVC"
class DefaultTaskCodeNum(str):

52
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/examples/task_dvc_example.py Normal file
View File

@ -0,0 +1,52 @@
# 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.
# [start workflow_declare]
"""A example workflow for task dvc."""
from pydolphinscheduler.core.process_definition import ProcessDefinition
from pydolphinscheduler.tasks import DVCDownload, DVCInit, DVCUpload
repository = "git@github.com:<YOUR-NAME-OR-ORG>/dvc-data-repository-example.git"
with ProcessDefinition(
name="task_dvc_example",
tenant="tenant_exists",
) as pd:
init_task = DVCInit(name="init_dvc", repository=repository, store_url="~/dvc_data")
upload_task = DVCUpload(
name="upload_data",
repository=repository,
data_path_in_dvc_repository="iris",
data_path_in_worker="~/source/iris",
version="v1",
message="upload iris data v1",
)
download_task = DVCDownload(
name="download_data",
repository=repository,
data_path_in_dvc_repository="iris",
data_path_in_worker="~/target/iris",
version="v1",
)
init_task >> upload_task >> download_task
pd.run()
# [end workflow_declare]

4
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/tasks/__init__.py
View File

@ -20,6 +20,7 @@
from pydolphinscheduler.tasks.condition import FAILURE, SUCCESS, And, Condition, Or
from pydolphinscheduler.tasks.datax import CustomDataX, DataX
from pydolphinscheduler.tasks.dependent import Dependent
from pydolphinscheduler.tasks.dvc import DVCDownload, DVCInit, DVCUpload
from pydolphinscheduler.tasks.flink import Flink
from pydolphinscheduler.tasks.http import Http
from pydolphinscheduler.tasks.map_reduce import MR
@ -39,6 +40,9 @@ __all__ = [
"DataX",
"CustomDataX",
"Dependent",
"DVCInit",
"DVCUpload",
"DVCDownload",
"Flink",
"Http",
"MR",

124
dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/tasks/dvc.py Normal file
View File

@ -0,0 +1,124 @@
# 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.
"""Task dvc."""
from copy import deepcopy
from typing import Dict
from pydolphinscheduler.constants import TaskType
from pydolphinscheduler.core.task import Task
class DvcTaskType(str):
"""Constants for dvc task type."""
INIT = "Init DVC"
DOWNLOAD = "Download"
UPLOAD = "Upload"
class BaseDVC(Task):
"""Base class for dvc task."""
dvc_task_type = None
_task_custom_attr = {
"dvc_task_type",
"dvc_repository",
}
_child_task_dvc_attr = set()
def __init__(self, name: str, repository: str, *args, **kwargs):
super().__init__(name, TaskType.DVC, *args, **kwargs)
self.dvc_repository = repository
@property
def task_params(self) -> Dict:
"""Return task params."""
self._task_custom_attr = deepcopy(self._task_custom_attr)
self._task_custom_attr.update(self._child_task_dvc_attr)
return super().task_params
class DVCInit(BaseDVC):
"""Task DVC Init object, declare behavior for DVC Init task to dolphinscheduler."""
dvc_task_type = DvcTaskType.INIT
_child_task_dvc_attr = {"dvc_store_url"}
def __init__(self, name: str, repository: str, store_url: str, *args, **kwargs):
super().__init__(name, repository, *args, **kwargs)
self.dvc_store_url = store_url
class DVCDownload(BaseDVC):
"""Task DVC Download object, declare behavior for DVC Download task to dolphinscheduler."""
dvc_task_type = DvcTaskType.DOWNLOAD
_child_task_dvc_attr = {
"dvc_load_save_data_path",
"dvc_data_location",
"dvc_version",
}
def __init__(
self,
name: str,
repository: str,
data_path_in_dvc_repository: str,
data_path_in_worker: str,
version: str,
*args,
**kwargs
):
super().__init__(name, repository, *args, **kwargs)
self.dvc_data_location = data_path_in_dvc_repository
self.dvc_load_save_data_path = data_path_in_worker
self.dvc_version = version
class DVCUpload(BaseDVC):
"""Task DVC Upload object, declare behavior for DVC Upload task to dolphinscheduler."""
dvc_task_type = DvcTaskType.UPLOAD
_child_task_dvc_attr = {
"dvc_load_save_data_path",
"dvc_data_location",
"dvc_version",
"dvc_message",
}
def __init__(
self,
name: str,
repository: str,
data_path_in_worker: str,
data_path_in_dvc_repository: str,
version: str,
message: str,
*args,
**kwargs
):
super().__init__(name, repository, *args, **kwargs)
self.dvc_data_location = data_path_in_dvc_repository
self.dvc_load_save_data_path = data_path_in_worker
self.dvc_version = version
self.dvc_message = message

173
dolphinscheduler-python/pydolphinscheduler/tests/tasks/test_dvc.py Normal file
View File

@ -0,0 +1,173 @@
# 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 Task Dvc."""
from unittest.mock import patch
from pydolphinscheduler.constants import TaskType
from pydolphinscheduler.tasks.dvc import DVCDownload, DVCInit, DvcTaskType, DVCUpload
repository = "git@github.com:<YOUR-NAME-OR-ORG>/dvc-data-repository-example.git"
def test_dvc_init_get_define():
"""Test task dvc init function get_define."""
name = "test_dvc_init"
dvc_store_url = "~/dvc_data"
code = 123
version = 1
expect = {
"code": code,
"name": name,
"version": 1,
"description": None,
"delayTime": 0,
"taskType": TaskType.DVC,
"taskParams": {
"resourceList": [],
"localParams": [],
"dvcTaskType": DvcTaskType.INIT,
"dvcRepository": repository,
"dvcStoreUrl": dvc_store_url,
"dependence": {},
"conditionResult": {"successNode": [""], "failedNode": [""]},
"waitStartTimeout": {},
},
"flag": "YES",
"taskPriority": "MEDIUM",
"workerGroup": "default",
"environmentCode": None,
"failRetryTimes": 0,
"failRetryInterval": 1,
"timeoutFlag": "CLOSE",
"timeoutNotifyStrategy": None,
"timeout": 0,
}
with patch(
"pydolphinscheduler.core.task.Task.gen_code_and_version",
return_value=(code, version),
):
dvc_init = DVCInit(name, repository, dvc_store_url)
assert dvc_init.get_define() == expect
def test_dvc_upload_get_define():
"""Test task dvc upload function get_define."""
name = "test_dvc_upload"
data_path_in_dvc_repository = "iris"
data_path_in_worker = "~/source/iris"
version = "v1"
message = "upload iris data v1"
code = 123
version = 1
expect = {
"code": code,
"name": name,
"version": 1,
"description": None,
"delayTime": 0,
"taskType": TaskType.DVC,
"taskParams": {
"resourceList": [],
"localParams": [],
"dvcTaskType": DvcTaskType.UPLOAD,
"dvcRepository": repository,
"dvcDataLocation": data_path_in_dvc_repository,
"dvcLoadSaveDataPath": data_path_in_worker,
"dvcVersion": version,
"dvcMessage": message,
"dependence": {},
"conditionResult": {"successNode": [""], "failedNode": [""]},
"waitStartTimeout": {},
},
"flag": "YES",
"taskPriority": "MEDIUM",
"workerGroup": "default",
"environmentCode": None,
"failRetryTimes": 0,
"failRetryInterval": 1,
"timeoutFlag": "CLOSE",
"timeoutNotifyStrategy": None,
"timeout": 0,
}
with patch(
"pydolphinscheduler.core.task.Task.gen_code_and_version",
return_value=(code, version),
):
dvc_upload = DVCUpload(
name,
repository=repository,
data_path_in_dvc_repository=data_path_in_dvc_repository,
data_path_in_worker=data_path_in_worker,
version=version,
message=message,
)
assert dvc_upload.get_define() == expect
def test_dvc_download_get_define():
"""Test task dvc download function get_define."""
name = "test_dvc_upload"
data_path_in_dvc_repository = "iris"
data_path_in_worker = "~/target/iris"
version = "v1"
code = 123
version = 1
expect = {
"code": code,
"name": name,
"version": 1,
"description": None,
"delayTime": 0,
"taskType": TaskType.DVC,
"taskParams": {
"resourceList": [],
"localParams": [],
"dvcTaskType": DvcTaskType.DOWNLOAD,
"dvcRepository": repository,
"dvcDataLocation": data_path_in_dvc_repository,
"dvcLoadSaveDataPath": data_path_in_worker,
"dvcVersion": version,
"dependence": {},
"conditionResult": {"successNode": [""], "failedNode": [""]},
"waitStartTimeout": {},
},
"flag": "YES",
"taskPriority": "MEDIUM",
"workerGroup": "default",
"environmentCode": None,
"failRetryTimes": 0,
"failRetryInterval": 1,
"timeoutFlag": "CLOSE",
"timeoutNotifyStrategy": None,
"timeout": 0,
}
with patch(
"pydolphinscheduler.core.task.Task.gen_code_and_version",
return_value=(code, version),
):
dvc_download = DVCDownload(
name,
repository=repository,
data_path_in_dvc_repository=data_path_in_dvc_repository,
data_path_in_worker=data_path_in_worker,
version=version,
)
assert dvc_download.get_define() == expect

6
dolphinscheduler-task-plugin/dolphinscheduler-task-dvc/src/main/java/org/apache/dolphinscheduler/plugin/task/dvc/DvcConstants.java
View File

@ -22,6 +22,12 @@ public class DvcConstants {
throw new IllegalStateException("Utility class");
}
public static final class DVC_TASK_TYPE {
public static final String UPLOAD = "Upload";
public static final String DOWNLOAD = "Download";
public static final String INIT = "Init DVC";
};
public static final String CHECK_AND_SET_DVC_REPO = "which dvc || { echo \"dvc does not exist\"; exit 1; }; DVC_REPO=%s";
public static final String SET_DATA_PATH = "DVC_DATA_PATH=%s";

93
dolphinscheduler-task-plugin/dolphinscheduler-task-dvc/src/main/java/org/apache/dolphinscheduler/plugin/task/dvc/DvcParameters.java
View File

@ -17,15 +17,19 @@
package org.apache.dolphinscheduler.plugin.task.dvc;
import org.apache.dolphinscheduler.plugin.task.api.parameters.AbstractParameters;
import lombok.Data;
import org.apache.dolphinscheduler.plugin.task.api.parameters.AbstractParameters;
import org.apache.dolphinscheduler.spi.utils.StringUtils;
@Data
public class DvcParameters extends AbstractParameters {
/**
* common parameters
*/
private TaskTypeEnum dvcTaskType;
private String dvcTaskType;
private String dvcRepository;
@ -39,67 +43,34 @@ public class DvcParameters extends AbstractParameters {
private String dvcStoreUrl;
public void setDvcTaskType(TaskTypeEnum dvcTaskType) {
this.dvcTaskType = dvcTaskType;
}
public TaskTypeEnum getDvcTaskType() {
return dvcTaskType;
}
public void setDvcRepository(String dvcRepository) {
this.dvcRepository = dvcRepository;
}
public String getDvcRepository() {
return dvcRepository;
}
public void setDvcVersion(String dvcVersion) {
this.dvcVersion = dvcVersion;
}
public String getDvcVersion() {
return dvcVersion;
}
public void setDvcDataLocation(String dvcDataLocation) {
this.dvcDataLocation = dvcDataLocation;
}
public String getDvcDataLocation() {
return dvcDataLocation;
}
public void setDvcMessage(String dvcMessage) {
this.dvcMessage = dvcMessage;
}
public String getDvcMessage() {
return dvcMessage;
}
public void setDvcLoadSaveDataPath(String dvcLoadSaveDataPath) {
this.dvcLoadSaveDataPath = dvcLoadSaveDataPath;
}
public String getDvcLoadSaveDataPath() {
return dvcLoadSaveDataPath;
}
public void setDvcStoreUrl(String dvcStoreUrl) {
this.dvcStoreUrl = dvcStoreUrl;
}
public String getDvcStoreUrl() {
return dvcStoreUrl;
}
@Override
public boolean checkParameters() {
Boolean checkResult = true;
return checkResult;
}
if (StringUtils.isEmpty(dvcTaskType)) {
return false;
}
switch (dvcTaskType) {
case DvcConstants.DVC_TASK_TYPE.UPLOAD:
return StringUtils.isNotEmpty(dvcRepository) &&
StringUtils.isNotEmpty(dvcDataLocation) &&
StringUtils.isNotEmpty(dvcLoadSaveDataPath) &&
StringUtils.isNotEmpty(dvcVersion) &&
StringUtils.isNotEmpty(dvcMessage);
case DvcConstants.DVC_TASK_TYPE.DOWNLOAD:
return StringUtils.isNotEmpty(dvcRepository) &&
StringUtils.isNotEmpty(dvcDataLocation) &&
StringUtils.isNotEmpty(dvcLoadSaveDataPath) &&
StringUtils.isNotEmpty(dvcVersion);
case DvcConstants.DVC_TASK_TYPE.INIT:
return StringUtils.isNotEmpty(dvcRepository) &&
StringUtils.isNotEmpty(dvcStoreUrl);
default:
return false;
}
}
}

8
dolphinscheduler-task-plugin/dolphinscheduler-task-dvc/src/main/java/org/apache/dolphinscheduler/plugin/task/dvc/DvcTask.java
View File

@ -107,12 +107,12 @@ public class DvcTask extends AbstractTask {
public String buildCommand() {
String command = "";
TaskTypeEnum taskType = parameters.getDvcTaskType();
if (taskType == TaskTypeEnum.UPLOAD) {
String taskType = parameters.getDvcTaskType();
if (taskType.equals(DvcConstants.DVC_TASK_TYPE.UPLOAD)) {
command = buildUploadCommond();
} else if (taskType == TaskTypeEnum.DOWNLOAD) {
} else if (taskType.equals(DvcConstants.DVC_TASK_TYPE.DOWNLOAD)) {
command = buildDownCommond();
} else if (taskType == TaskTypeEnum.INIT) {
} else if (taskType.equals(DvcConstants.DVC_TASK_TYPE.INIT)) {
command = buildInitDvcCommond();
}
logger.info("Run DVC task with command: \n{}", command);

30
dolphinscheduler-task-plugin/dolphinscheduler-task-dvc/src/main/java/org/apache/dolphinscheduler/plugin/task/dvc/TaskTypeEnum.java
View File

@ -1,30 +0,0 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.dolphinscheduler.plugin.task.dvc;
import com.fasterxml.jackson.annotation.JsonProperty;
public enum TaskTypeEnum {
@JsonProperty("Upload")
UPLOAD,
@JsonProperty("Download")
DOWNLOAD,
@JsonProperty("Init DVC")
INIT
}

6
dolphinscheduler-task-plugin/dolphinscheduler-task-dvc/src/test/java/org/apache/dolphinscheduler/plugin/task/dvc/DvcTaskTest.java
View File

@ -124,7 +124,7 @@ public class DvcTaskTest {
private DvcParameters createUploadParameters() {
DvcParameters parameters = new DvcParameters();
parameters.setDvcTaskType(TaskTypeEnum.UPLOAD);
parameters.setDvcTaskType(DvcConstants.DVC_TASK_TYPE.UPLOAD);
parameters.setDvcRepository("git@github.com:<YOUR-NAME-OR-ORG>/dvc-data-repository-example");
parameters.setDvcLoadSaveDataPath("/home/<YOUR-NAME-OR-ORG>/test");
parameters.setDvcDataLocation("test");
@ -135,7 +135,7 @@ public class DvcTaskTest {
private DvcParameters createDownloadParameters() {
DvcParameters parameters = new DvcParameters();
parameters.setDvcTaskType(TaskTypeEnum.DOWNLOAD);
parameters.setDvcTaskType(DvcConstants.DVC_TASK_TYPE.DOWNLOAD);
parameters.setDvcRepository("git@github.com:<YOUR-NAME-OR-ORG>/dvc-data-repository-example");
parameters.setDvcLoadSaveDataPath("data");
parameters.setDvcDataLocation("iris");
@ -145,7 +145,7 @@ public class DvcTaskTest {
private DvcParameters createInitDvcParameters() {
DvcParameters parameters = new DvcParameters();
parameters.setDvcTaskType(TaskTypeEnum.INIT);
parameters.setDvcTaskType(DvcConstants.DVC_TASK_TYPE.INIT);
parameters.setDvcRepository("git@github.com:<YOUR-NAME-OR-ORG>/dvc-data-repository-example");
parameters.setDvcStoreUrl("~/.dvc_test");
return parameters;