Merge pull request #67 from lightningdevkit/2022-07-spm-checksum-release-mutation

Mutate Package.swift checksum on release

Author: arik-so

.github/workflows/release-framework.yml

@@ -8,13 +8,10 @@ permissions:
 on:
     workflow_dispatch:
         inputs:
-            tags:
-                description: 'Test scenario tags'
+            tag:
+                description: 'Tag for next release'
                 required: true
-                type: boolean
-    push:
-        tags:
-            - "*"
+                type: string
 
 jobs:
     generate-xcframework:
@@ -30,6 +27,10 @@ jobs:
                     xcode-version: latest
             -   name: Checkout
                 uses: actions/checkout@v2
+            -   name: Update Package.swift tag to ${{ github.event.inputs.tag }}
+                if: ${{ github.event.inputs.tag != null && github.event.inputs.tag != '' }}
+                run: |
+                    python3 ./src/scripts/update_swift_package_checksum.py --tag ${{ github.event.inputs.tag }}
             -   name: Install Dependencies
                 uses: ./.github/actions/install-dependencies
                 with:
@@ -38,6 +39,14 @@ jobs:
                 uses: ./.github/actions/generate-xcframework
             -   name: Create XCFramework artifact
                 uses: ./.github/actions/upload-xcframework-artifact
+            -   name: Update Package.swift checksum
+                if: ${{ github.event.inputs.tag != null && github.event.inputs.tag != '' }}
+                run: |
+                    CHECKSUM=`swift package compute-checksum LightningDevKit.xcframework.zip`
+                    python3 ./src/scripts/update_swift_package_checksum.py --checksum "${CHECKSUM}"
+                    git commit -m "Update Package.swift for ${{ github.event.inputs.tag }} release." ./Package.swift
+                    git tag ${{ github.event.inputs.tag }}
+                    git push origin HEAD:main --tags
     release:
         name: Publish Release
         runs-on: ubuntu-latest
@@ -48,6 +57,8 @@ jobs:
                 with:
                     name: LightningDevKit
             -   name: Create Release
-                uses: softprops/action-gh-release@v1
+                uses: ncipollo/release-action@v1
+                if: ${{ github.event.inputs.tag != null && github.event.inputs.tag != '' }}
                 with:
-                    files: LightningDevKit.xcframework.zip
+                    tag: ${{ github.event.inputs.tag }}
+                    artifacts: LightningDevKit.xcframework.zip

.github/workflows/swift.yml

@@ -29,11 +29,11 @@ jobs:
                     LDK_SWIFT_GENERATOR_OUTPUT_DIRECTORY_PATH: ci/LDKSwift/Sources/LDKSwift/bindings
             -   name: Copy new headers into bindings
                 run: |
