Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

redundans: add linux-aarch64 build #52233

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

martin-g
Copy link
Contributor

Describe your pull request here


Please read the guidelines for Bioconda recipes before opening a pull request (PR).

General instructions

  • If this PR adds or updates a recipe, use "Add" or "Update" appropriately as the first word in its title.
  • New recipes not directly relevant to the biological sciences need to be submitted to the conda-forge channel instead of Bioconda.
  • PRs require reviews prior to being merged. Once your PR is passing tests and ready to be merged, please issue the @BiocondaBot please add label command.
  • Please post questions on Gitter or ping @bioconda/core in a comment.

Instructions for avoiding API, ABI, and CLI breakage issues

Conda is able to record and lock (a.k.a. pin) dependency versions used at build time of other recipes.
This way, one can avoid that expectations of a downstream recipe with regards to API, ABI, or CLI are violated by later changes in the recipe.
If not already present in the meta.yaml, make sure to specify run_exports (see here for the rationale and comprehensive explanation).
Add a run_exports section like this:

build:
  run_exports:
    - ...

with ... being one of:

Case run_exports statement
semantic versioning {{ pin_subpackage("myrecipe", max_pin="x") }}
semantic versioning (0.x.x) {{ pin_subpackage("myrecipe", max_pin="x.x") }}
known breakage in minor versions {{ pin_subpackage("myrecipe", max_pin="x.x") }} (in such a case, please add a note that shortly mentions your evidence for that)
known breakage in patch versions {{ pin_subpackage("myrecipe", max_pin="x.x.x") }} (in such a case, please add a note that shortly mentions your evidence for that)
calendar versioning {{ pin_subpackage("myrecipe", max_pin=None) }}

while replacing "myrecipe" with either name if a name|lower variable is defined in your recipe or with the lowercase name of the package in quotes.

Bot commands for PR management

Please use the following BiocondaBot commands:

Everyone has access to the following BiocondaBot commands, which can be given in a comment:

@BiocondaBot please update Merge the master branch into a PR.
@BiocondaBot please add label Add the please review & merge label.
@BiocondaBot please fetch artifacts Post links to CI-built packages/containers.
You can use this to test packages locally.

Note that the @BiocondaBot please merge command is now depreciated. Please just squash and merge instead.

Also, the bot watches for comments from non-members that include @bioconda/<team> and will automatically re-post them to notify the addressed <team>.

@martin-g martin-g added the aarch64 Related to adding linux-aarch64 support label Nov 20, 2024
Copy link
Contributor

coderabbitai bot commented Nov 20, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces modifications to the build.sh script and the meta.yaml file for the "Redundans" package. The build.sh script now includes enhanced error handling and debugging features by implementing set -xe, which ensures immediate exit on command failure and prints each command before execution. It sets the CPATH environment variable and organizes the creation of necessary installation and binary directories. The script grants execute permissions to redundans.py, modifies paths in the script using sed, and ensures that all relevant files are copied to their appropriate locations, including a new bin directory for binaries. Additionally, a cleanup step compiles the last binary and sets permissions for the test folder. In meta.yaml, the build number has been incremented from 0 to 1, and an entry for additional-platforms has been added to specify linux-aarch64, reflecting an enhancement for compatibility with ARM architectures.

Possibly related PRs

Suggested labels

please review & merge

Suggested reviewers

  • rpetit3

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e794839 and bb00e38.

