commit 332bbe2c86e28d39b17f7c735e27630a072714e8 Author: Tools <> Date: Sat May 4 16:18:49 2024 +0200 Initial commit diff --git a/.github/lint.py b/.github/lint.py new file mode 100644 index 0000000..d4d0138 --- /dev/null +++ b/.github/lint.py @@ -0,0 +1,25 @@ +import sys +import os +import pathlib + +from pylint import lint + + +if __name__ == "__main__": + folder: str = '' + for v in sys.argv: + if '--module=' in v: + folder = v.replace('--module=', '') + + if folder is False: + print(f'Module folder not set.') + sys.exit(1) + + run = lint.Run([f'--rcfile={pathlib.Path(os.getcwd(), "linter", ".pylintrc")}', folder], + do_exit=False) + + if run.linter.stats.fatal or run.linter.stats.error: + print('Pylint failed.') + sys.exit(1) + + sys.exit(0) diff --git a/.github/package.py b/.github/package.py new file mode 100644 index 0000000..0778b4e --- /dev/null +++ b/.github/package.py @@ -0,0 +1,15 @@ +import glob +import os + + +def get_folder_name(): + addon = glob.glob(os.getcwd() + "/*/__init__.py", recursive=True) + + return os.path.basename(os.path.dirname(addon[0])) + + +if __name__ == "__main__": + name = get_folder_name() + + # Keep the print value, it's request to output a string value available + print(name) diff --git a/.github/version.py b/.github/version.py new file mode 100644 index 0000000..f086507 --- /dev/null +++ b/.github/version.py @@ -0,0 +1,74 @@ +import os +import re +import sys + +from pathlib import Path + + +class SetupVersion: + def __init__(self, version: str, folder: str): + self.addon_file = Path(os.getcwd(), folder, '__init__.py') + self.tag = self.conform_tag_to_blender(version) + self.update_addon_init() + + def update_addon_init(self): + """Simple function to update the bl_info to set the Git tag release""" + regex, update = r'[0-9]{1,2}\, [0-9]{1,2}\, [0-9]{1,2}', '' + + try: + with open(self.addon_file, "r") as f: + i = 0 + lines = f.readlines() + for line in lines: + if ' \'version\':' in line: + print('Actual set : ', line) + line = re.sub(regex, self.tag, line) + lines[i] = line + update = lines + print('Update version : ', line) + break + i += 1 + + with open(self.addon_file, 'w') as f: + f.writelines(update) + + except FileNotFoundError as exception: + print(f'Can\'t find a file :\n\t{exception}') + + @staticmethod + def conform_tag_to_blender(version): + """This function convert all '.' with a coma and remove the alphabetic entry, to be ready with blender 'bl + info' value """ + version = re.sub(r'\.', ', ', version) + version = version.replace('v', '') + + return version + + +class SetupError(Exception): + """No tag or folder name valid""" + pass + + +if __name__ == "__main__": + tag, name = '', '' + + for value in sys.argv: + if '--tag' in value: + tag = value.replace('--tag=', '') + print(f'[UpdateVersion] Set the tag {tag}') + + if 'name' in value: + name = value.replace('--name=', '') + print(f'[UpdateVersion] Set the folder {name}') + + try: + if not tag or not name: + raise SetupError + else: + print(f'[UpdateVersion] Set the tag {tag}, for "{name}"') + bump = SetupVersion(tag, name) + + except SetupError: + print(SetupError.__doc__) + sys.exit(1) diff --git a/.github/workflows/initialize_data.yml b/.github/workflows/initialize_data.yml new file mode 100644 index 0000000..a6449bd --- /dev/null +++ b/.github/workflows/initialize_data.yml @@ -0,0 +1,54 @@ +name: Create base release + +on: + workflow_call: + outputs: + version_type: + description: "Give the bump type for this release" + value: ${{ jobs.init-release-data.outputs.version_type }} + version_number: + description: "String about the tag version, integer only" + value: ${{ jobs.init-release-data.outputs.version_number }} + version_draft: + description: "Boolean if the release are draft or not" + value: ${{ jobs.init-release-data.outputs.version_draft }} + version_name: + description: "Number version with a prefix v." + value: v${{ jobs.init-release-data.outputs.version_name }} + +jobs: + init-release-data: + name: Initialize all data about the package + runs-on: ubuntu-latest + outputs: + version_type: ${{ steps.bump_setup.outputs.type }} + version_number: ${{ steps.semantic_setup.outputs.version }} + version_draft: ${{ steps.semantic_setup.outputs.draft }} + version_name: ${{ steps.semantic_setup.outputs.version }} + steps: + - name: Get the Semantic tag Version + id: get_semantic_setup + uses: oprypin/find-latest-tag@v1.1.0 + with: + repository: ${{ github.repository }} + releases-only: true + prefix: 'v' + token: ${{ secrets.GITHUB_TOKEN }} + + - name: From all use case, get the Tag version + id: semantic_setup + run: | + tag=${{ steps.get_semantic_setup.outputs.tag }} + if [ "${{ github.event.action }}" == "closed" ]; then + echo "Close the pull request, get the previous tag" + echo "::set-output name=version::${tag:1}" + echo "::set-output name=draft::false" + elif [ "${{ github.event.action }}" == "opened" ]; then + echo "Create a new tag from a new pull request" + echo "::set-output name=version::${{ steps.new_semantic_setup.outputs.version }}" + echo "::set-output name=draft::true" + else + echo "Update the pull request, keep the tag value" + echo "::set-output name=version::${tag:1}" + echo "::set-output name=draft::true" + fi diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml new file mode 100644 index 0000000..9a37468 --- /dev/null +++ b/.github/workflows/linter.yml @@ -0,0 +1,29 @@ +name: Pylinter + +on: + workflow_call: + push: + branches-ignore: + - main + - develop + + +jobs: + unit-test: + name: Python Linter + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@main + - uses: actions/setup-python@v2 + with: + python-version: "3.10" + - name: Install the linter app and set package name + id: config + run: | + echo "::set-output name=folder::$(python '.github/package.py')" + python -m pip install --upgrade pip + python -m pip install -r linter/requirements_linter.txt + - name: Execute Pylint + run: | + cd ${{ github.workspace }} + python '${{ github.workspace }}/.github/lint.py' --module=${{ steps.config.outputs.folder }} diff --git a/.github/workflows/package_addon.yml b/.github/workflows/package_addon.yml new file mode 100644 index 0000000..363415e --- /dev/null +++ b/.github/workflows/package_addon.yml @@ -0,0 +1,71 @@ +name: Package Blender Plugin + +# How to start the Github Action +on: + workflow_call: + inputs: + num_version: + description: 'Get the desired number version' + type: string + required: true + default: '0.0.0' + name_version: + description: 'The release name used' + type: string + required: true + default: 'v0.0.0' + draft_version: + description: 'Info about the release, publish or a draft' + type: string + required: true + default: 'false' + + +# Execute this command +jobs: + make-archive: + name: Make Addon Package + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@main + + - name: Setup package variable + id: folder + run: | + echo "::set-output name=folder::$(python '.github/package.py')" + echo "::set-output name=package::$(python '.github/package.py').zip" + + # Update the bl info version, update the init file and push if needed + - name: Change version number in the bl info addon data + run: python '.github/version.py' --tag=${{ inputs.num_version }} --name=${{ steps.folder.outputs.folder }} + + - name: Commit the previous update + uses: actions-js/push@v1.3 + if: ${{ github.event.action }} == 'opened' + with: + github_token: ${{secrets.GITHUB_TOKEN}} + author_name: Moderlab + author_email: a.vaillant@moderlab.com + message: '[Bot] Bump to ${{ inputs.num_version }} version.' + branch: develop + force: true + + # Make an archive with the plugin source only + - name: Create zip archive release + run: | + cd '${{ github.workspace }}' + zip -r '${{ github.workspace }}/releases/${{ steps.folder.outputs.package }}' ${{ steps.folder.outputs.folder }} + + - uses: actions/upload-artifact@v2 + with: + name: ${{ steps.folder.outputs.folder }} + path: ${{ github.workspace }}/releases/${{ steps.folder.outputs.package }} + + - name: Update the github release + if: github.event_name == 'pull_request' + uses: johnwbyrd/update-release@v1.0.0 + with: + token: ${{ secrets.GITHUB_TOKEN }} + files: '${{ github.workspace }}/releases/${{ steps.folder.outputs.package }}' + release: ${{ inputs.name_version }} + tag: ${{ inputs.name_version }} \ No newline at end of file diff --git a/.github/workflows/package_preset.yml b/.github/workflows/package_preset.yml new file mode 100644 index 0000000..44277ab --- /dev/null +++ b/.github/workflows/package_preset.yml @@ -0,0 +1,46 @@ +name: Package Blender Plugin + +# How to start the Github Action +on: + workflow_call: + inputs: + name_version: + description: 'The release name used' + type: string + required: true + default: 'v0.0.0' + + +# Execute this command +jobs: + make-archive: + name: Make Addon Package + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@main + + - name: Setup package variable + id: folder + run: | + echo "::set-output name=folder::$(python '.github/package.py')_preset" + echo "::set-output name=package::$(python '.github/package.py')_preset.zip" + + # Make an archive with the plugin source only + - name: Create zip archive release + run: | + cd '${{ github.workspace }}/presets' + zip -r '../releases/${{ steps.folder.outputs.package }}' '.' + + - uses: actions/upload-artifact@v2 + with: + name: ${{ steps.folder.outputs.folder }} + path: ${{ github.workspace }}/releases/${{ steps.folder.outputs.package }} + + - name: Update the github release + if: github.event_name == 'pull_request' + uses: johnwbyrd/update-release@v1.0.0 + with: + token: ${{ secrets.GITHUB_TOKEN }} + files: '${{ github.workspace }}/releases/${{ steps.folder.outputs.package }}' + release: ${{ inputs.name_version }} + tag: ${{ inputs.name_version }} \ No newline at end of file diff --git a/.github/workflows/pr_main.yml b/.github/workflows/pr_main.yml new file mode 100644 index 0000000..0c7921c --- /dev/null +++ b/.github/workflows/pr_main.yml @@ -0,0 +1,60 @@ +name: Create addon release + +on: + pull_request: + branches: + [main] + types: + [edited, synchronize, closed] + + +jobs: + init-release-data: + name: Initialize all data about the package + uses: Moderlab-Production/BlenderTemplate/.github/workflows/initialize_data.yml@main + + unit-test: + uses: Moderlab-Production/BlenderTemplate/.github/workflows/unit_test.yml@main + + py-linter: + uses: Moderlab-Production/BlenderTemplate/.github/workflows/linter.yml@main + + release-package-addon: + name: Generate archive package addon + needs: + - init-release-data + - unit-test + - py-linter + uses: Moderlab-Production/BlenderTemplate/.github/workflows/package_addon.yml@main + with: + num_version: ${{ needs.init-release-data.outputs.version_number }} + name_version: ${{ needs.init-release-data.outputs.version_name }} + draft_version: ${{ needs.init-release-data.outputs.version_draft }} + + release-package-preset: + name: Generate archive package preset + needs: + - init-release-data + - unit-test + - py-linter + uses: Moderlab-Production/BlenderTemplate/.github/workflows/package_preset.yml@main + with: + name_version: ${{ needs.init-release-data.outputs.version_name }} + + publish-release: + name: Publish the Github Release + needs: + - init-release-data + - release-package-addon + - release-package-preset + runs-on: ubuntu-latest + steps: + - name: Update/Publish the release + uses: tubone24/update_release@v1.3.1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + TAG_NAME: ${{ needs.init-release-data.outputs.version_name }} + with: + release_name: ${{ needs.init-release-data.outputs.version_name }} + body: '' + prerelease: ${{ needs.init-release-data.outputs.version_draft }} diff --git a/.github/workflows/pr_main_start.yml b/.github/workflows/pr_main_start.yml new file mode 100644 index 0000000..99a5157 --- /dev/null +++ b/.github/workflows/pr_main_start.yml @@ -0,0 +1,46 @@ +name: Create addon release + +on: + pull_request: + branches: + [main] + types: + [opened] + + +jobs: + init-release: + name: Generate the release + runs-on: ubuntu-latest + steps: + - name: Setup bump release + id: bump_setup + run: | + if [ ${{ contains(github.event.pull_request.labels.*.name, 'release:major') }} == true ]; then + echo "::set-output name=type::major" + elif [ ${{ contains(github.event.pull_request.labels.*.name, 'release:minor') }} == true ]; then + echo "::set-output name=type::minor" + else + echo "::set-output name=type::patch" + fi + + - uses: actions/checkout@main + + - name: Create new Semantic Version + uses: zwaldowski/semver-release-action@v2 + id: new_semantic_setup + with: + bump: ${{ steps.bump_setup.outputs.type }} + github_token: ${{ secrets.GITHUB_TOKEN }} + dry_run: true + prefix: v + + - name: Make the github release + uses: ncipollo/release-action@v1.10.0 + with: + token: ${{ secrets.GITHUB_TOKEN }} + prerelease: true + tag: ${{ steps.new_semantic_setup.outputs.version_tag }} + + unit-test: + uses: Moderlab-Production/BlenderTemplate/.github/workflows/unit_test.yml@main diff --git a/.github/workflows/unit_test.yml b/.github/workflows/unit_test.yml new file mode 100644 index 0000000..6a2e732 --- /dev/null +++ b/.github/workflows/unit_test.yml @@ -0,0 +1,28 @@ +name: Unit Test + +on: + workflow_call: + push: + branches-ignore: + - main + - develop + + +jobs: + unit-test: + name: Unit Test + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@main + - uses: actions/setup-python@v2 + with: + python-version: "3.10" + - name: Setup python to execute all Unit Test + run: | + python -m pip install --upgrade pip + python -m pip install -r tests/requirements.txt + + - name: Start all Unit Test + run: | + cd ${{ github.workspace }} + python tests/main.py \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9da9f05 --- /dev/null +++ b/.gitignore @@ -0,0 +1,30 @@ +### PyCharm ### +.idea/ +.run/ + +### Python ### +# Byte-compiled / optimized / DLL files +__pycache__/ +**/__pycache__/ + + +# Unit Test # +*.zip +tests/blender/** +tests/blender/*.dmg +!tests/blender/.keep + +### Blender ### +*.blend1 + +### Unreal ### +tests/unreal_sample/DerivedDataCache +tests/unreal_sample/Intermediate +tests/unreal_sample/Saved + +# Secret file +**/token.txt + +# Virtual Environment +**/venv/** +venv/ \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/blender_addon_folder/__init__.py b/blender_addon_folder/__init__.py new file mode 100644 index 0000000..b6aa4d0 --- /dev/null +++ b/blender_addon_folder/__init__.py @@ -0,0 +1,31 @@ +import bpy + +bl_info = { + 'name': 'Addon Name', + 'description': 'Add your description', + 'author': 'Moderlab, Aurelien Vaillant, Nicolas Salles, Jeremy Duchesne', + 'version': (0, 0, 0), + 'blender': (3, 0, 0), + 'doc_url': "", + 'tracker_url': "", + 'support': "COMMUNITY", + 'category': 'Moderlab', +} + +modules_class = [ + # Main Property +] + + +def register(): + for cls in modules_class: + bpy.utils.register_class(cls) + + +def unregister(): + for cls in reversed(modules_class): + bpy.utils.unregister_class(cls) + + +if __name__ == "__main__": + register() diff --git a/linter/.pylintrc b/linter/.pylintrc new file mode 100644 index 0000000..36d197b --- /dev/null +++ b/linter/.pylintrc @@ -0,0 +1,224 @@ +[MAIN] +analyse-fallback-blocks=no +confidence=HIGH, + CONTROL_FLOW, + INFERENCE, + INFERENCE_FAILURE, + UNDEFINED +disable= +enable= +evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)) +exit-zero=no +extension-pkg-allow-list=bpy +extension-pkg-whitelist= +fail-on= +fail-under=10 +#from-stdin=no | not working ? +ignore=CVS +ignore-paths= +ignore-patterns=^\.# +ignored-modules=bpy, + mathutils, + bl_math, + bl_ui, + bl_operators +#jobs=0 | multiprocessing, get errors +limit-inference-results=100 +load-plugins= +msg-template= +output-format=colorized +persistent=yes +py-version=3.10 +recursive=yes +reports=no +score=yes +suggestion-mode=yes +unsafe-load-any-extension=no + + +[BASIC] +argument-naming-style=snake_case +argument-rgx= +attr-naming-style=snake_case +attr-rgx= +bad-names=foo, + bar, + baz, + toto, + tutu, + tata +bad-names-rgxs= +class-attribute-naming-style=any +class-attribute-rgx= +class-const-naming-style=UPPER_CASE +class-const-rgx= +class-naming-style=PascalCase +class-rgx=^MLB_[A-Z]{2}_[a-z_]+$|^[A-Za-z]+$ +const-naming-style=UPPER_CASE +const-rgx= +docstring-min-length=-1 +function-naming-style=snake_case +#function-rgx= +good-names=i, + _, + ob, + wm, + me, +good-names-rgxs= +include-naming-hint=no +inlinevar-naming-style=any +inlinevar-rgx= +method-naming-style=snake_case +method-rgx= +module-naming-style=snake_case +module-rgx= +name-group= +no-docstring-rgx=(poll)?|(execute)?|(invoke)? +property-classes=abc.abstractproperty +typevar-rgx= +variable-naming-style=snake_case +variable-rgx= + + +[CLASSES] +check-protected-access-in-special-methods=no +defining-attr-methods=__init__, + __new__, + setUp, + __post_init__ +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make +valid-classmethod-first-arg=cls +valid-metaclass-classmethod-first-arg=cls + + +[DESIGN] +exclude-too-few-public-methods= +ignored-parents= +max-args=5 +max-attributes=7 +max-bool-expr=5 +max-branches=12 +#max-complexity=10 Option not working +max-locals=15 +max-parents=7 +max-public-methods=20 +max-returns=6 +max-statements=50 +min-public-methods=0 + + +[EXCEPTIONS] +overgeneral-exceptions=BaseException, + Exception + + +[FORMAT] +expected-line-ending-format= +ignore-long-lines=^\s*(# )??$ +indent-after-paren=4 +indent-string=' ' +max-line-length=119 +max-module-lines=1000 +single-line-class-stmt=no +single-line-if-stmt=no + + +[IMPORTS] +allow-any-import-level= +allow-wildcard-with-all=no +deprecated-modules= +ext-import-graph= +import-graph= +int-import-graph= +known-standard-library= +known-third-party=enchant +preferred-modules= + + +[LOGGING] +logging-format-style=old +logging-modules=logging, + + +[MISCELLANEOUS] +notes=FIXME, + TODO +notes-rgx= + + +[REFACTORING] +max-nested-blocks=5 +never-returning-functions=sys.exit,argparse.parse_error + + +[SIMILARITIES] +ignore-comments=yes +ignore-docstrings=yes +ignore-imports=yes +ignore-signatures=yes +min-similarity-lines=8 + + +[SPELLING] +max-spelling-suggestions=4 +spelling-dict= +spelling-ignore-comment-directives=fmt: on, + fmt: off, + noqa:, + noqa, + nosec, + isort:skip, + mypy: +spelling-ignore-words= +spelling-private-dict-file= +spelling-store-unknown-words=no + + +[STRING] +check-quote-consistency=no +check-str-concat-over-line-jumps=no + + +[TYPECHECK] +contextmanager-decorators=contextlib.contextmanager +generated-members= +ignore-mixin-members=yes +ignore-none=yes +ignore-on-opaque-inference=yes +ignored-checks-for-mixins=no-member, + not-async-context-manager, + not-context-manager, + attribute-defined-outside-init +ignored-classes=optparse.Values, + thread._local, + _thread._local, + argparse.Namespace +missing-member-hint=yes +missing-member-hint-distance=1 +missing-member-max-choices=1 +mixin-class-rgx=.*[Mm]ixin +signature-mutators= + + +[VARIABLES] +additional-builtins= +allow-global-unused-variables=yes +allowed-redefined-builtins= +callbacks=cb_, + _cb +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ +ignored-argument-names=_.*|^ignored_|^unused_|^self|^context|^event +init-import=no +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io + +#enable-all-extensions= +#errors-only= +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= +# In verbose mode, extra non-checker-related info will be displayed. +#verbose= diff --git a/linter/requirements_linter.txt b/linter/requirements_linter.txt new file mode 100644 index 0000000..02ba427 --- /dev/null +++ b/linter/requirements_linter.txt @@ -0,0 +1 @@ +pylint~=2.14 \ No newline at end of file diff --git a/presets/.keep b/presets/.keep new file mode 100644 index 0000000..e69de29 diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..7c91ccd --- /dev/null +++ b/readme.md @@ -0,0 +1,40 @@ +[![Python 3.10.2](https://img.shields.io/badge/python-3.10.2-sucess.svg)](https://www.python.org/downloads/release/python-3102/) +![Blender](https://img.shields.io/badge/blender-3.1.0-sucess) + +# Blender Addon +This repository is a toolbox to create a new blender addon. To used-it, clone this repository and rename the folder "blender_addon_folder" with your addon name. +It's important to change some files : +- [x] Update the file "tests/main.py", line 29, set your addon name. + ```python + # Prepare Blender and Unreal dependency + generate_archive(archives, 'blender_addon_folder') + ``` +- [x] You can remove the folder "presets" and disable the workflow (`.github/workflows/pr_main.yml`, line 38 and 53) + + +> ⚠️ It's more easy to use the "_" with your addon folder name, the "-" character can be problematic with python use. + +All features covered with this template are : +- [x] Generate addon release (.zip archive) +- [x] Generate preset release (.zip archive) +- [x] Update addon version (bl info) with tag name +- [x] Execute unit test with Github Action (check if the addon can be installed with blender) +- [x] Configuration with Pycharm to test locally + + +## Unit Test +All unit tests call docker image [stilobique/blender](https://hub.docker.com/repository/docker/stilobique/blender). It's a simple ubuntu image with blender compile. +If you want change the blender version tested, edit the `main.py` inside the `tests` folder ; change the tag version with your requested tag. + +`````python +class Container(enum.Enum): + """Enumerate about the Geometry node""" + BLENDER = ContainerObject(name='Blender', image='stilobique/blender', tag='3.1.2') +````` + + +# Addons/Plugins dependency +Update json file `tests/dependency.json` with name, archive and repository Github path. Each entry require `archive +name`, the repository url path '{owner}/{repo}' and optional parameter if the release needed to be a prerelease. + +> ⛔ The `moderlab_plugin` need to be on last entry. diff --git a/releases/.keep b/releases/.keep new file mode 100644 index 0000000..e69de29 diff --git a/tests/blends_sample/default_startup.blend b/tests/blends_sample/default_startup.blend new file mode 100644 index 0000000..091f4cc Binary files /dev/null and b/tests/blends_sample/default_startup.blend differ diff --git a/tests/dependency.json b/tests/dependency.json new file mode 100644 index 0000000..a449c26 --- /dev/null +++ b/tests/dependency.json @@ -0,0 +1,11 @@ +{ + "blender": { + "moderlab_type": ["moderlab_type.zip", "Moderlab-Production/BlenderObjectType", "prerelease"], + "moderlab_pie": ["moderlab_plugin.zip", "Moderlab-Production/BlenderPieMenu"], + "moderlab_plugin": ["moderlab_plugin.zip", "Moderlab-Production/BlenderPlugin"] + }, + "unreal": { + "unreal-pipeline": ["unreal-moderlab-pipeline.zip", "Moderlab-Production/UnrealPipeline"], + "unreal-type": ["Moderlab-Unreal-Type.zip", "Moderlab-Production/UnrealType"] + } +} \ No newline at end of file diff --git a/tests/launch_test_b3d.sh b/tests/launch_test_b3d.sh new file mode 100644 index 0000000..a9bf8a0 --- /dev/null +++ b/tests/launch_test_b3d.sh @@ -0,0 +1,3 @@ +#!/bin/bash +/opt/blender/blender --background --python-exit-code 1 --python "$FOLDER_TEST/tests/utils/blender_addon.py" > /dev/null 2>&1 || exit 1 +/opt/blender/blender --background -noaudio --disable-autoexec --python-exit-code 1 --python "$1" -- --verbose || exit 1 \ No newline at end of file diff --git a/tests/main.py b/tests/main.py new file mode 100644 index 0000000..dc6d9e9 --- /dev/null +++ b/tests/main.py @@ -0,0 +1,54 @@ +import sys +import os +import enum + +from pathlib import Path +from utils.blender import get_b3d_addon_dependency +from utils.container import VirtualMachine +from utils.misc import ordering_test_file, generate_archive +from utils.properties import ContainerObject + + +class Container(enum.Enum): + """Enumerate about the Geometry node""" + BLENDER = ContainerObject(name='Blender', image='stilobique/blender', tag='3.1.2') + + +def launch_unit_test(test: [str] = None): + """Start all Unit Test, Blender and Unreal if needed""" + # Ordering Unit test Blender/Unreal + if test is None: + test = ordering_test_file() + b3d = test['blender'] + else: + b3d = test + + vm_b3d = VirtualMachine(Container.BLENDER.value) + vm_b3d.launch_unit_test(tests=b3d) + + +if __name__ == '__main__': + # Initialize Variable and module request + archives = [] + + # Prepare Blender and Unreal dependency + get_b3d_addon_dependency(archives) + generate_archive(archives, 'blender_addon_folder') + + # Generate Unit Test, a specific call or execute all Unit Test + test_list = None + if sys.argv: + for arg in sys.argv: + if '--test=' in arg: + test_list = [] + items = arg.replace('--test=', '').split(',') + for item in items: + test_list.append(item) + + # Launch Unit Test + launch_unit_test(test=test_list) + + # Clear archive file and container + for archive in archives: + if Path(Path(os.getcwd(), archive)).exists(): + os.remove(Path(os.getcwd(), archive)) diff --git a/tests/requirements.txt b/tests/requirements.txt new file mode 100644 index 0000000..36011d0 --- /dev/null +++ b/tests/requirements.txt @@ -0,0 +1,2 @@ +docker +PyGithub \ No newline at end of file diff --git a/tests/unit_test/test_b3d_install_addon.py b/tests/unit_test/test_b3d_install_addon.py new file mode 100644 index 0000000..6f87ad5 --- /dev/null +++ b/tests/unit_test/test_b3d_install_addon.py @@ -0,0 +1,25 @@ +import unittest +import bpy +import glob +import os + + +class ActivateAddon(unittest.TestCase): + """Activate the Blender addon""" + + @staticmethod + def get_folder_name(): + """Return the folder name to get the addon name we want activated""" + addon = glob.glob("/addon_moderlab/*/__init__.py", recursive=True) + return os.path.basename(os.path.dirname(addon[0])) + + def test_activate_addon(self): + """Activate the blender addon 'moderlab_plugin'""" + addon = bpy.ops.preferences.addon_enable(module=self.get_folder_name()) + self.assertEqual({'FINISHED'}, addon) + + +if __name__ == '__main__': + import sys + sys.argv = [__file__] + (sys.argv[sys.argv.index("--") + 1:] if "--" in sys.argv else []) + unittest.main() diff --git a/tests/utils/__init__.py b/tests/utils/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/utils/blender.py b/tests/utils/blender.py new file mode 100644 index 0000000..99c3bc3 --- /dev/null +++ b/tests/utils/blender.py @@ -0,0 +1,21 @@ +import json +import os + +from pathlib import Path +from .forge import get_release_file + + +def get_b3d_addon_dependency(archive: list): + """From json resources, get all blender dependency and download-it""" + dependency = Path(os.getcwd(), "tests", "dependency.json") + with open(dependency) as f: + data = json.load(f) + + b3d_dependency = data['blender'] + for key, value in b3d_dependency.items(): + if 'prerelease' in value: + prerelease = True + else: + prerelease = False + get_release_file(value[0], value[1], prerelease=prerelease) + archive.append(value[0]) diff --git a/tests/utils/blender_addon.py b/tests/utils/blender_addon.py new file mode 100644 index 0000000..1b004b0 --- /dev/null +++ b/tests/utils/blender_addon.py @@ -0,0 +1,58 @@ +import os +import bpy +import pathlib +import json +import shutil + + +def b3d_install_addon(): + """Function to install addon with the blender locally set""" + env_name = 'FOLDER_TEST' + dependency = pathlib.Path(os.environ[env_name], "tests", "dependency.json") + with open(dependency) as f: + data = json.load(f) + + b3d_dependency = data['blender'] + + try: + if not os.environ.get(env_name): + raise KeyError + env_path = pathlib.Path(os.environ[env_name]) + if not env_path.exists(): + raise FileNotFoundError + + for key, value in b3d_dependency.items(): + bpy.ops.preferences.addon_install(filepath=f'{env_path}/{value[0]}') + bpy.ops.preferences.addon_enable(module=key) + bpy.ops.wm.save_userpref() + + except KeyError: + print(f'Env. "{env_name}" doesn\'t exist') + exit(1) + except FileNotFoundError: + print('Wrong path to execute this Unit Test') + exit(1) + + +def b3d_install_preset(): + """If the folder preset exist, add all preset inside the moderlab dedicated folder""" + env_name = 'FOLDER_TEST' + + try: + if not os.environ.get(env_name): + raise KeyError + + path_preset = pathlib.Path(bpy.utils.preset_paths("")[0]) + path_locally = pathlib.Path(os.environ.get(env_name), "presets") + + if path_locally.exists(): + shutil.copytree(path_locally, path_preset.joinpath("moderlab", "props")) + + except KeyError: + print(f'Env. "{env_name}" doesn\'t exist') + exit(1) + + +if __name__ == '__main__': + b3d_install_addon() + b3d_install_preset() diff --git a/tests/utils/container.py b/tests/utils/container.py new file mode 100644 index 0000000..c6189f7 --- /dev/null +++ b/tests/utils/container.py @@ -0,0 +1,75 @@ +import docker +import os +import sys + +from pathlib import PurePosixPath +from docker.errors import DockerException +from .issue import ContainerErrorTest +from .properties import ContainerObject + + +class VirtualMachine: + def __init__(self, container: ContainerObject): + self.client = self.start_docker() + + self.container = container + self.base_command = self.container.commands + self.clear_containers() + + @staticmethod + def start_docker(): + """Generate docker client information""" + try: + client = docker.from_env() + return client + + except DockerException: + print('Docker isn\'t start or installed') + exit(1) + + def clear_containers(self): + """Look all docker containers, and remove-it if the task are used with the unit test.""" + containers = self.client.containers.list(all=True) + + for container in containers: + image_tag = container.image.tags[0] + status = container.status + if image_tag in self.container.ref and status in 'exited': + container.remove() + + @staticmethod + def workspace(): + """Define the workspace folder""" + if os.environ.get('GITHUB_WORKSPACE'): + return os.environ['GITHUB_WORKSPACE'] + else: + return os.getcwd() + + def launch_unit_test(self, tests: list[str]): + """Execute a docker container to start unit test dedicated""" + if tests is None: + unit_test = os.listdir(self.workspace()) + else: + if type(tests) is not list: + tests = [tests] + unit_test = tests + + try: + for test in unit_test: + print(f'Launch unit test "{test}"') + cmds = self.base_command + [f'{PurePosixPath(self.container.local_folder, "tests", "unit_test", test)}'] + + docker_test = self.client.containers.run(self.container.ref, command=cmds, + volumes=self.container.volumes, privileged=True, + environment=self.container.environments, detach=True, + name=test, tty=True) + exit_docker = docker_test.wait() + if exit_docker['StatusCode'] != 0: + print(f'Container error "{exit_docker["StatusCode"]}".\n\t' + f'Show log : \n\t' + f'{docker_test.logs()}') + raise ContainerErrorTest + + except ContainerErrorTest as exception: + print(f'{exception.__doc__}') + sys.exit(1) diff --git a/tests/utils/forge.py b/tests/utils/forge.py new file mode 100644 index 0000000..db29572 --- /dev/null +++ b/tests/utils/forge.py @@ -0,0 +1,51 @@ +import os +import requests + +from pathlib import Path +from github import Github + + +def read_token(): + token_file = Path(os.getcwd(), 'tests', 'token.txt') + if token_file.exists(): + with open(token_file, 'r') as f: + token = f.read() + + else: + token = os.environ.get('token') + + return token + + +def get_release_file(filename: str, repo: str, prerelease: bool = False): + """Download from Github the latest release files""" + g = Github(read_token()) + repository = g.get_repo(repo) + all_releases = repository.get_releases() + assets_release = None + + for release in all_releases: + print(f'Get "{filename}", with a prerelease value to "{prerelease}" ') + if release.prerelease is prerelease: + assets_release = release.get_assets() + break + else: + assets_release = release.get_assets() + break + + for file in assets_release: + if file.name == filename: + dl_file(file.url, file.name) + + +def dl_file(url: str, filename: str): + """From specific asset, download it""" + headers = { + 'Authorization': f'token {read_token()}', + 'Accept': 'application/octet-stream' + } + session = requests.Session() + link = session.get(url, stream=True, headers=headers) + with open(filename, 'wb') as f: + for chunk in link.iter_content(1024*1024): + f.write(chunk) diff --git a/tests/utils/issue.py b/tests/utils/issue.py new file mode 100644 index 0000000..962f897 --- /dev/null +++ b/tests/utils/issue.py @@ -0,0 +1,12 @@ +class Archive(Exception): + def __init__(self, source): + self.source = source + + +class ArchiveFolderSourceNotFound(Archive): + def __str__(self): + return f'Can\'t find the folder source "{self.source}".' + + +class ContainerErrorTest(Exception): + """ Failed to generate the test """ diff --git a/tests/utils/misc.py b/tests/utils/misc.py new file mode 100644 index 0000000..fd7ba70 --- /dev/null +++ b/tests/utils/misc.py @@ -0,0 +1,47 @@ +import os +import pathlib +import sys +import zipfile + +from .issue import ArchiveFolderSourceNotFound + + +def generate_archive(list_clean: list, name: str): + """From the plugin folder, generate an archive to test his code""" + archive_path_source = pathlib.Path(os.getcwd(), name) + archive_filename = pathlib.Path(os.getcwd(), f"{name}.zip") + archive_file_generate = zipfile.ZipFile(archive_filename, 'w') + + try: + # Check if all default folder are present. + if not archive_path_source.exists(): + raise ArchiveFolderSourceNotFound(source=name) + + for directory, subdir, files in os.walk(archive_path_source): + if '__pycache__' not in directory: + for file in files: + append_file = pathlib.Path(directory, file) + included_file = pathlib.Path(os.path.relpath(append_file)) + archive_file_generate.write(append_file, included_file) + + archive_file_generate.close() + list_clean.append(archive_filename) + + except BaseException as e: + print(f'Generate Archive error : \n\t{e}') + sys.exit(1) + + +def ordering_test_file(): + unit_test_folder = pathlib.Path(os.getcwd(), "tests", "unit_test") + unit_test = os.listdir(unit_test_folder) + unit_test_b3d = [] + unit_test_ue = [] + + for test in unit_test: + if '_ue_' in test: + unit_test_ue.append(test) + elif '_b3d_' in test: + unit_test_b3d.append(test) + + return {'blender': unit_test_b3d, 'unreal': unit_test_ue} diff --git a/tests/utils/properties.py b/tests/utils/properties.py new file mode 100644 index 0000000..3cc955c --- /dev/null +++ b/tests/utils/properties.py @@ -0,0 +1,69 @@ +import os + +from pathlib import PurePosixPath + + +class ContainerObject(object): + """All data request to launch one dedicated container""" + + def __init__(self, name: str, image: str, tag: str = None): + self.label: str = name.lower() + self.image: str = image + self.tag: str = self.set_tag(tag) + self.local_folder: str = '' + self.volumes: list[str] = self.set_volumes() + self.environments: list[str] = self.set_environments() + self.commands: list[str] = self.set_commands() + self.ref = f'{self.image}:{self.tag}' + + def set_tag(self, tag): + """Determine the tag use with the docker image call""" + if 'blender' in self.label: + if tag is not None: + return tag + else: + return 'latest' + elif 'unreal' in self.label: + if tag is not None: + return tag + else: + return 'dev-slim-4.27.2' + else: + return None + + def set_volumes(self): + """Define folder/path with mount with each docker container""" + if 'blender' in self.label: + self.local_folder = '/addon_moderlab' + elif 'unreal' in self.label: + self.local_folder = '/project' + else: + return None + return [f'{self.workspace()}:{self.local_folder}'] + + def set_environments(self): + """Add environment variable start with the docker container""" + if 'blender' in self.label: + return [f'FOLDER_TEST={self.local_folder}'] + else: + return [] + + def set_commands(self): + """Write all commands execute on the docker container start""" + cmds = ['/bin/sh'] + if 'blender' in self.label: + cmds.append(str(PurePosixPath(self.local_folder, "tests", "launch_test_b3d.sh"))) + else: + cmds.append(str(PurePosixPath(self.local_folder, "tests", "launch_test_ue.sh"))) + cmds.append(str(PurePosixPath(self.local_folder, "tests", "unreal_sample", "empty_project", + "EmptyProject.uproject"))) + + return cmds + + @staticmethod + def workspace(): + """Define the workspace folder""" + if os.environ.get('GITHUB_WORKSPACE'): + return os.environ['GITHUB_WORKSPACE'] + else: + return os.getcwd()