bastionkid/compare_apks.py

## compare_apks.py
import sys
import subprocess

# generate dictionary of the grouped contents of an apk file
def get_apk_components(apk_file, size_type):
    command = f"{apk_analyzer_path} files list --{size_type} {apk_file}"

    files_with_size_string = execute_command(command)
    files_with_size_list = files_with_size_string.split('\n')

    components = {}

    for item in files_with_size_list:
        size_and_file_name = item.split('\t')

        # this will filter out empty lines and just the lines with size and no file name
        if len(size_and_file_name) == 2 and len(size_and_file_name[1]) > 1:
            size = int(size_and_file_name[0])
            file_name = size_and_file_name[1]

            if file_name == '/lib/arm64-v8a/':
                update_if_present(components, 'Native libraries (arm64-v8a)', size)
            elif file_name.startswith('/classes') and file_name.endswith('.dex'):
                update_if_present(components, 'Classes', size)
            elif file_name == '/resources.arsc' or file_name == '/res/':
                update_if_present(components, 'Resources', size)
            elif file_name == '/assets/':
                update_if_present(components, 'Assets', size)
            elif not file_name.startswith('/lib/') and not file_name.startswith('/classes') and not file_name.startswith('/resources.arsc') and not file_name.startswith('/res/') and not file_name.startswith('/assets/') and not file_name.endswith('/'):
                update_if_present(components, 'Others', size)

    return components

# shell command executor
def execute_command(command):
    # Run the command using subprocess
    process = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
    output, error = process.communicate()

    return output.decode()

# add/update the value (i.e. size) based on the presence of provided key
def update_if_present(components, key, value):
    if key in components:
        components[key] = components[key] + value
    else:
        components[key] = value

# generate html file containing size diff in HRF
def generate_size_diff_html():
    html = "<html>"
    html += "<body><h1>Download Size Diff Report</h1><h3>Affected Products</h3>"
    html += "<ul><li><h4><code>release</code></h4><table>"
    html += f"<tr><th>Component</th><th>Base ({apk_1_sha})</th><th>Merge ({apk_2_sha})</th><th>Diff</th></tr>"

    # print diff of each components of both of the apk files
    for component in set(components_1.keys()) | set(components_2.keys()):
        size_1 = components_1.get(component, 0)
        size_2 = components_2.get(component, 0)
        html += f"<tr><td>{component}</td><td>{format_size(size_1)}</td><td>{format_size(size_2)}</td><td>{format_size_with_indicator(size_2 - size_1)}</td></tr>"

    # calculate size of the apk files
    apk_1_download_size = apk_size(apk_1_name, 'download-size')
    apk_2_download_size = apk_size(apk_2_name, 'download-size')

    html += f"<tr><td>apk (Download Size)</td><td>{format_size(apk_1_download_size)}</td><td>{format_size(apk_2_download_size)}</td><td>{format_size_with_indicator(apk_2_download_size - apk_1_download_size)}</td></tr>"
    html += "</li></ul></table></body></html>"

    with open("apk_size_diff_report.html", "w") as file:
        file.write(html)

# format bytes to KB or MB. Any size less than a KB is treated as 0KB
def format_size(size):
    if abs(size) > mb_in_bytes:
        return f"{round(size / mb_in_bytes, 2)} MB"
    elif abs(size) > kb_in_bytes:
        return f"{round(size / kb_in_bytes, 2)} KB"
    else:
        return "0 KB"

# add an indicator to highlight the size diff
def format_size_with_indicator(size):
    size_indicator = "🔴" if size > kb_in_bytes else "🟢"

    return f"{format_size(size)} {size_indicator}"

# get apk size based on size_type i.e. file-size or download-size
def apk_size(apk_file, size_type):
    command = f"{apk_analyzer_path} apk {size_type} {apk_file}"

    return int(execute_command(command))

# read arguments passed to this script
apk_1_sha = sys.argv[1]
apk_2_sha = sys.argv[2]

apk_1_name = f"{apk_1_sha}.apk"
apk_2_name = f"{apk_2_sha}.apk"

# apk_analyzer_path location will change based on the GHA runner that you're using i.e. mac/windows/ubuntu etc
apk_analyzer_path = "/usr/local/lib/android/sdk/cmdline-tools/latest/bin/apkanalyzer"

kb_in_bytes = 1024
mb_in_bytes = 1024 * 1024

# generate dictionaries for the apk components size
components_1 = get_apk_components(apk_1_name, 'download-size')
components_2 = get_apk_components(apk_2_name, 'download-size')

