nf-core / nf-core/modules

Sentieon License file resolution breaks if not supplied

Open
#12,544 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Nextflow
Stars
429
Forks
1.1k
Avg merge
1d 6h
Merged PRs (30d)
153

Description

Have you checked the docs?
Description of the bug

The Sentieon modules hard code some logic to fetch a secret and decide if it's a script or value.

In production, most users will set it to a DNS (sentieon-license-server.myorg.com:8990)

Move it into an optional path input for the process, it should work:

input:
// etc
path sentieon_license_file

script:
// etc
def sentieon_license_file ?: "export SENTIEON_LICENSE=${sentieon_license_file}"
// else SENTIEON_LICENSE must be set elsewhere, e.g. `env` configuration or `beforeScript`

Test users can supply a Sentieon License file as an input, while main users of Sentieon can supply the environment variable SENTIEON_LICENSE.

See https://github.com/nf-core/sarek/issues/2256

Command used and terminal output
n/a
Relevant files

n/a

System information

all

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Sentieon modules and reading how they currently resolve the license secret. Check the related nf-core/sarek issue for context, then verify that a license-file input works while SENTIEON_LICENSE can still be supplied through environment configuration or beforeScript. Done means the hard-coded resolution no longer breaks DNS-based production use.

Written by the indexing model from the issue text.

Assessment

Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.