Skip to content

Commit

Permalink
fix(get.py): Add version checking for installed tools (#10160)
Browse files Browse the repository at this point in the history
* fix(get.py): Add version checking of installed tools

* change(tools): Push generated binaries to PR

* Fix for different file formats

* change(tools): Push generated binaries to PR

* fix paths

* change(tools): Push generated binaries to PR

* Move to using checksum

* change(tools): Push generated binaries to PR

* Clean code

* change(tools): Push generated binaries to PR

* Add checksum check for libs

* change(tools): Push generated binaries to PR

* ci(pre-commit): Apply automatic fixes

* change(tools): Push generated binaries to PR

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
  • Loading branch information
3 people authored Aug 21, 2024
1 parent c7ac06c commit 4098c53
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 17 deletions.
Binary file modified tools/get.exe
Binary file not shown.
62 changes: 45 additions & 17 deletions tools/get.py
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,36 @@ def verify_files(filename, destination, rename_to):
return True


def unpack(filename, destination, force_extract): # noqa: C901
def is_latest_version(destination, dirname, rename_to, cfile, checksum):
current_version = None
expected_version = None

try:
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 +225,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 +254,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 @@ -324,11 +356,11 @@ def get_tool(tool, force_download, force_extract):
print("Tool {0} already downloaded".format(archive_name))
sys.stdout.flush()

if "esp32-arduino-libs" not in archive_name and sha256sum(local_path) != checksum:
if sha256sum(local_path) != checksum:
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 +411,17 @@ 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"
)
parser.add_argument("-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"
)
parser.add_argument("-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

0 comments on commit 4098c53

Please sign in to comment.