-                    cd ci
-                    mkdir -p ./LDKSwift/Sources/LDKHeaders/include
-                    cp ldk-c-bindings/lightning-c-bindings/include/*.h ./LDKSwift/Sources/LDKHeaders/include/
-                    cp ldk-c-bindings/ldk-net/ldk_net.h ./LDKSwift/Sources/LDKHeaders/include/
-                    cp ldk-c-bindings/ldk-net/ldk_net.c ./LDKSwift/Sources/LDKHeaders/
+                    python3 ./src/scripts/copy_c_files.py
+                env:
+                    LDK_C_BINDINGS_BASE: /home/runner/work/ldk-swift/ldk-swift/ci/ldk-c-bindings
+                    H_FILE_OUTPUT_DIRECTORY: /home/runner/work/ldk-swift/ldk-swift/ci/LDKSwift/Sources/LDKHeaders/include
+                    C_FILE_OUTPUT_DIRECTORY: /home/runner/work/ldk-swift/ldk-swift/ci/LDKSwift/Sources/LDKHeaders
             -   name: Check that the latest auto-generated Swift files are in the repo
                 run: |
                     python3 ./ # Generate bindings into local directory

src/scripts/copy_c_files.py

@@ -10,24 +10,35 @@ def run(config: ScriptConfig):
 		os.path.join(config.LDK_C_BINDINGS_BASE, 'ldk-net'),
 	]
 
-	header_destination_directory = config.C_FILE_OUTPUT_DIRECTORY
+	c_file_destination_directory = config.C_FILE_OUTPUT_DIRECTORY
+	header_destination_directory = config.H_FILE_OUTPUT_DIRECTORY
+	os.makedirs(c_file_destination_directory, exist_ok=True)
 	os.makedirs(header_destination_directory, exist_ok=True)
 
+	if c_file_destination_directory != header_destination_directory:
+		print('Copying C files to', c_file_destination_directory)
 	print('Copying headers to', header_destination_directory)
 
 	for current_directory in header_directories:
 		for current_file in os.listdir(current_directory):
 
-			is_relevant_file = current_file.endswith('.h') or current_file.endswith('.c')
+			is_header_file = current_file.endswith('.h')
+			is_c_file = current_file.endswith('.c')
+
+			is_relevant_file = is_header_file or is_c_file
 			if not is_relevant_file:
 				continue
 
 			current_path = os.path.join(current_directory, current_file)
 			if not os.path.isfile(current_path):
 				continue
 
+			current_destination_directory = header_destination_directory
+			if is_c_file:
+				current_destination_directory = c_file_destination_directory
+
 			print('Copying', current_path)
-			subprocess.check_call(['cp', current_path, header_destination_directory])
+			subprocess.check_call(['cp', current_path, current_destination_directory])
 
 
 if __name__ == '__main__':

src/scripts/script_config.py

@@ -33,6 +33,7 @@ def __init__(self):
 		self.RUST_CONFIGURATION_FLAG: str = ''
 		self.LIPO_BINARY_OUTPUT_DIRECTORY: str = ''
 		self.C_FILE_OUTPUT_DIRECTORY: str = ''
+		self.H_FILE_OUTPUT_DIRECTORY: str = ''
 		self.PRESERVE_XCARCHIVES: bool = False
 
 	@classmethod
@@ -108,10 +109,19 @@ def parse(cls, allow_ldk_argument=True, parse_configuration=False, parse_lipo_ou
 			# parse build config aspect
 			platform = os.getenv('PLATFORM_NAME')
 			llvm_target_triple_suffix = os.getenv('LLVM_TARGET_TRIPLE_SUFFIX')
-			architectures = os.getenv('ARCHS').split(' ')
-			ldkBuildConfig = BuildConfig(platform, llvm_target_triple_suffix, architectures)
-			config.LIBLDK_BUILD_CONFIGURATIONS = [ldkBuildConfig]
-
-			pass
+			architecture_input_string = os.getenv('ARCHS')
+			if platform and architecture_input_string:
+				architectures = architecture_input_string.split(' ')
+				ldkBuildConfig = BuildConfig(platform, llvm_target_triple_suffix, architectures)
+				config.LIBLDK_BUILD_CONFIGURATIONS = [ldkBuildConfig]
+
+		output_directory_override = os.getenv('C_FILE_OUTPUT_DIRECTORY')
+		if output_directory_override:
+			config.C_FILE_OUTPUT_DIRECTORY = output_directory_override
+
+		config.H_FILE_OUTPUT_DIRECTORY = config.C_FILE_OUTPUT_DIRECTORY
+		header_output_directory_override = os.getenv('H_FILE_OUTPUT_DIRECTORY')
+		if header_output_directory_override:
+			config.H_FILE_OUTPUT_DIRECTORY = header_output_directory_override
 
 		return config

src/scripts/update_swift_package_checksum.py

@@ -0,0 +1,81 @@
+import argparse
+import json
+import os
+import re
+import sys
+
+
+def run(new_checksum: str = None, new_tag: str = None):
+	if new_checksum is None and new_tag is None:
+		print('At least one of --checksum or --tag arguments must be provided.', file=sys.stderr)
+		sys.exit(1)
+
+	if new_checksum is not None:
+		if not new_checksum.isalnum():
+			print('Checksum must be alphanumeric.', file=sys.stderr)
+			sys.exit(1)
+
+		if not new_checksum.islower():
+			print('Checksum must be lowercase.', file=sys.stderr)
+			sys.exit(1)
+
+		try:
+			int(new_checksum, 16)
+		except:
+			print('Checksum must be hexadecimal.', file=sys.stderr)
+			sys.exit(1)
+
+	if new_tag is not None:
+		if new_tag.strip() != new_tag:
+			print('Tag must not contain any whitespace.', file=sys.stderr)
+
+		tag_regex = re.compile("^\d+[.]\d+[.]\d+$")
+		tag_match = tag_regex.match(new_tag)
+		if tag_match is None:
+			print('Tag must adhere to x.x.x major/minor/patch format.', file=sys.stderr)
+
+	settings = [
+		{'variable_name': 'checksum', 'value': new_checksum},
+		{'variable_name': 'tag', 'value': new_tag},
+	]
+
+	package_file_path = os.path.realpath(os.path.join(os.path.dirname(__file__), '../../Package.swift'))
+	print(package_file_path)
+
+
+
+	original_package_file = None
+	try:
+		with open(package_file_path, 'r') as package_file_handle:
+			original_package_file = package_file_handle.read()
+	except:
+		print('Failed to read Package.swift file.', file=sys.stderr)
+		sys.exit(1)
+
+	package_file = original_package_file
+	for current_setting in settings:
+		current_variable_name = current_setting['variable_name']
+		new_value = current_setting['value']
+		if new_value is None:
+			continue
+
+		print(f'setting {current_variable_name} (JSON-serialization):')
+		print(json.dumps(new_value))
+
+		regex = re.compile(f'(let[\s]+{current_variable_name}[\s]*=[\s]*)(.*)')
+
+		previous_value = regex.search(package_file).group(2)
+		# new_package_file = checksum_regex.sub(f'\g<1>"{new_checksum}"', package_file)
+		package_file = package_file.replace(previous_value, f'"{new_value}"')
+
+	with open(package_file_path, "w") as f:
+		f.write(package_file)
+
+
+
+if __name__ == '__main__':
+	parser = argparse.ArgumentParser(description='Process some integers.')
+	parser.add_argument('--checksum', type=str, help='new checksum of LightningDevKit.xcframework.zip', required=False, default=None)
+	parser.add_argument('--tag', type=str, help='new release tag', required=False, default=None)
+	args = parser.parse_args()
+	run(new_checksum=args.checksum, new_tag=args.tag)