Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(manager/gradle): add support for Groovy and Kotlin maps #19127

Merged
merged 6 commits into from
Nov 29, 2022
Merged

feat(manager/gradle): add support for Groovy and Kotlin maps #19127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
cd67383
feat(manager/gradle): add support for Groovy and Kotlin maps
Churro Nov 27, 2022
670e46f
tests: replace for loops with single object match
Churro Nov 27, 2022
48bd560
Update lib/modules/manager/gradle/parser/handlers.ts
viceice Nov 28, 2022
e9314ef
codeBlock it all
Churro Nov 28, 2022
2a2b905
tests: replace for loops with single object match (act II)
Churro Nov 28, 2022
2cf4f83
Merge branch 'main' into gradle-map
rarkins Nov 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
217 changes: 217 additions & 0 deletions lib/modules/manager/gradle/parser.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { codeBlock } from 'common-tags';
import { Fixtures } from '../../../../test/fixtures';
import { fs, logger } from '../../../../test/util';
import { parseGradle, parseProps } from './parser';
Expand Down Expand Up @@ -59,6 +60,125 @@ describe('modules/manager/gradle/parser', () => {
});
});

describe('Groovy: multi var assignments', () => {
it('simple map', () => {
const input = codeBlock`
ext {
versions = [
spotbugs_annotations : '4.5.3',
core : '1.7.0',
]

ignored = [ 'asdf' ]

libraries = [:]
libraries += [
guava: "com.google.guava:guava:31.1-jre",
detekt: '1.18.1',
]
}
`;

const { vars } = parseGradle(input);
expect(vars).toMatchObject({
'versions.spotbugs_annotations': {
key: 'versions.spotbugs_annotations',
value: '4.5.3',
},
'versions.core': {
key: 'versions.core',
value: '1.7.0',
},
'libraries.guava': {
key: 'libraries.guava',
value: 'com.google.guava:guava:31.1-jre',
},
'libraries.detekt': {
key: 'libraries.detekt',
value: '1.18.1',
},
});
});

it('nested map', () => {
const input = codeBlock`
project.ext.versions = [
some: invalidsymbol,
android: [
buildTools: '30.0.3'
],
kotlin: '1.4.30',
androidx: [
paging: '2.1.2',
kotlin: [
stdlib: '1.4.20',
coroutines: '1.3.7',
],
],
espresso: '3.2.0'
]
`;

const { vars } = parseGradle(input);
expect(vars).toMatchObject({
'versions.android.buildTools': {
key: 'versions.android.buildTools',
value: '30.0.3',
},
'versions.kotlin': {
key: 'versions.kotlin',
value: '1.4.30',
},
'versions.androidx.paging': {
key: 'versions.androidx.paging',
value: '2.1.2',
},
'versions.androidx.kotlin.stdlib': {
key: 'versions.androidx.kotlin.stdlib',
value: '1.4.20',
},
'versions.androidx.kotlin.coroutines': {
key: 'versions.androidx.kotlin.coroutines',
value: '1.3.7',
},
'versions.espresso': {
key: 'versions.espresso',
value: '3.2.0',
},
});
});

it('map with interpolated dependency strings', () => {
const input = codeBlock`
def slfj4Version = "2.0.0"
libraries = [
jcl: "org.slf4j:jcl-over-slf4j:\${slfj4Version}",
releaseCoroutines: "org.jetbrains.kotlinx:kotlinx-coroutines-core:0.26.1-eap13"
api: "org.slf4j:slf4j-api:$slfj4Version",
]
`;

const { deps } = parseGradle(input);
expect(deps).toMatchObject([
{
depName: 'org.slf4j:jcl-over-slf4j',
groupName: 'slfj4Version',
currentValue: '2.0.0',
},
{
depName: 'org.jetbrains.kotlinx:kotlinx-coroutines-core',
groupName: 'libraries.releaseCoroutines',
currentValue: '0.26.1-eap13',
},
{
depName: 'org.slf4j:slf4j-api',
groupName: 'slfj4Version',
currentValue: '2.0.0',
},
]);
});
});

