Commit 49e50e3
authored
Excise SRA support from htsjdk (#1774)
The NCBI SRA reader, backed by the gov.nih.nlm.ncbi:ngs-java native
library, has been a recurring source of build/runtime friction and is
being removed for v5.0.0. Downstream consumers that need SRA must
implement it themselves or use a different library.
Removed:
- gov.nih.nlm.ncbi:ngs-java api dependency from build.gradle.
- The "sra" TestNG group from build.gradle's test and testExternalApis
tasks (and from htsjdk.TestDataProviders.EXCLUDED_GROUPS).
- The -Dsamjdk.sra_libraries_download=true JVM arg from
testExternalApis. The corresponding Defaults.SRA_LIBRARIES_DOWNLOAD
field is removed.
- 10 main sources under htsjdk/samtools and htsjdk/samtools/sra/
(SRAFileReader, SRAIterator, SRAIndex, SRAAccession, SRALazyRecord,
SRAAlignmentIterator, SRAUnalignmentIterator, SRAUtils, ReferenceCache,
SRAIndexedSequenceFile).
- 7 test classes under htsjdk/samtools/sra/ and the test_archive.sra
resource.
- SamReader.Type.SRA_TYPE.
- The README's SRA license-attribution sentence.
Modified (SRA hooks removed):
- SamInputResource: drops InputResource.Type.SRA_ACCESSION, the
abstract asSRAAccession() method and all its overrides, the
SRAInputResource inner class, and the SamInputResource.of(SRAAccession)
factory.
- SamReaderFactory: drops the SRA dispatch in the resource type switch,
the isSra() autodetection branch, the abstract
applyTo(SRAFileReader, ...) method on Option and all five overrides
of it, plus the instanceof SRAFileReader branch.
- SamReaderFactoryTest, SamReaderTest, ReadsBundle (TODO comment): minor
follow-on edits where these referenced the removed types.
Verification:
- ./gradlew compileJava compileTestJava: passes.
- ./gradlew test: 21,877 / 21,877 pass (down from 21,936 on dev; the
difference is the removed sra test classes plus DataProvider-discovered
test paths that referenced the sra group).
- ./gradlew spotbugsMain spotbugsTest: clean, no new findings.
- ./gradlew spotlessCheck: clean (autoformat applied during compile).
- Stragglers: grep'd src/, build.gradle, README, CONTRIBUTING, CHANGELOG,
and .github/ for "SRA" tokens, "import ngs.", "sra" string literals,
"ngs-java", and "sra_libraries" -- no remaining references.
CHANGELOG entry deferred to the dedicated v5.0.0 CHANGELOG task.1 parent 41e497a commit 49e50e3
28 files changed
Lines changed: 9 additions & 3973 deletions
File tree
- src
- main/java/htsjdk
- beta/plugin/reads
- samtools
- sra
- test
- java/htsjdk
- samtools
- sra
- resources/htsjdk/samtools/sra
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
96 | 96 | | |
97 | 97 | | |
98 | 98 | | |
99 | | - | |
100 | 99 | | |
101 | 100 | | |
102 | 101 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
51 | 51 | | |
52 | 52 | | |
53 | 53 | | |
54 | | - | |
55 | 54 | | |
56 | 55 | | |
57 | 56 | | |
| |||
225 | 224 | | |
226 | 225 | | |
227 | 226 | | |
228 | | - | |
| 227 | + | |
229 | 228 | | |
230 | 229 | | |
231 | 230 | | |
232 | | - | |
| 231 | + | |
233 | 232 | | |
234 | | - | |
| 233 | + | |
235 | 234 | | |
236 | 235 | | |
237 | 236 | | |
| |||
250 | 249 | | |
251 | 250 | | |
252 | 251 | | |
253 | | - | |
| 252 | + | |
254 | 253 | | |
255 | 254 | | |
256 | | - | |
257 | 255 | | |
258 | 256 | | |
259 | | - | |
| 257 | + | |
260 | 258 | | |
261 | 259 | | |
262 | 260 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
201 | 201 | | |
202 | 202 | | |
203 | 203 | | |
204 | | - | |
| 204 | + | |
205 | 205 | | |
206 | 206 | | |
207 | 207 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
95 | 95 | | |
96 | 96 | | |
97 | 97 | | |
98 | | - | |
99 | | - | |
100 | | - | |
101 | | - | |
102 | | - | |
103 | | - | |
104 | 98 | | |
105 | 99 | | |
106 | 100 | | |
| |||
143 | 137 | | |
144 | 138 | | |
145 | 139 | | |
146 | | - | |
147 | 140 | | |
148 | 141 | | |
149 | 142 | | |
| |||
This file was deleted.
0 commit comments