1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#############################################################################
##
## Copyright (C) 2022 The Qt Company Ltd.
## Contact: https://www.qt.io/licensing/
##
## This file is part of the release tools of the Qt Toolkit.
##
## $QT_BEGIN_LICENSE:GPL-EXCEPT$
## Commercial License Usage
## Licensees holding valid commercial Qt licenses may use this file in
## accordance with the commercial license agreement provided with the
## Software or, alternatively, in accordance with the terms contained in
## a written agreement between you and The Qt Company. For licensing terms
## and conditions see https://www.qt.io/terms-conditions. For further
## information use the contact form at https://www.qt.io/contact-us.
##
## GNU General Public License Usage
## Alternatively, this file may be used under the terms of the GNU
## General Public License version 3 as published by the Free Software
## Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
## included in the packaging of this file. Please review the following
## information to ensure the GNU General Public License requirements will
## be met: https://www.gnu.org/licenses/gpl-3.0.html.
##
## $QT_END_LICENSE$
##
#############################################################################
import os
import sys
import argparse
import platform
import subprocess
from shutil import which
class RemoteUploaderError(Exception):
pass
class RemoteUploader:
"""RemoteUploader can be used to upload given file(s) to remote network disk."""
def __init__(self, dryRun, remoteServer, remoteServerUserName, remoteBasePath):
self.dryRun = dryRun
self.set_tools(remoteServer, remoteServerUserName)
self.remoteLogin = remoteServerUserName + '@' + remoteServer
self.remoteTargetBaseDir = remoteBasePath
self.init_finished = False
def set_tools(self, remoteServer, remoteServerUserName):
self.ssh_cmd = ['ssh', '-o', 'GSSAPIAuthentication=no', '-o', 'StrictHostKeyChecking=no', remoteServerUserName + '@' + remoteServer]
system = platform.system().lower()
if "windows" in system:
if not which("scp"):
raise RemoteUploaderError("'scp' tool not found from PATH")
self.copy_cmd = ['scp']
else:
if not which("rsync"):
raise RemoteUploaderError("'rsync' tool not found from PATH")
self.copy_cmd = ['rsync']
def init_snapshot_upload_path(self, projectName, version, snapshotId):
assert not self.init_finished, "Already initialized as: {0}".format(self.remoteTargetDir)
self.remoteTargetDir = self.remoteTargetBaseDir + "/" + projectName + "/" + version + "/" + snapshotId
self.remoteLatestLink = self.remoteTargetBaseDir + "/" + projectName + "/" + version + "/latest"
self.init_finished = True
self.ensureRemoteDir(self.remoteTargetDir)
def init_upload_path(self, remotePath):
assert not self.init_finished, "Already initialized as: {0}".format(self.remoteTargetDir)
self.remoteTargetDir = self.remoteTargetBaseDir + "/" + remotePath
self.init_finished = True
self.ensureRemoteDir(self.remoteTargetDir)
def ensureRemoteDir(self, remoteDir):
assert self.init_finished, "RemoteUploader not initialized!"
print("Creating remote directory: {0}".format(remoteDir))
cmd = self.ssh_cmd + ['mkdir', '-p', remoteDir]
print("Executing: ", ' '.join(cmd))
if not self.dryRun:
subprocess.check_call(cmd, timeout=60) # give it 60s
def _copyToRemote(self, fileName, destDirName):
assert self.init_finished, "RemoteUploader not initialized!"
"""Copy the given file to destDirName which is relative to remoteBasePath."""
remoteDestination = self.remoteLogin + ':' + self.remoteTargetDir
if destDirName:
remoteDestination = remoteDestination + '/' + destDirName + '/'
if "windows" in platform.system().lower():
self.ensureRemoteDir(self.remoteTargetDir + '/' + destDirName + '/')
print("Copying [{0}] to [{1}]".format(fileName, remoteDestination))
cmd = self.copy_cmd + [fileName, remoteDestination]
print("Executing: ", ' '.join(cmd))
if not self.dryRun:
subprocess.check_call(cmd, timeout=60 * 10) # give it 10 mins
def copyToRemote(self, path: str, destDirName=""):
items = [path] if os.path.isfile(path) else [os.path.join(path, x) for x in os.listdir(path)]
for item in items:
self._copyToRemote(item, destDirName)
def updateLatestSymlink(self, forceUpdate=True):
assert self.init_finished, "RemoteUploader not initialized!"
print("Creating remote symlink: [{0}] -> [{1}]".format(self.remoteLatestLink, self.remoteTargetDir))
options = ["-sfn"] if forceUpdate else ["-sn"]
try:
cmd = self.ssh_cmd + ['ln'] + options + [self.remoteTargetDir, self.remoteLatestLink]
print("Executing: ", ' '.join(cmd))
if not self.dryRun:
subprocess.check_call(cmd, timeout=60) # give it 60s
except subprocess.CalledProcessError:
print("Failed to execute: ", ' '.join(cmd))
raise
if __name__ == "__main__":
parser = argparse.ArgumentParser(prog="Copy given file or directory contents to remote.")
parser.add_argument("--dry-run", dest="dry_run", action='store_true', help="Dry-run the command.")
parser.add_argument("--source", dest="source", type=str, required=True, help="What to copy to remote. Can be a file or a directory")
parser.add_argument("--remote-server", dest="remote_server", type=str, default=os.getenv("REMOTE_SERVER"), help="Remote server name/address.")
parser.add_argument("--remote-server-user", dest="remote_server_user", type=str, default=os.getenv("REMOTE_SERVER_USER"), help="Remote server user name.")
parser.add_argument("--remote-server-base-path", dest="remote_server_base_path", type=str, default=os.getenv("REMOTE_SERVER_BASE_PATH"), help="Remote server base path.")
parser.add_argument("--project-name", dest="project_name", type=str, required=True, help="Project name")
parser.add_argument("--project-version", dest="project_version", type=str, required=True, help="Project version")
parser.add_argument("--project-snapshot-id", dest="project_snapshot_id", type=str, required=True, help="Project snapshot id")
parser.add_argument("--subdir-name", dest="subdir_name", type=str, required=False, help="If needed create a subdirectory where to upload the source file(s).")
args = parser.parse_args(sys.argv[1:])
uploader = RemoteUploader(args.dry_run, args.remote_server, args.remote_server_user, args.remote_server_base_path)
uploader.init_snapshot_upload_path(args.project_name, args.project_version, args.project_snapshot_id)
uploader.copyToRemote(args.source, args.subdir_name)
uploader.updateLatestSymlink()
|
