aws / aws/aws-lambda-builders

JavaGradleWorkflow includes extraneous files if other archive artifacts are defined

Aperta
#138 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub
area/workflow/java_gradle maintainer/need-response
Lingua principale
Python
Stelle
380
Fork
161
Merge medio
1g 1h
PR unite (30g)
2

Descrizione

**Description:**

In certain Gradle projects, running `sam build` may include files in the bundle that aren't needed.
This occurs because the logic for grabbing the project's jar is actually pulling the contents of all defined archive artifacts, some of which may be for other purposes entirely. In most cases, this doesn't "break" anything, but just increases the size of the deployment bundle silently.

One example of a situation that would cause this is a Java project with the built-in "application" plugin applied, which then produces additional zip and tar distribution artifacts.

https://github.com/awslabs/aws-lambda-builders/blob/develop/aws_lambda_builders/workflows/java_gradle/resources/lambda-build-init.gradle#L62

One potential fix would be to change https://github.com/awslabs/aws-lambda-builders/blob/develop/aws_lambda_builders/workflows/java_gradle/resources/lambda-build-init.gradle#L27 from `def artifactJars = t.project.configurations.archives.artifacts.files.files` to `def artifactJars = configurations.archives.artifacts.findAll { it.extension == 'jar' }*.file`.

**Steps to reproduce the issue:**
1. Run `sam init --runtime java8 --dependency-manager gradle --name gradlebuildtest`
2. Run `cd gradlebuildtest/`
3. Run `sam build && find .aws-sam/build/HelloWorldFunction -type f` (Expected result)
4. Remove the previous result: `rm -rf .aws-sam/`
5. Edit `HelloWorldFunction/build.gradle` as follows
* Add `id 'application'` to the `plugins` block
* Add `mainClassName = 'helloworld.App'` (it's not actually executable yet, but that doesn't matter for demonstrating this behavior)
6. Run `sam build && find .aws-sam/build/HelloWorldFunction -type f` (Observed result)
7. Note that there is now an unnecessary `HelloWorldFunction` directory included.

**Observed result:**

```
mac-dcarr:gradlebuildtest dcarr$ sam build && find .aws-sam/build/HelloWorldFunction -type f
Building resource 'HelloWorldFunction'
Running JavaGradleWorkflow:GradleBuild
Running JavaGradleWorkflow:CopyArtifacts

Build Succeeded

Built Artifacts : .aws-sam/build
Built Template : .aws-sam/build/template.yaml

Commands you can use next
=========================
[*] Invoke Function: sam local invoke
[*] Package: sam package --s3-bucket

.aws-sam/build/HelloWorldFunction/helloworld/GatewayResponse.class
.aws-sam/build/HelloWorldFunction/helloworld/App.class
.aws-sam/build/HelloWorldFunction/HelloWorldFunction/bin/HelloWorldFunction
.aws-sam/build/HelloWorldFunction/HelloWorldFunction/bin/HelloWorldFunction.bat
.aws-sam/build/HelloWorldFunction/HelloWorldFunction/lib/aws-lambda-java-core-1.2.0.jar
.aws-sam/build/HelloWorldFunction/HelloWorldFunction/lib/HelloWorldFunction.jar
.aws-sam/build/HelloWorldFunction/META-INF/MANIFEST.MF
.aws-sam/build/HelloWorldFunction/lib/aws-lambda-java-core-1.2.0.jar
mac-dcarr:gradlebuildtest dcarr$
```

**Expected result:**

```
mac-dcarr:gradlebuildtest dcarr$ sam build && find .aws-sam/build/HelloWorldFunction -type f
Building resource 'HelloWorldFunction'
Running JavaGradleWorkflow:GradleBuild
Running JavaGradleWorkflow:CopyArtifacts

Build Succeeded

Built Artifacts : .aws-sam/build
Built Template : .aws-sam/build/template.yaml

Commands you can use next
=========================
[*] Invoke Function: sam local invoke
[*] Package: sam package --s3-bucket

.aws-sam/build/HelloWorldFunction/helloworld/GatewayResponse.class
.aws-sam/build/HelloWorldFunction/helloworld/App.class
.aws-sam/build/HelloWorldFunction/META-INF/MANIFEST.MF
.aws-sam/build/HelloWorldFunction/lib/aws-lambda-java-core-1.2.0.jar
mac-dcarr:gradlebuildtest dcarr$
```

**Additional environment details (Ex: Windows, Mac, Amazon Linux etc)**

Scripts were run on Mac OS X 10.14.6; SAM CLI, version 0.23.0.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia da aws_lambda_builders/workflows/java_gradle/resources/lambda-build-init.gradle, in particolare dalla selezione dell’artefatto dell’archivio e dai passaggi GradleBuild e CopyArtifacts di JavaGradleWorkflow. Riproduci il problema con i comandi documentati sam init, application-plugin edit, sam build e find. Il lavoro è completato quando la build include le classi dell’applicazione e i JAR delle dipendenze senza l’inutile directory di distribuzione dell’applicazione e i relativi file.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java
Ambito
build-system
Tipo di issue
Bug
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
38/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.