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

fix(get.py): Add version checking for installed tools #10160

Merged
merged 15 commits into from
Aug 21, 2024
Merged
Show file tree
Hide file tree
Changes from 11 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
Binary file modified tools/get.exe
Binary file not shown.
61 changes: 49 additions & 12 deletions tools/get.py
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,42 @@ def verify_files(filename, destination, rename_to):

return True

def is_latest_version(destination, dirname, rename_to, cfile, checksum):
current_version = None
expected_version = None

def unpack(filename, destination, force_extract): # noqa: C901
try:
if rename_to.startswith("esp32-arduino-libs"):
lucasssvaz marked this conversation as resolved.
Show resolved Hide resolved
# Remove this when moving to new release system
expected_version = cfile.read(dirname + "/versions.txt").decode("utf-8")
with open(os.path.join(destination, rename_to, "versions.txt"), "r") as f:
# cfile is zip
current_version = f.read()
else:
expected_version = checksum
with open(os.path.join(destination, rename_to, ".package_checksum"), "r") as f:
current_version = f.read()

if verbose:
print(f"\nTool: {rename_to}")
print(f"Current version: {current_version}")
print(f"Expected version: {expected_version}")

if current_version and current_version == expected_version:
if verbose:
print("Latest version already installed. Skipping extraction")
return True

if verbose:
print("New version detected")

except Exception as e:
if verbose:
print(f"Falied to verify version for {rename_to}: {e}")

return False

def unpack(filename, destination, force_extract, checksum): # noqa: C901
dirname = ""
cfile = None # Compressed file
file_is_corrupted = False
Expand Down Expand Up @@ -196,11 +230,11 @@ def unpack(filename, destination, force_extract): # noqa: C901
rename_to = "esp32-arduino-libs"

if not force_extract:
if verify_files(filename, destination, rename_to):
print(" Files ok. Skipping Extraction")
return True
else:
print(" Extracting archive...")
if is_latest_version(destination, dirname, rename_to, cfile, checksum):
if verify_files(filename, destination, rename_to):
print(" Files ok. Skipping Extraction")
return True
print(" Extracting archive...")
else:
print(" Forcing extraction")

Expand All @@ -225,6 +259,9 @@ def unpack(filename, destination, force_extract): # noqa: C901
shutil.rmtree(rename_to)
shutil.move(dirname, rename_to)

with open(os.path.join(destination, rename_to, ".package_checksum"), "w") as f:
f.write(checksum)

if verify_files(filename, destination, rename_to):
print(" Files extracted successfully.")
return True
Expand Down Expand Up @@ -328,7 +365,7 @@ def get_tool(tool, force_download, force_extract):
print("Checksum mismatch for {0}".format(archive_name))
return False

return unpack(local_path, ".", force_extract)
return unpack(local_path, ".", force_extract, checksum)


def load_tools_list(filename, platform):
Expand Down Expand Up @@ -379,21 +416,21 @@ def identify_platform():
if __name__ == "__main__":
parser = argparse.ArgumentParser(description="Download and extract tools")

parser.add_argument("-v", "--verbose", type=bool, default=False, required=False, help="Print verbose output")
parser.add_argument("-v", "--verbose", action='store_true', required=False, help="Print verbose output")

parser.add_argument(
"-d", "--force_download", type=bool, default=False, required=False, help="Force download of tools"
"-d", "--force_download", action='store_true', required=False, help="Force download of tools"
)

parser.add_argument(
"-e", "--force_extract", type=bool, default=False, required=False, help="Force extraction of tools"
"-e", "--force_extract", action='store_true', required=False, help="Force extraction of tools"
)

parser.add_argument(
"-f", "--force_all", type=bool, default=False, required=False, help="Force download and extraction of tools"
"-f", "--force_all", action='store_true', required=False, help="Force download and extraction of tools"
)

parser.add_argument("-t", "--test", type=bool, default=False, required=False, help=argparse.SUPPRESS)
parser.add_argument("-t", "--test", action='store_true', required=False, help=argparse.SUPPRESS)

args = parser.parse_args()

Expand Down