scijava-scripts/melting-pot.sh at master · joshmoore/scijava-scripts · GitHub

History

executable file

612 lines (549 loc) · 16.3 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

#!/bin/sh

# ============================================================================

# melting-pot.sh

# ============================================================================

# Tests all components of a project affected by changes in its dependencies.

# First, an anecdote illustrating the problem this script solves:

# Suppose you have a large application, org:app:1.0.0, with many dependencies:

# org:foo:1.2.3, org:bar:3.4.5, and many others.

# Now suppose you make some changes to foo, and want to know whether deploying

# them (i.e., releasing a new foo and updating app to depend on that release)

# will break the app. So you manually update your local copy of app to depend

# on org:foo:1.3.0-SNAPSHOT, and run the build (including tests, of course).

# The build passes, but this alone is insufficient: org:bar:3.4.5 also depends

# on org:foo:1.2.3, so you manually update bar to use org:foo:1.3.0-SNAPSHOT,

# then build bar to verify that it also is not broken by the update.

# This process quickly becomes very tedious when there are dozens of

# components of app which all depend on foo.

# And more importantly, testing each component individually in this manner is

# still insufficient to determine whether all of them will truly work together

# at runtime, where only a single version of each component is deployed.

# For example: suppose org:bar:3.4.5 depends on org:lib:8.0.0, while

# org:foo:1.2.3 depends on org:lib:7.0.0. The relevant facts are:

# * Your new foo (org:foo:1.3.0-SNAPSHOT) builds against lib 7, and portions

# of it rely on lib-7-specific API.

# * The bar component pinned to foo 1.3.0-SNAPSHOT builds against lib 8; it

# compiles with passing tests because bar only invokes portions of the foo

# API which do not require lib-7-specific API.

# In this scenario, it is lib 8 that is actually deployed at runtime with the

# app, so parts of foo will be broken, even though both foo and bar build with

# passing tests individually.

# This "melting pot" build seeks to overcome many of these issues by unifying

# all components of the app into a single multi-module build, with all

# versions uniformly pinned to the ones that will actually be deployed at

# runtime.

# This goal is achieved by synthesizing a multi-module build including all

# affected components (or optionally, all components period) of the specific

# project, and then executing a Maven build with uniformly overridden versions

# of all components to the ones resolved for the project itself.

# IMPORTANT IMPLEMENTATION DETAIL! The override works by setting a version

# property for each component of the form "artifactId.version"; it is assumed

# that all components declare their dependencies using version properties of

# this form. E.g.:

# <dependency>

# <groupId>com.google.guava</groupId>

# <artifactId>guava</artifactId>

# <version>${guava.version}</version>

# </dependency>

# Using dependencyManagement is fine too, as long as it then uses this pattern

# to declare the versions as properties, which can be overridden.

# Any dependency which does not declare a version property matching this

# assumption will not be properly overridden in the melting pot!

# Author: Curtis Rueden

# ============================================================================

# -- Functions --

stderr() {

>&2 echo "$@"

}

debug() {

test "$debug" &&

stderr "+ $@"

}

info() {

test "$verbose" &&

stderr "[INFO] $@"

}

error() {

stderr "[ERROR] $@"

}

die() {

error $1

exit $2

}

unknownArg() {

error "Unknown option: $@"

usage=1

}

checkPrereqs() {

while [ $# -gt 0 ]

which $1 > /dev/null 2> /dev/null

test $? -ne 0 && die "Missing prerequisite: $1" 255

shift

done

}

verifyPrereqs() {

checkPrereqs git mvn xmllint

}

parseArguments() {

while [ $# -gt 0 ]

case "$1" in

-b|--branch)

branch="$2"

shift

;;

-c|--changes)

changes="$2"

shift

;;

-i|--includes)

includes="$2"

shift

;;

-e|--excludes)

excludes="$2"

shift

;;

-r|--remoteRepos)

remoteRepos="$2"

shift

;;

-l|--localRepo)

repoBase="$2"

shift

;;

-o|--outputDir)

outputDir="$2"

shift

;;

-p|--prune)

prune=1

;;

-v|--verbose)

verbose=1

;;

-d|--debug)

debug=1

;;

-f|--force)

force=1

;;

-s|--skipBuild)

skipBuild=1

;;

-h|--help)

usage=1

;;

-*)

unknownArg "$1"

;;

test -z "$project" && project="$1" ||

unknownArg "$1"

;;

esac

shift

done

test -z "$project" -a -z "$usage" &&

error "No project specified!" && usage=1

