Skip to content

CHC SFTP Downloads #352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Oct 28, 2020
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions changehc/delphi_changehc/constants.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Registry for signal names and geo types"""
SMOOTHED = "smoothed_chc"
SMOOTHED_ADJ = "smoothed_adj_chc"
SMOOTHED = "smoothed_cli"
SMOOTHED_ADJ = "smoothed_adj_cli"
SIGNALS = [SMOOTHED, SMOOTHED_ADJ]
NA = "NA"
HRR = "hrr"
Expand Down
71 changes: 71 additions & 0 deletions changehc/delphi_changehc/download_ftp_files.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
"""
Downloads files modified in the last 24 hours from the specified ftp server."""

# standard
import datetime
import functools
import sys
from os import path

# third party
import paramiko

class AllowAnythingPolicy(paramiko.MissingHostKeyPolicy):
def missing_host_key(self, client, hostname, key):
return


def print_callback(filename, bytes_so_far, bytes_total):
rough_percent_transferred = int(100 * (bytes_so_far / bytes_total))
if (rough_percent_transferred % 25) == 0:
print(f'{filename} transfer: {rough_percent_transferred}%')


def get_files_from_dir(sftp, out_path):
current_time = datetime.datetime.now()
seconds_in_day = 24 * 60 * 60

# go through files in recieving dir
files_to_download = []
for fileattr in sftp.listdir_attr():
file_time = datetime.datetime.fromtimestamp(fileattr.st_mtime)
time_diff_to_current_time = current_time - file_time
if time_diff_to_current_time.total_seconds() <= seconds_in_day:
files_to_download.append(fileattr.filename)

filepaths_to_download = {}
for file in files_to_download:
full_path = path.join(out_path, file)
if path.exists(full_path):
print(f"{file} exists, skipping")
else:
filepaths_to_download[file] = full_path

# make sure we don't download more than 2 files per day
assert len(files_to_download) <= 2, "more files dropped than expected"

# download!
for infile, outfile in filepaths_to_download.items():
callback_for_filename = functools.partial(print_callback, infile)
sftp.get(infile, outfile, callback=callback_for_filename)
Copy link
Contributor

Choose a reason for hiding this comment

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

callback is cool, didn't know of this feature in paramiko



def download(out_path, ftp_conn):

# open client
client = paramiko.SSHClient()
client.set_missing_host_key_policy(AllowAnythingPolicy())

client.connect(ftp_conn["host"], username=ftp_conn["user"],
password=ftp_conn["pass"][1:] + ftp_conn["pass"][0],
Copy link
Contributor

Choose a reason for hiding this comment

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

Why 1:?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is my super hi-tech encryption method. I store the password in plaintext as "dpasswor" and then the client connects using "password." It's almost as foolproof as RSA, just don't tell anyone!

Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need to do this if credentials are encrypted at rest in ansible?

port=ftp_conn["port"],
allow_agent=False, look_for_keys=False)
sftp = client.open_sftp()

sftp.chdir('/dailycounts/All_Outpatients_By_County')
get_files_from_dir(sftp, out_path)

sftp.chdir('/dailycounts/Covid_Outpatients_By_County')
get_files_from_dir(sftp, out_path)

client.close()
5 changes: 5 additions & 0 deletions changehc/delphi_changehc/run.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
from delphi_utils import read_params

# first party
from .download_ftp_files import download
from .update_sensor import CHCSensorUpdator


Expand All @@ -25,6 +26,10 @@ def run_module():

logging.basicConfig(level=logging.DEBUG)

## download recent files from FTP server
logging.info("downloading recent files through SFTP")
download(params["cache_dir"], params["ftp_conn"])
Copy link
Contributor

Choose a reason for hiding this comment

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

Can this be mocked out for testing?

Copy link
Contributor

Choose a reason for hiding this comment

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

+1


## get end date from input file
# the filenames are expected to be in the format:
# Denominator: "YYYYMMDD_All_Outpatients_By_County.dat.gz"
Expand Down
10 changes: 8 additions & 2 deletions changehc/params.json.template
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,11 @@
"aws_access_key_id": "",
"aws_secret_access_key": ""
},
"bucket_name": ""
}
"bucket_name": "",
"ftp_conn": {
"host": "",
"user": "",
"pass": "",
"port": 0
}
}
3 changes: 2 additions & 1 deletion changehc/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
"delphi-utils",
"covidcast",
"boto3",
"moto"
"moto",
"paramiko"
]

setup(
Expand Down