Merge pull request #221 from mikepenz/feature/fail_on_error

Add option to configure `fail-on-error`

README.md

@@ -119,6 +119,7 @@ The following example showcases a gradle module in the root, without a module na
 | `gradle-dependency-path`    | Defines the path to the gradle dependency file, relative to the `gradle-project-path`. If not provided, automatically resolved via gradle and the `module` config. |
 | `sub-module-mode`  | Defines how the action handles sub projects/modules. Possible options `IGNORE`, `COMBINED`, `INDIVIDUAL`, `INDIVIDUAL_DEEP`. Default: `IGNORE`. |
 | `include-build-environment`  | Optional mode to enable the submission of the `buildEnvironment` as individual Manifest via the dependency submission API. Default: `false`. |
+| `fail-on-error`   | Optional setting to enable an action failure in case any of the dependencies can not be parsed. Default: `false`. |
 | `correlator`  | 'Optional correlator string to submit to GitHub to identify the dependency submission.  Defaults to generating based on gradle-build-module and gradle-build-configuration.' |
 
 | **sub-module-mode**      |    **Description**           |

__tests__/parse.test.ts

@@ -122,35 +122,35 @@ jest.setTimeout(180000)
 
 describe('parseGradleDependencyOutput', () => {
   test('parses output of gradle dependency command into dependencies', () => {
-    const dependencies = parseGradleGraph('test', GRADLE_DEPENDENCY_OUTPUT).packages
+    const dependencies = parseGradleGraph('test', GRADLE_DEPENDENCY_OUTPUT, 'IGNORE', false).packages
 
     expect(Object.values(dependencies).length).toEqual(GRADLE_EXAMPLE_DEPENDENCY_OUTPUT.length)
     expect(dependencies).toEqual(GRADLE_EXAMPLE_DEPENDENCY_OUTPUT)
   })
 
   test('parses output of gradle dependency command with unresolved dependencies', () => {
-    const dependencies = parseGradleGraph('test', GRADLE_DEPENDENCY_OUTPUT_UNRESOLVED).packages
+    const dependencies = parseGradleGraph('test', GRADLE_DEPENDENCY_OUTPUT_UNRESOLVED, 'IGNORE', false).packages
 
     expect(Object.values(dependencies).length).toEqual(GRADLE_EXAMPLE_DEPENDENCY_OUTPUT_UNRESOLVED.length)
     expect(dependencies).toEqual(GRADLE_EXAMPLE_DEPENDENCY_OUTPUT_UNRESOLVED)
   })
 
   test('parses output of gradle dependency command with unspecified dependencies', () => {
-    const dependencies = parseGradleGraph('test', GRADLE_DEPENDENCY_OUTPUT_UNSPECIFIED).packages
+    const dependencies = parseGradleGraph('test', GRADLE_DEPENDENCY_OUTPUT_UNSPECIFIED, 'IGNORE', false).packages
 
     expect(Object.values(dependencies).length).toEqual(GRADLE_EXAMPLE_DEPENDENCY_OUTPUT_UNSPECIFIED.length)
     expect(dependencies).toEqual(GRADLE_EXAMPLE_DEPENDENCY_OUTPUT_UNSPECIFIED)
   })
 
   test('parses output of gradle dependency command with bom into dependencies', () => {
-    const dependencies = parseGradleGraph('test', GRADLE_DEPENDENCY_OUTPUT_SPRING).packages
+    const dependencies = parseGradleGraph('test', GRADLE_DEPENDENCY_OUTPUT_SPRING, 'IGNORE', false).packages
 
     expect(Object.values(dependencies).length).toEqual(GRADLE_EXAMPLE_DEPENDENCY_OUTPUT_SPRING.length)
     expect(dependencies).toEqual(GRADLE_EXAMPLE_DEPENDENCY_OUTPUT_SPRING)
   })
 
   test('parses output of gradle dependency command with sub projects', () => {
-    const rootProject = parseGradleGraph('test', fs.readFileSync('__tests__/elasticoutput.txt', 'utf8'), 'INDIVIDUAL')
+    const rootProject = parseGradleGraph('test', fs.readFileSync('__tests__/elasticoutput.txt', 'utf8'), 'INDIVIDUAL', false)
     expect(rootProject).toEqual(GRADLE_EXAMPLE_DEPENDENCY_WITH_SUB_PROJECTS_OUTPUT)
   })
 })

__tests__/process.test.ts