if [ "$usage" ]

then

echo "Usage: $(basename "$0") <project> [-b <branch>] [-c <GAVs>] \\

[-i <GAs>] [-e <GAs>] [-r <URLs>] [-l <dir>] [-o <dir>] [-pvfsh]

The project to build, including dependencies, with consistent versions.

Can be either G:A:V form, or a local directory pointing at a project.

-b, --branch

Override the branch/tag of the project to build. By default,

the branch used will be the tag named \"artifactId-version\".

-c, --changes

Comma-separated list of GAVs to inject into the project, replacing

normal versions. E.g.: \"com.mycompany:myartifact:1.2.3-SNAPSHOT\"

-i, --includes

Comma-separated list of GAs (no version; wildcards OK for G or A) to

include in the build. All by default. E.g.: \"mystuff:*,myotherstuff:*\"

-e, --excludes

Comma-separated list of GAs (no version; wildcards OK for G or A) to

exclude from the build. E.g.: \"mystuff:extraneous,mystuff:irrelevant\"

-r, --remoteRepos

Comma-separated list of additional remote Maven repositories to check

for artifacts, in the format id::[layout]::url or just url.

-l, --localRepos

Overrides the directory of the Maven local repository cache.

-o, --outputDir

Overrides the output directory. The default is \"melting-pot\".

-p, --prune

Build only the components which themselves depend on a changed

artifact. This will make the build much faster, at the expense of

not fully testing runtime compatibility across all components.

-v, --verbose

Enable verbose/debugging output.

-f, --force

Wipe out the output directory if it already exists.

-s, --skipBuild

Skips the final build step. Useful for automated testing.

-h, --help

Display this usage information.

--== Example ==--

sh melting-pot.sh net.imagej:imagej-common:0.15.1 \\

-r http://maven.imagej.net/content/groups/public \\

-c org.scijava:scijava-common:2.44.2 \\

-i 'org.scijava:*,net.imagej:*,net.imglib2:*,io.scif:*' \\

-e net.imglib2:imglib2-roi \\

-v -f -s

This command tests net.imagej:imagej-common:0.15.1 along with all of its

dependencies, pulled from its usual ImageJ Maven repository location.

The -c flag is used to override the org.scijava:scijava-common

dependency to use version 2.44.2 instead of its declared version 2.42.0.

Note that such overrides do not need to be release versions; you can

also test SNAPSHOTs the same way.

The -i option is used to include all imagej-common dependencies with

groupIds org.scijava, net.imagej, net.imglib2 and io.scif in the pot.

The -e flag is used to exclude net.imglib2:imglib2-roi from the pot.

exit 1

# If project is a local directory path, get its absolute path.

test -d "$project" && project=$(cd "$project" && pwd)

# Assign default parameter values.

test "$outputDir" || outputDir="melting-pot"

test "$repoBase" || repoBase="$HOME/.m2/repository"

}

createDir() {

test -z "$force" -a -e "$1" &&

die "Directory already exists: $1" 2

rm -rf "$1"

mkdir -p "$1"

cd "$1"

}

groupId() {

echo "${1%%:*}"

}

artifactId() {

local result="${1#*:}" # strip groupId

echo "${result%%:*}"

}

version() {

local result="${1#*:}" # strip groupId

case "$result" in

*:*)

result="${result#*:}" # strip artifactId

case "$result" in

*:*:*:*)

# G:A:P:C:V:S

result="${result#*:}" # strip packaging

result="${result#*:}" # strip classifier

;;

*:*:*)

# G:A:P:V:S

result="${result#*:}" # strip packaging

;;

# G:A:V or G:A:V:?

;;

esac

echo "${result%%:*}"

;;

esac

}

# Converts the given GAV into a path in the local repository cache.

repoPath() {

local gPath="$(echo "$(groupId "$1")" | tr :. /)"

local aPath="$(artifactId "$1")"

local vPath="$(version "$1")"

echo "$repoBase/$gPath/$aPath/$vPath"

}

# Gets the path to the given GAV's POM file in the local repository cache.

pomPath() {

local pomFile="$(artifactId "$1")-$(version "$1").pom"

echo "$(repoPath "$1")/$pomFile"

}

# Fetches the POM for the given GAV into the local repository cache.

