commit d05784622aa0ae6580d8212c031e39812c11c7a5 Author: mik-tf Date: Wed Oct 2 01:19:16 2024 -0400 init flist_cli_v app, todo: set push function diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..72dd69f --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2024 ThreeFold + + 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..da48288 --- /dev/null +++ b/README.md @@ -0,0 +1,110 @@ +

Flist CLI in Vlang

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Installation](#installation) + - [Prerequisites](#prerequisites) + - [Building and Installing](#building-and-installing) +- [Usage](#usage) +- [OS-Specific Instructions](#os-specific-instructions) + - [Windows](#windows) + - [macOS and Linux](#macos-and-linux) +- [Troubleshooting](#troubleshooting) +- [Development](#development) +- [Contributing](#contributing) +- [License](#license) + +--- + +## Introduction + +Flist CLI is a tool that turns Dockerfiles and Docker images directly into Flist on the TF Flist Hub, passing through Docker Hub. + +## Installation + +### Prerequisites + +- [V programming language](https://vlang.io/) (latest version) installed on your system +- Docker installed and running +- Docker Hub account +- TF Hub account and token + +### Building and Installing + +1. Clone this repository, build the project, run the install command and set the CLI to your path: + ``` + git clone https://github.com/yourusername/flist-cli.git + cd flist-cli + v -o flist . + sudo ./flist install + ``` + + This will copy the `flist` executable to the appropriate system location. + +## Usage + +After installation, you can use the `flist` command followed by various subcommands: + +``` +flist [arguments] +``` + +Available commands: +- `install`: Install the Flist CLI +- `uninstall`: Uninstall the Flist CLI +- `login`: Log in to Docker Hub and save the Flist Hub token +- `logout`: Log out of Docker Hub and remove the Flist Hub token +- `push :`: Build and push a Docker image, then convert and push it as an flist +- `delete `: Delete an flist from Flist Hub +- `rename `: Rename an flist in Flist Hub +- `help`: Display help information + +## OS-Specific Instructions + +### Windows + +1. Run Command Prompt or PowerShell as Administrator. +2. Ensure Docker Desktop is installed and running. +3. Use a Docker-enabled terminal for all Docker-related commands. +4. The `flist` executable will be installed to: + ``` + C:\Program Files\flist\flist.exe + ``` + +### macOS and Linux + +1. Ensure Docker is installed and the Docker daemon is running. +2. The `flist` executable will be installed to: + ``` + /usr/local/bin/flist + ``` +3. You may need to use `sudo` for installation and certain operations: + ``` + sudo ./flist install + sudo flist uninstall + sudo flist + ``` + +## Troubleshooting + +- If you encounter permission issues, ensure you're running the command with appropriate privileges (e.g., as administrator on Windows or with `sudo` on Unix-like systems). +- Make sure Docker is running before using Flist CLI commands. +- If you face issues with Docker commands, try logging out and logging back in to refresh your Docker credentials. +- If you encounter compilation errors, ensure you have the latest version of V installed. + +## Development + +To modify the Flist CLI: + +1. Make your changes to the `flist.v` file. +2. Rebuild the project using `v -o flist .` +3. Test your changes thoroughly across different operating systems if possible. + +## Contributing + +Contributions are welcome! Please feel free to submit a Pull Request. + +## License + +[Apache 2.0 License](LICENSE) \ No newline at end of file diff --git a/flist b/flist new file mode 100755 index 0000000..bd92013 Binary files /dev/null and b/flist differ diff --git a/flist.v b/flist.v new file mode 100644 index 0000000..3eeaf04 --- /dev/null +++ b/flist.v @@ -0,0 +1,289 @@ +import os +import json +import net.http +import term + +const ( + token_file = os.join_path(os.home_dir(), '.config', 'tfhubtoken') + binary_location = if os.user_os() == 'windows' { + 'C:\\Program Files\\flist\\flist.exe' + } else { + '/usr/local/bin/flist' + } +) + +fn error_message(msg string) { + println(term.bold(term.red('Error: ')) + msg) + println(term.yellow('Run \'flist help\' for usage information.')) +} + +fn install() { + println('Installing Flist CLI...') + current_exe := os.executable() + if os.exists(current_exe) { + os.mkdir_all(os.dir(binary_location)) or { panic(err) } + os.cp(current_exe, binary_location) or { panic(err) } + os.chmod(binary_location, 0o755) or { panic(err) } + println('Flist CLI has been installed to ' + binary_location) + println('You can now use it by running \'flist help\'') + } else { + error_message('Cannot find the executable file') + exit(1) + } +} + +fn uninstall() { + println('Uninstalling Flist CLI...') + if os.exists(binary_location) { + os.rm(binary_location) or { panic(err) } + println('Flist CLI has been removed from ' + binary_location) + } else { + println('Flist CLI is not installed at ' + binary_location) + } +} + +fn login() { + mut token_exists := os.exists(token_file) + mut docker_logged_in := false + + docker_user_result := os.execute('docker system info | grep \'Username\' | cut -d \' \' -f 3') + if docker_user_result.exit_code == 0 && docker_user_result.output.trim_space() != '' { + docker_logged_in = true + } + + if token_exists && docker_logged_in { + println('You are already logged in to Docker Hub and your Flist Hub token is present.') + return + } + + if !token_exists { + tfhub_token := os.input('Please enter your tfhub token: ') + os.write_file(token_file, tfhub_token) or { panic(err) } + println('Token saved in ' + token_file) + } else { + println('Your Flist Hub token is already saved.') + } + + if !docker_logged_in { + println('Logging in to Docker Hub...') + exit_code := os.system('docker login') + if exit_code == 0 { + println('Successfully logged in to Docker Hub.') + } else { + error_message('Failed to log in to Docker Hub.') + return + } + } else { + println('Already logged in to Docker Hub.') + } + + println('Login process completed.') +} + +fn logout() { + if !os.exists(token_file) { + error_message('You are not logged in.') + return + } + + os.rm(token_file) or { panic(err) } + + println('Logging out from Docker Hub...') + exit_code := os.system('docker logout') + if exit_code != 0 { + error_message('Failed to log out from Docker Hub.') + } + + println('You are now logged out of Docker Hub and your Flist Hub token has been removed.') +} + +fn push(tag string) { + println('Logging in to Docker Hub...') + if os.system('sudo docker login') != 0 { + error_message('Failed to log in to Docker Hub.') + exit(1) + } + + docker_user_result := os.execute('sudo docker system info | grep \'Username\' | cut -d \' \' -f 3') + if docker_user_result.exit_code != 0 || docker_user_result.output.trim_space() == '' { + error_message('Failed to get Docker username. Please ensure you are logged in to Docker.') + exit(1) + } + + docker_user := docker_user_result.output.trim_space() + println('Docker username: $docker_user') + + full_tag := '${docker_user}/${tag}' + + tfhub_token := os.read_file(token_file) or { + error_message('No token found. Please run \'flist login\' first.') + exit(1) + } + + println('Starting Docker build') + if os.system('sudo docker buildx build -t ${full_tag} .') != 0 { + error_message('Docker build failed') + exit(1) + } + + println('Finished local Docker build, now pushing to Docker Hub') + if os.system('sudo docker push ${full_tag}') != 0 { + error_message('Docker push failed') + exit(1) + } + + println('Converting Docker image to flist now...') + mut headers := http.new_header() + headers.add_custom('Authorization', 'bearer ${tfhub_token}') or { + error_message('Failed to add authorization header') + exit(1) + } + + form_data := { + 'image': full_tag + } + http.post_form('https://hub.grid.tf/api/flist/me/docker', form_data) or { + error_message('Failed to convert Docker image to flist: ${err}') + exit(1) + } + + println('Conversion attempt completed, check above for success') + println('Here are paths matching the tag name:') + + url := 'https://hub.grid.tf/api/flist/${docker_user}' + flist_resp := http.get(url) or { + error_message('Failed to fetch flists: ${err}') + exit(1) + } + + flist_json := json.decode([]map[string]string, flist_resp.body) or { + error_message('Failed to parse flists response: ${err}') + exit(1) + } + + tag_name := tag.all_before(':') + for flist in flist_json { + flist_name := flist['name'] or { continue } + if flist_name.contains(tag_name) { + println('https://hub.grid.tf/${docker_user}/${flist_name}') + } + } +} + +fn delete(flist_name string) { + tfhub_token := os.read_file(token_file) or { + error_message('No token found. Please run \'flist login\' first.') + exit(1) + } + + println('Deleting flist: ' + flist_name) + url := 'https://hub.grid.tf/api/flist/me/' + flist_name + config := http.FetchConfig{ + url: url + method: .delete + header: http.new_header(key: .authorization, value: 'bearer ' + tfhub_token) + } + + response := http.fetch(config) or { + error_message('Failed to send delete request: ' + err.msg()) + exit(1) + } + + if response.status_code == 200 { + println('Deletion request sent successfully.') + } else { + error_message('Deletion request failed with status code: ' + response.status_code.str()) + } +} + +fn rename(flist_name string, new_flist_name string) { + tfhub_token := os.read_file(token_file) or { + error_message('No token found. Please run \'flist login\' first.') + exit(1) + } + + println('Renaming flist: ' + flist_name + ' to ' + new_flist_name) + url := 'https://hub.grid.tf/api/flist/me/' + flist_name + '/rename/' + new_flist_name + config := http.FetchConfig{ + url: url + method: .get + header: http.new_header(key: .authorization, value: 'bearer ' + tfhub_token) + } + + response := http.fetch(config) or { + error_message('Failed to send rename request: ' + err.msg()) + exit(1) + } + + if response.status_code == 200 { + println('Rename request sent successfully.') + } else { + error_message('Rename request failed with status code: ' + response.status_code.str()) + } +} + +fn help() { + println(term.bold(term.green('\n Welcome to the Flist CLI!'))) + println('This tool turns Dockerfiles and Docker images directly into Flist on the TF Flist Hub, passing by the Docker Hub.\n') + println(term.bold('Available commands:')) + println(term.blue(' install ') + '- Install the Flist CLI') + println(term.blue(' uninstall ') + '- Uninstall the Flist CLI') + println(term.blue(' login ') + '- Log in to Docker Hub and save the Flist Hub token') + println(term.blue(' logout ') + '- Log out of Docker Hub and remove the Flist Hub token') + println(term.blue(' push ') + '- Build and push a Docker image to Docker Hub, then convert and push it as an flist to Flist Hub') + println(term.blue(' delete ') + '- Delete an flist from Flist Hub') + println(term.blue(' rename ') + '- Rename an flist in Flist Hub') + println(term.blue(' help ') + '- Display this help message\n') + println(term.bold('Usage:')) + println(' flist install') + println(' flist uninstall') + println(' flist login') + println(' flist logout') + println(' flist push :') + println(' flist delete ') + println(' flist rename ') + println(' flist help') +} + +fn main() { + if os.args.len == 1 { + help() + return + } + + match os.args[1] { + 'install' { install() } + 'uninstall' { uninstall() } + 'push' { + if os.args.len == 3 { + push(os.args[2]) + } else { + error_message('Incorrect number of arguments for \'push\'.') + exit(1) + } + } + 'login' { login() } + 'logout' { logout() } + 'delete' { + if os.args.len == 3 { + delete(os.args[2]) + } else { + error_message('Incorrect number of arguments for \'delete\'.') + exit(1) + } + } + 'rename' { + if os.args.len == 4 { + rename(os.args[2], os.args[3]) + } else { + error_message('Incorrect number of arguments for \'rename\'.') + exit(1) + } + } + 'help' { help() } + else { + error_message('Unknown command: ' + os.args[1]) + exit(1) + } + } +} \ No newline at end of file