@@ -15,7 +15,7 @@ jest.setTimeout(240000)
 describe('processBuildEnvironmentDependencyList', () => {
   process.env['GITHUB_WORKSPACE'] = '.'
   test('run in gradle-example', async () => {
-    const project = await processBuildEnvironmentDependencyList(true, 'gradle-example')
+    const project = await processBuildEnvironmentDependencyList(true, 'gradle-example', false)
     const dependencies = project.packages
     expect(dependencies).toHaveLength(BUILD_ENVIRONMENT_EXPECTED_OUTPUT.length)
     expect(dependencies).toEqual(BUILD_ENVIRONMENT_EXPECTED_OUTPUT)
@@ -31,7 +31,8 @@ describe('processDependencyList', () => {
       ':app',
       'debugCompileClasspath',
       new Map<string, string>(),
-      'IGNORE'
+      'IGNORE',
+      false
     )
     const dependencies = project.packages
     expect(dependencies).toHaveLength(EXPECTED_GRADLE_DEPENDENCY_OUTPUT.length)
@@ -40,14 +41,14 @@ describe('processDependencyList', () => {
 
   test('run in gradle-example with invalid configuration', async () => {
     try {
-      await processDependencyList(true, 'gradle-example', ':app', 'non-existing', new Map<string, string>(), 'IGNORE')
+      await processDependencyList(true, 'gradle-example', ':app', 'non-existing', new Map<string, string>(), 'IGNORE', false)
     } catch (error: any) {
       expect(error.message).toEqual("Failed to execute './gradlew :app:dependencies --configuration non-existing'")
     }
   })
 
   test('run in root', async () => {
-    const project = await processDependencyList(false, '', ':', 'compileClasspath', new Map<string, string>(), 'IGNORE')
+    const project = await processDependencyList(false, '', ':', 'compileClasspath', new Map<string, string>(), 'IGNORE', false)
     const dependencies = project.packages
     expect(dependencies).toHaveLength(EXPECTED_ROOT_GRADLE_DEPENDENCY_OUTPUT.length)
     expect(dependencies).toEqual(EXPECTED_ROOT_GRADLE_DEPENDENCY_OUTPUT)
@@ -63,7 +64,8 @@ describe('prepareDependencyManifest', () => {
       'debugCompileClasspath',
       undefined,
       new Map<string, string>(),
-      'IGNORE'
+      'IGNORE',
+      false
     )
     expect(manifests).toHaveLength(EXPECTED_GRADLE_DEPENDENCY_MULTI_LEVEL_OUTPUT_IGNORE.length)
     expect(manifests).toEqual(EXPECTED_GRADLE_DEPENDENCY_MULTI_LEVEL_OUTPUT_IGNORE)
@@ -77,7 +79,8 @@ describe('prepareDependencyManifest', () => {
       'debugCompileClasspath',
       undefined,
       new Map<string, string>(),
-      'COMBINED'
+      'COMBINED',
+      false
     )
     expect(manifests).toHaveLength(EXPECTED_GRADLE_DEPENDENCY_MULTI_LEVEL_OUTPUT_COMBINED.length)
     expect(manifests).toEqual(EXPECTED_GRADLE_DEPENDENCY_MULTI_LEVEL_OUTPUT_COMBINED)
@@ -91,7 +94,8 @@ describe('prepareDependencyManifest', () => {
       'debugCompileClasspath',
       undefined,
       new Map<string, string>(),
-      'INDIVIDUAL'
+      'INDIVIDUAL',
+      false
     )
     expect(manifests).toHaveLength(EXPECTED_GRADLE_DEPENDENCY_MULTI_LEVEL_OUTPUT_INDIVIDUAL.length)
     expect(manifests).toEqual(EXPECTED_GRADLE_DEPENDENCY_MULTI_LEVEL_OUTPUT_INDIVIDUAL)
@@ -105,7 +109,8 @@ describe('prepareDependencyManifest', () => {
       "",
       undefined,
       new Map<string, string>(),
-      'IGNORE'
+      'IGNORE',
+      false
     )
 
     expect(manifest).toHaveLength(EXPECTED_GRADLE_DEPENDENCY_UNFILTERED.length)

action.yml

@@ -39,6 +39,10 @@ inputs:
     required: false
     description: 'Optional mode to also submit the `buildEnvironment` to the dependency submission API. This will execute the `buildEnvironment` task on the root module.'
     default: 'false'
+  fail-on-error:
+    required: false
+    description: 'Optional setting to enable an action failure in case any of the dependencies can not be parsed. Default: `false`.'
+    default: 'false'
   correlator:
     required: false
     description: 'Optional correlator string to submit to GitHub to identify the dependency submission.  Defaults to generating based on gradle-build-module and gradle-build-configuration.'

src/main.ts

@@ -14,6 +14,7 @@ async function run(): Promise<void> {
   let subModuleMode: 'INDIVIDUAL' | 'INDIVIDUAL_DEEP' | 'COMBINED' | 'IGNORE'
   const subModuleModeInput = core.getInput('sub-module-mode')
   const includeBuildEnvironment = core.getBooleanInput('include-build-environment')
+  const failOnError = core.getBooleanInput('fail-on-error')
   let correlator = core.getInput('correlator')
 
   // verify inputs are valid
@@ -88,13 +89,19 @@ async function run(): Promise<void> {
       configuration,
       gradleDependencyPath.length !== 0 ? gradleDependencyPath[i] : undefined,
       moduleBuildConfigurations,
-      subModuleMode
+      subModuleMode,
+      failOnError
     )
     manifests.push(...subManifests)
   }
 
   if (includeBuildEnvironment) {
-    const buildEnvironmentManifest = await prepareBuildEnvironmentManifest(useGradlew, gradleProjectPath[0], undefined)
+    const buildEnvironmentManifest = await prepareBuildEnvironmentManifest(
+      useGradlew,
+      gradleProjectPath[0],
+      undefined,
+      failOnError
+    )
     manifests.push(...buildEnvironmentManifest)
   }