downloadPOM() {

local g="$(groupId "$1")"

local a="$(artifactId "$1")"

local v="$(version "$1")"

debug "mvn dependency:get \\

-DrepoUrl=\"$remoteRepos\" \\

-DgroupId=\"$g\" \\

-DartifactId=\"$a\" \\

-Dversion=\"$v\" \\

-Dpackaging=pom"

mvn dependency:get \

-DrepoUrl="$remoteRepos" \

-DgroupId="$g" \

-DartifactId="$a" \

-Dversion="$v" \

-Dpackaging=pom > /dev/null ||

die "Problem fetching $g:$a:$v from $remoteRepos" 4

}

# Gets the POM path for the given GAV, ensuring it exists locally.

pom() {

local pomPath="$(pomPath "$1")"

test -f "$pomPath" || downloadPOM "$1"

test -f "$pomPath" || die "Cannot access POM: $pomPath" 9

echo "$pomPath"

}

# For the given XML file on disk ($1), gets the value of the

# specified XPath expression of the form "//$2/$3/$4/...".

xpath() {

local xmlFile="$1"

shift

local xpath="/"

while [ $# -gt 0 ]

# NB: Ignore namespace issues; see: http://stackoverflow.com/a/8266075

xpath="$xpath/*[local-name()='$1']"

shift

done

debug "xmllint --xpath \"$xpath\" \"$xmlFile\""

xmllint --xpath "$xpath" "$xmlFile" 2> /dev/null |

sed -E 's/^[^>]*>(.*)<[^<]*$/\1/'

}

# For the given GAV ($1), recursively gets the value of the

# specified XPath expression of the form "//$2/$3/$4/...".

pomValue() {

local pomPath="$(pom "$1")"

test "$pomPath" || die "Cannot discern POM path for $1" 6

shift

local value="$(xpath "$pomPath" $@)"

if [ "$value" ]

then

echo "$value"

else

# Path not found in POM; look in the parent POM.

local pg="$(xpath "$pomPath" project parent groupId)"

if [ "$pg" ]

then

# There is a parent POM declaration in this POM.

local pa="$(xpath "$pomPath" project parent artifactId)"

local pv="$(xpath "$pomPath" project parent version)"

pomValue "$pg:$pa:$pv" $@

}

# Gets the SCM URL for the given GAV.

scmURL() {

pomValue "$1" project scm connection | sed -E 's/^scm:git://'

}

# Gets the SCM tag for the given GAV.

scmTag() {

echo "$(artifactId "$1")-$(version "$1")"

}

# Fetches the source code for the given GAV. Returns the directory.

retrieveSource() {

local scmURL="$(scmURL "$1")"

test "$scmURL" || die "Cannot glean SCM URL for $1" 10

local scmBranch

test "$2" && scmBranch="$2" || scmBranch="$(scmTag "$1")"

local dir="$(groupId "$1")/$(artifactId "$1")"

debug "git clone \"$scmURL\" --branch \"$scmBranch\" --depth 1 \"$dir\""

git clone "$scmURL" --branch "$scmBranch" --depth 1 "$dir" 2> /dev/null

echo "$dir"

}

# Gets the list of dependencies for the project in the CWD.

deps() {

cd "$1"

debug "mvn dependency:list"

local depList=$(mvn dependency:list) ||

die "Problem fetching dependencies!" 5

echo "$depList" | grep '^\[INFO\] [^ ]' | sed 's/\[INFO\] //' | sort

cd - > /dev/null

}

# Checks whether the given GA(V) matches the specified filter pattern.

gaMatch() {

local ga="$1"

local filter="$2"

local g="$(groupId "$ga")"

local a="$(artifactId "$ga")"

local fg="$(groupId "$filter")"

local fa="$(artifactId "$filter")"

test "$fg" = "$g" -o "$fg" = "*" || return

test "$fa" = "$a" -o "$fa" = "*" || return

echo 1

}

# Determines whether the given GA(V) version is being overridden.

isChanged() {

local IFS=","

local change

for change in $changes

test "$(gaMatch "$1" "$change")" && echo 1 && return

done

}

# Determines whether the given GA(V) meets the inclusion criteria.

isIncluded() {

# do not include the changed artifacts we are testing against

test "$(isChanged "$1")" && return

local IFS=","

# ensure GA is not excluded

local exclude

for exclude in $excludes

test "$(gaMatch "$1" "$exclude")" && return

done

# ensure GA is included

test -z "$includes" && echo 1 && return

local include

for include in $includes

test "$(gaMatch "$1" "$include")" && echo 1 && return

done

}

# Deletes components which do not depend on a changed GAV.

pruneReactor() {

local dir

for dir in */*

info "Checking relevance of component $dir"

local deps="$(deps "$dir")"

test "$deps" || die "Cannot glean dependencies for '$dir'" 8

# Determine whether the component depends on a changed GAV.

local keep

unset keep

local dep

for dep in $deps

test "$(isChanged "$dep")" && keep=1 && break

done

# If the component is irrelevant, prune it.

if [ -z "$keep" ]

then

info "Pruning irrelevant component: $dir"

rm -rf "$dir"

done

}

# Tests if the given directory contains the appropriate source code.

isProject() {

local a="$(xpath "$1/pom.xml" project artifactId)"

test "$a" = "$(basename "$1")" && echo 1

}

# Generates an aggregator POM for all modules in the current directory.

generatePOM() {

echo '<?xml version="1.0" encoding="UTF-8"?>' > pom.xml

echo '<project xmlns="http://maven.apache.org/POM/4.0.0"' >> pom.xml

echo ' xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"' >> pom.xml

echo ' xsi:schemaLocation="http://maven.apache.org/POM/4.0.0' >> pom.xml

echo ' http://maven.apache.org/xsd/maven-4.0.0.xsd">' >> pom.xml

echo ' <modelVersion>4.0.0</modelVersion>' >> pom.xml

echo >> pom.xml

echo ' <groupId>melting-pot</groupId>' >> pom.xml

echo ' <artifactId>melting-pot</artifactId>' >> pom.xml

echo ' <version>0.0.0-SNAPSHOT</version>' >> pom.xml

echo ' <packaging>pom</packaging>' >> pom.xml

echo >> pom.xml

echo ' <name>Melting Pot</name>' >> pom.xml

echo >> pom.xml

echo ' <modules>' >> pom.xml

local dir

for dir in */*

if [ "$(isProject "$dir")" ]

then

echo " <module>$dir</module>" >> pom.xml

else

# Check for a child component of a multi-module project.

local childDir="$dir/$(basename "$dir")"

test "$(isProject "$childDir")" &&

echo " <module>$childDir</module>" >> pom.xml

done

echo ' </modules>' >> pom.xml

echo '</project>' >> pom.xml

}

# Creates and tests an appropriate multi-module reactor for the given project.

# All relevant dependencies which match the inclusion criteria are linked into

# the multi-module build, with each changed GAV overridding the originally

# specified version for the corresponding GA.

meltDown() {

# Fetch the project source code.

if [ -d "$1" ]

then

# Use local directory for the specified project.

test -d "$1" || die "No such directory: $1" 11

test -f "$1/pom.xml" || die "Not a Maven project: $1" 12

info "$1: local Maven project"

mkdir -p "LOCAL"

local dir="LOCAL/PROJECT"

ln -s "$1" "$dir"

else

# Treat specified project as a GAV.

info "$1: fetching project source"

local dir="$(retrieveSource "$1" "$branch")"

test -d "$dir" || die "Could not fetch project source" 3

# Get the project dependencies.

info "$1: determining project dependencies"

local deps="$(deps "$dir")"

test "$deps" || die "Cannot glean project dependencies" 7

local args="-Denforcer.skip"

# Process the dependencies.

info "$1: processing project dependencies"

local dep

for dep in $deps

local g="$(groupId "$dep")"

local a="$(artifactId "$dep")"

local v="$(version "$dep")"

local gav="$g:$a:$v"

test -z "$(isChanged "$gav")" &&

args="$args -D$a.version=$v"

if [ "$(isIncluded "$gav")" ]

then

info "$1: $a: fetching component source"

dir="$(retrieveSource "$gav")"

done

# Override versions of changed GAVs.

info "$1: processing changed components"

local TLS=,

local gav

for gav in $changes

local a="$(artifactId "$gav")"

local v="$(version "$gav")"

args="$args -D$a.version=$v"

done

unset TLS

# Prune the build, if applicable.

test "$prune" && pruneReactor

# Generate the aggregator POM.

info "Generating aggregator POM"

generatePOM

# Build everything.

if [ "$skipBuild" ]

then

info "Skipping the build; the command would have been:"

info "mvn $args test"

else

info "Building the project!"

# NB: All code is fresh; no need to clean.

debug "mvn $args test"

mvn $args test

info "$1: complete"

}

# -- Main --

verifyPrereqs

parseArguments $@

createDir "$outputDir"

meltDown "$project"

scijava-scripts/melting-pot.sh at master · joshmoore/scijava-scripts · GitHub

Expand file tree

Breadcrumbs

melting-pot.sh

Latest commit

History

Breadcrumbs

melting-pot.sh

File metadata and controls