describe('Kotlin: single var assignments', () => {
test.each`
input | name | value
Expand All @@ -81,6 +201,103 @@ describe('modules/manager/gradle/parser', () => {
expect(vars).toBeEmpty();
});
});

describe('Kotlin: multi var assignments', () => {
it('simple map', () => {
const input =
'val versions = mapOf("foo1" to "bar1", "foo2" to "bar2", "foo3" to "bar3")';

const { vars } = parseGradle(input);
expect(vars).toMatchObject({
'versions.foo1': {
key: 'versions.foo1',
value: 'bar1',
},
'versions.foo2': {
key: 'versions.foo2',
value: 'bar2',
},
'versions.foo3': {
key: 'versions.foo3',
value: 'bar3',
},
});
});

it('nested map', () => {
const input = codeBlock`
ext["deps"] = mapOf(
"support" to mapOf(
"appCompat" to "com.android.support:appcompat-v7:26.0.2",
"invalid" to whatever,
"junit" to mapOf(
"jupiter" to "5.0.1",
"platform" to "1.0.1",
)
"design" to "com.android.support:design:26.0.2"
),
"support2" to mapOfInvalid(
"design2" to "com.android.support:design:26.0.2"
),
"picasso" to "com.squareup.picasso:picasso:2.5.2"
)
`;

const { vars } = parseGradle(input);
expect(vars).toMatchObject({
'deps.support.appCompat': {
key: 'deps.support.appCompat',
value: 'com.android.support:appcompat-v7:26.0.2',
},
'deps.support.junit.jupiter': {
key: 'deps.support.junit.jupiter',
value: '5.0.1',
},
'deps.support.junit.platform': {
key: 'deps.support.junit.platform',
value: '1.0.1',
},
'deps.support.design': {
key: 'deps.support.design',
value: 'com.android.support:design:26.0.2',
},
'deps.picasso': {
key: 'deps.picasso',
value: 'com.squareup.picasso:picasso:2.5.2',
},
});
});

it('map with interpolated dependency strings', () => {
const input = codeBlock`
val slfj4Version = "2.0.0"
libraries = mapOf(
"jcl" to "org.slf4j:jcl-over-slf4j:\${slfj4Version}",
"releaseCoroutines" to "org.jetbrains.kotlinx:kotlinx-coroutines-core:0.26.1-eap13"
"api" to "org.slf4j:slf4j-api:$slfj4Version",
)
`;

const { deps } = parseGradle(input);
expect(deps).toMatchObject([
{
depName: 'org.slf4j:jcl-over-slf4j',
groupName: 'slfj4Version',
currentValue: '2.0.0',
},
{
depName: 'org.jetbrains.kotlinx:kotlinx-coroutines-core',
groupName: 'libraries.releaseCoroutines',
currentValue: '0.26.1-eap13',
},
{
depName: 'org.slf4j:slf4j-api',
groupName: 'slfj4Version',
currentValue: '2.0.0',
},
]);
});
});
});

describe('dependencies', () => {
Expand Down
128 changes: 128 additions & 0 deletions lib/modules/manager/gradle/parser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,132 @@ const qKotlinSingleVarAssignment = q
})
.handler(cleanupTempVars);

// foo: "1.2.3"
const qGroovySingleMapOfVarAssignment = q
.sym(storeVarToken)
.handler((ctx) => {
ctx.tmpTokenStore.backupVarTokens = ctx.varTokens;
return ctx;
})
.handler(coalesceVariable)
.handler((ctx) => storeInTokenMap(ctx, 'keyToken'))
.op(':')
.join(qTemplateString)
.handler((ctx) => storeInTokenMap(ctx, 'valToken'))
.handler(handleAssignment)
.handler((ctx) => {
ctx.varTokens = ctx.tmpTokenStore.backupVarTokens!;
ctx.varTokens.pop();
return ctx;
});

// versions = [ android: [ buildTools: '30.0.3' ], kotlin: '1.4.30' ]
const qGroovyMultiVarAssignment = qVariableAssignmentIdentifier
.alt(q.op('='), q.op('+='))
.tree({
type: 'wrapped-tree',
maxDepth: 1,
startsWith: '[',
endsWith: ']',
search: q.alt(
q
.sym(storeVarToken)
.op(':')
.tree({
type: 'wrapped-tree',
maxDepth: 1,
startsWith: '[',
endsWith: ']',
search: q.alt(
q
.sym(storeVarToken)
.op(':')
.tree({
type: 'wrapped-tree',
maxDepth: 1,
startsWith: '[',
endsWith: ']',
search: qGroovySingleMapOfVarAssignment,
postHandler: (ctx) => {
ctx.varTokens.pop();
return ctx;
},
}),
qGroovySingleMapOfVarAssignment
),
postHandler: (ctx) => {
ctx.varTokens.pop();
return ctx;
},
}),
qGroovySingleMapOfVarAssignment
),
})
.handler(cleanupTempVars);

// "foo1" to "bar1"
const qKotlinSingleMapOfVarAssignment = qStringValue
.sym('to')
.handler((ctx) => {
ctx.tmpTokenStore.backupVarTokens = ctx.varTokens;
return ctx;
})
.handler(coalesceVariable)
.handler((ctx) => storeInTokenMap(ctx, 'keyToken'))
.join(qTemplateString)
.handler((ctx) => storeInTokenMap(ctx, 'valToken'))
.handler(handleAssignment)
.handler((ctx) => {
ctx.varTokens = ctx.tmpTokenStore.backupVarTokens!;
ctx.varTokens.pop();
return ctx;
});

// val versions = mapOf("foo1" to "bar1", "foo2" to "bar2", "foo3" to "bar3")
const qKotlinMultiMapOfVarAssignment = qVariableAssignmentIdentifier
.op('=')
.sym('mapOf')
.tree({
type: 'wrapped-tree',
maxDepth: 1,
startsWith: '(',
endsWith: ')',
search: q.alt(
qStringValue
.sym('to')
.sym('mapOf')
.tree({
type: 'wrapped-tree',
maxDepth: 1,
startsWith: '(',
endsWith: ')',
search: q.alt(
qStringValue
.sym('to')
.sym('mapOf')
.tree({
type: 'wrapped-tree',
maxDepth: 1,
startsWith: '(',
endsWith: ')',
search: qKotlinSingleMapOfVarAssignment,
postHandler: (ctx) => {
ctx.varTokens.pop();
return ctx;
},
}),
qKotlinSingleMapOfVarAssignment
),
postHandler: (ctx) => {
ctx.varTokens.pop();
return ctx;
},
}),
qKotlinSingleMapOfVarAssignment
),
})
.handler(cleanupTempVars);

// "foo:bar:1.2.3"
const qDependenciesSimpleString = qStringValue
.handler((ctx) => storeInTokenMap(ctx, 'stringToken'))
Expand Down Expand Up @@ -493,7 +619,9 @@ export function parseGradle(
maxDepth: 32,
search: q.alt<Ctx>(
qGroovySingleVarAssignment,
qGroovyMultiVarAssignment,
qKotlinSingleVarAssignment,
qKotlinMultiMapOfVarAssignment,
qDependenciesSimpleString,
qDependenciesInterpolation,
qGroovyMapNotationDependencies,
Expand Down
Loading