generate_size_diff_html()
	import sys
	import subprocess

	# generate dictionary of the grouped contents of an apk file
	def get_apk_components(apk_file, size_type):
	command = f"{apk_analyzer_path} files list --{size_type} {apk_file}"

	files_with_size_string = execute_command(command)
	files_with_size_list = files_with_size_string.split('\n')

	components = {}

	for item in files_with_size_list:
	size_and_file_name = item.split('\t')

	# this will filter out empty lines and just the lines with size and no file name
	if len(size_and_file_name) == 2 and len(size_and_file_name[1]) > 1:
	size = int(size_and_file_name[0])
	file_name = size_and_file_name[1]

	if file_name == '/lib/arm64-v8a/':
	update_if_present(components, 'Native libraries (arm64-v8a)', size)
	elif file_name.startswith('/classes') and file_name.endswith('.dex'):
	update_if_present(components, 'Classes', size)
	elif file_name == '/resources.arsc' or file_name == '/res/':
	update_if_present(components, 'Resources', size)
	elif file_name == '/assets/':
	update_if_present(components, 'Assets', size)
	elif not file_name.startswith('/lib/') and not file_name.startswith('/classes') and not file_name.startswith('/resources.arsc') and not file_name.startswith('/res/') and not file_name.startswith('/assets/') and not file_name.endswith('/'):
	update_if_present(components, 'Others', size)

	return components

	# shell command executor
	def execute_command(command):
	# Run the command using subprocess
	process = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
	output, error = process.communicate()

	return output.decode()

	# add/update the value (i.e. size) based on the presence of provided key
	def update_if_present(components, key, value):
	if key in components:
	components[key] = components[key] + value
	else:
	components[key] = value

	# generate html file containing size diff in HRF
	def generate_size_diff_html():
	html = "<html>"
	html += "<body><h1>Download Size Diff Report</h1><h3>Affected Products</h3>"
	html += "<ul><li><h4><code>release</code></h4><table>"
	html += f"<tr><th>Component</th><th>Base ({apk_1_sha})</th><th>Merge ({apk_2_sha})</th><th>Diff</th></tr>"

	# print diff of each components of both of the apk files
	for component in set(components_1.keys()) \| set(components_2.keys()):
	size_1 = components_1.get(component, 0)
	size_2 = components_2.get(component, 0)
	html += f"<tr><td>{component}</td><td>{format_size(size_1)}</td><td>{format_size(size_2)}</td><td>{format_size_with_indicator(size_2 - size_1)}</td></tr>"

	# calculate size of the apk files
	apk_1_download_size = apk_size(apk_1_name, 'download-size')
	apk_2_download_size = apk_size(apk_2_name, 'download-size')

	html += f"<tr><td>apk (Download Size)</td><td>{format_size(apk_1_download_size)}</td><td>{format_size(apk_2_download_size)}</td><td>{format_size_with_indicator(apk_2_download_size - apk_1_download_size)}</td></tr>"
	html += "</li></ul></table></body></html>"

	with open("apk_size_diff_report.html", "w") as file:
	file.write(html)

	# format bytes to KB or MB. Any size less than a KB is treated as 0KB
	def format_size(size):
	if abs(size) > mb_in_bytes:
	return f"{round(size / mb_in_bytes, 2)} MB"
	elif abs(size) > kb_in_bytes:
	return f"{round(size / kb_in_bytes, 2)} KB"
	else:
	return "0 KB"

	# add an indicator to highlight the size diff
	def format_size_with_indicator(size):
	size_indicator = "🔴" if size > kb_in_bytes else "🟢"

	return f"{format_size(size)} {size_indicator}"

	# get apk size based on size_type i.e. file-size or download-size
	def apk_size(apk_file, size_type):
	command = f"{apk_analyzer_path} apk {size_type} {apk_file}"

	return int(execute_command(command))

	# read arguments passed to this script
	apk_1_sha = sys.argv[1]
	apk_2_sha = sys.argv[2]

	apk_1_name = f"{apk_1_sha}.apk"
	apk_2_name = f"{apk_2_sha}.apk"

	# apk_analyzer_path location will change based on the GHA runner that you're using i.e. mac/windows/ubuntu etc
	apk_analyzer_path = "/usr/local/lib/android/sdk/cmdline-tools/latest/bin/apkanalyzer"

	kb_in_bytes = 1024
	mb_in_bytes = 1024 * 1024

	# generate dictionaries for the apk components size
	components_1 = get_apk_components(apk_1_name, 'download-size')
	components_2 = get_apk_components(apk_2_name, 'download-size')

	generate_size_diff_html()