Skip to content
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

Show progress bar when uploading image #15

Merged
merged 3 commits into from
Oct 20, 2021
Merged
Show file tree
Hide file tree
Changes from all 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
1 change: 1 addition & 0 deletions tests/test_data/dummy.qcow2
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
dummy
35 changes: 35 additions & 0 deletions tests/test_definitions.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
#
# Python bindings for the Cisco VIRL 2 Network Simulation Platform
#
# This file is part of VIRL 2
#
# Copyright 2020 Cisco Systems Inc.
#
# Licensed 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.
#

import requests

from virl2_client.virl2_client import Context
from virl2_client.models import NodeImageDefinitions


def test_upload_image_files(requests_mock):
adapter = requests_mock.post("mock://images/upload")
session = requests.Session()
context = Context("mock://", requests_session=session)
definitions = NodeImageDefinitions(context)
image_file_path = "tests/test_data/dummy.qcow2"
definitions.upload_image_file(image_file_path)

assert adapter.called
34 changes: 21 additions & 13 deletions virl2_client/models/node_image_definitions.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@

import logging
import os
import time
import sys
from requests_toolbelt import MultipartEncoder, MultipartEncoderMonitor

logger = logging.getLogger(__name__)
Expand Down Expand Up @@ -239,17 +241,23 @@ def create_image_definition(self, image_id, node_definition_id, label, disk_imag


def progress_callback(monitor):
if not hasattr(monitor, "start_time"):
monitor.start_time = time.time()
if not hasattr(monitor, "last_bytes"):
monitor.last_bytes = -1
# Track progress in the monitor instance itself.
if not hasattr(monitor, "curr_progress"):
monitor.curr_progress = -1

progress = int(100 * (monitor.bytes_read / monitor.len))
progress = min(progress, 100)
# Report progress every increment of 10%
if progress > monitor.curr_progress and progress % 10 == 0:
print(
"Progress: {0} of {1} bytes ({2}%)".format(
monitor.bytes_read, monitor.len, progress
)
)
monitor.curr_progress = progress
if monitor.bytes_read > monitor.last_bytes:
print_progress_bar(monitor.bytes_read, monitor.len, monitor.start_time)
monitor.last_bytes = monitor.bytes_read


def print_progress_bar(cur, total, start_time, length=50):
percent = ("{0:.1f}").format(100 * (cur / float(total)))
filled_len = int(round(length * cur / float(total)))
bar = '#' * filled_len + '-' * (length - filled_len)
raw_elapsed = time.time() - start_time
elapsed = time.strftime("[%H:%M:%S]", time.gmtime(raw_elapsed))
sys.stdout.write('\r |{}| {}/{} {}% {}'.format(bar, cur, total, percent, elapsed))
Copy link
Member

Choose a reason for hiding this comment

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

this should be print, really. You can do the same thing with print("something", end="", flush=True).

there's also a couple of single quotes for strings instead of double quotes and trailing whitespace. Ideally, pip install black and run black over the code base to get consistent formatting.

this is no big deal, though... I'm going to merge this. we will incorporate this change into our dev branch and make the additional changes there so that they can be included into the 2.3 release.

sys.stdout.flush()
if cur == total:
print()