📒 Files selected for processing (2)
  • recipes/redundans/build.sh (2 hunks)
  • recipes/redundans/meta.yaml (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • recipes/redundans/build.sh
  • recipes/redundans/meta.yaml

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (4)
recipes/redundans/build.sh (4)

Line range hint 6-11: Consider adding error checking for chmod operation

While the directory creation and structure look good, the chmod operation could benefit from error handling to ensure the script fails appropriately if permissions can't be set.

-chmod u+x redundans.py #To avoid permission issues
+if ! chmod u+x redundans.py; then
+    echo "Error: Failed to set execute permission on redundans.py"
+    exit 1
+fi

Line range hint 14-14: Clean up the sed backup file

The sed command creates a .bak file that should be removed to keep the installation directory clean.

-sed -i.bak 's|bin/SSPACE/SSPACE_Standard_v3.0.pl|SSPACE/SSPACE_Standard_v3.0.pl|g' redundans.py
+sed -i.bak 's|bin/SSPACE/SSPACE_Standard_v3.0.pl|SSPACE/SSPACE_Standard_v3.0.pl|g' redundans.py && rm redundans.py.bak

Line range hint 17-19: Optimize file copying operations

The current implementation has several inefficiencies:

  1. Multiple separate cp commands increase script complexity
  2. Test directory is unnecessarily duplicated in both locations
  3. No error checking for copy operations

Consider consolidating the copy operations and adding error checking:

-cp redundans.py $INSTALL_FOLDER/ && cp redundans.py $BIN_FOLDER && cp README.md $INSTALL_FOLDER/
-cp -r test/ $INSTALL_FOLDER/ && cp -r test/ $BIN_FOLDER && cp -r docs/ $INSTALL_FOLDER/ && cp LICENSE $INSTALL_FOLDER/
+# Create a function for safer copy operations
+copy_with_check() {
+    if ! cp "$@"; then
+        echo "Error: Failed to copy $@"
+        exit 1
+    fi
+}
+
+# Copy files more efficiently
+copy_with_check redundans.py $INSTALL_FOLDER/
+copy_with_check redundans.py $BIN_FOLDER/
+copy_with_check README.md LICENSE $INSTALL_FOLDER/
+copy_with_check -r test/ docs/ $INSTALL_FOLDER/
+ln -s $INSTALL_FOLDER/test $BIN_FOLDER/test  # Symlink instead of duplicate

Line range hint 25-29: Security and reliability concerns in binary handling

There are several issues to address:

  1. The permission setting of 777 is too permissive
  2. No verification of successful compilation
  3. The working directory changes could be safer

Consider these improvements:

-cd $BIN_FOLDER/last/ && make clean && make -j ${CPU_COUNT} && cd ..
-cp -t $BIN_FOLDER $BIN_FOLDER/last/bin/*
-chmod -R 777 $BIN_FOLDER/test/ && cd ..
+# Save current directory
+CURRENT_DIR=$(pwd)
+
+# Compile with error checking
+cd $BIN_FOLDER/last/ || exit 1
+make clean || exit 1
+make -j ${CPU_COUNT} || exit 1
+cd ..
+
+# Copy binaries with verification
+if ! cp -t $BIN_FOLDER $BIN_FOLDER/last/bin/*; then
+    echo "Error: Failed to copy last binaries"
+    exit 1
+fi
+
+# Set more restrictive permissions
+chmod -R u=rwX,g=rX,o=rX $BIN_FOLDER/test/
+
+# Return to original directory
+cd "$CURRENT_DIR" || exit 1
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7b33c11 and 0bcac3e.

📒 Files selected for processing (2)
  • recipes/redundans/build.sh (1 hunks)
  • recipes/redundans/meta.yaml (2 hunks)
🔇 Additional comments (4)
recipes/redundans/meta.yaml (2)

14-14: LGTM: Build number increment is appropriate

The build number increment is correct for adding new platform support.


63-64: Verify dependency compatibility for linux-aarch64

The addition of linux-aarch64 platform support looks good. However, please verify that all dependencies (especially binary ones like minimap2, miniasm, bwa, etc.) are available and tested for the aarch64 architecture in the bioconda channel.

recipes/redundans/build.sh (2)

3-3: Good addition of error handling!

The addition of set -xe improves build reliability by failing fast on errors and providing better debugging information through command echoing.


Line range hint 1-29: Verify aarch64 compatibility of all binary components

Since this PR adds linux-aarch64 support, please ensure:

  1. All compilation steps support aarch64 architecture
  2. Any pre-compiled binaries (like k8-Linux, platanus, GapCloser) have aarch64 versions available
  3. The make process for 'last' is tested on aarch64

@martin-g
Copy link
Contributor Author

@martin-g
Copy link
Contributor Author

martin-g and others added 3 commits November 21, 2024 09:01
Signed-off-by: Martin Tzvetanov Grigorov <[email protected]>
Trying to solve:
```
─ python >=3.10,<3.11.0a0  is not installable because there are no viable options
11:18:43 BIOCONDA INFO (OUT)    ├─ python [3.10.0|3.10.1|...|3.10.9] would require
11:18:43 BIOCONDA INFO (OUT)    │  └─ python_abi 3.10.* *_cp310, which conflicts with any installable versions previously reported;
11:18:43 BIOCONDA INFO (OUT)    └─ python 3.10.15 would require
11:18:43 BIOCONDA INFO (OUT)       └─ libzlib >=1.3.1,<2.0a0 , which conflicts with any installable versions previously reported
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
aarch64 Related to adding linux-aarch64 support
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant