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

[ruby] Fixed Grouped Stmt Flows & Splat Ambiguity #4526

Merged
merged 1 commit into from
May 2, 2024
Merged

[ruby] Fixed Grouped Stmt Flows & Splat Ambiguity #4526

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions ...ubysrc2cpg/src/main/scala/io/joern/rubysrc2cpg/astcreation/AstForExpressionsCreator.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ trait AstForExpressionsCreator(implicit withSchemaValidation: ValidationMode) {
case node: ProcOrLambdaExpr => astForProcOrLambdaExpr(node)
case node: RubyCallWithBlock[_] => astsForCallWithBlockInExpr(node)
case node: SelfIdentifier => astForSelfIdentifier(node)
case node: StatementList => astForStatementList(node)
case node: DummyNode => Ast(node.node)
case _ => astForUnknown(node)

Expand Down
37 changes: 34 additions & 3 deletions ...li/frontends/rubysrc2cpg/src/main/scala/io/joern/rubysrc2cpg/parser/RubyNodeCreator.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,27 @@ class RubyNodeCreator extends RubyParserBaseVisitor[RubyNode] {
HereDocNode(ctx.hereDoc().getText)(ctx.toTextSpan)
}

override def visitPrimaryOperatorExpression(ctx: RubyParser.PrimaryOperatorExpressionContext): RubyNode = {
super.visitPrimaryOperatorExpression(ctx) match {
case x: BinaryExpression if x.lhs.text.endsWith("=") && x.op == "*" =>
// fixme: This workaround handles a parser ambiguity with method identifiers having `=` and assignments with
// splatting on the RHS. The Ruby parser gives precedence to assignments over methods called with this suffix
// however
val newLhs = x.lhs match {
case call: SimpleCall => SimpleIdentifier(None)(call.span.spanStart(call.span.text.stripSuffix("=")))
case y =>
logger.warn(s"Unhandled class in repacking of primary operator expression ${y.getClass}")
y
}
val newRhs = {
val oldRhsSpan = x.rhs.span
SplattingRubyNode(x.rhs)(oldRhsSpan.spanStart(s"*${oldRhsSpan.text}"))
}
SingleAssignment(newLhs, "=", newRhs)(x.span)
case x => x
}
}

override def visitPowerExpression(ctx: RubyParser.PowerExpressionContext): RubyNode = {
BinaryExpression(visit(ctx.primaryValue(0)), ctx.powerOperator.getText, visit(ctx.primaryValue(1)))(ctx.toTextSpan)
}
Expand Down Expand Up @@ -349,6 +370,14 @@ class RubyNodeCreator extends RubyParserBaseVisitor[RubyNode] {
SingleAssignment(lhs, op, rhs)(ctx.toTextSpan)
}

private def flattenStatementLists(x: List[RubyNode]): List[RubyNode] = {
x match {
case (head: StatementList) :: xs => head.statements ++ flattenStatementLists(xs)
case head :: tail => head +: flattenStatementLists(tail)
case Nil => Nil
}
}

override def visitMultipleAssignmentStatement(ctx: RubyParser.MultipleAssignmentStatementContext): RubyNode = {

/** Recursively expand and duplicate splatting nodes so that they line up with what they consume.
Expand All @@ -372,11 +401,13 @@ class RubyNodeCreator extends RubyParserBaseVisitor[RubyNode] {
.map(node => SplattingRubyNode(node)(node.span.spanStart(s"*${node.span.text}")))
)
.getOrElse(defaultResult()) match {
case x: StatementList => x.statements
case x: StatementList => flattenStatementLists(x.statements)
case x => List(x)
}
val rhsNodes = Option(ctx.multipleRightHandSide()).map(visit).getOrElse(defaultResult()) match {
case x: StatementList => x.statements
val rhsNodes = Option(ctx.multipleRightHandSide())
.map(visit)
.getOrElse(defaultResult()) match {
case x: StatementList => flattenStatementLists(x.statements)
case x => List(x)
}
val op = ctx.EQ().toString
Expand Down
15 changes: 6 additions & 9 deletions ...ds/rubysrc2cpg/src/test/scala/io/joern/rubysrc2cpg/dataflow/MultipleAssignmentTests.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ class MultipleAssignmentTests extends RubyCode2CpgFixture(withPostProcessing = t
sink.reachableByFlows(src).l.size shouldBe 2
}

// Works in deprecated - fails to parse in new frontend
"flow through multiple assignments with grouping" ignore {
"flow through multiple assignments with grouping" in {
val cpg = code("""
|x = 1
|y = 2
Expand All @@ -29,11 +28,10 @@ class MultipleAssignmentTests extends RubyCode2CpgFixture(withPostProcessing = t

val src = cpg.identifier.name("x").l
val sink = cpg.call.name("puts").l
sink.reachableByFlows(src).l.size shouldBe 2
sink.reachableByFlows(src).size shouldBe 2
}

// Works in deprecated - fails to parse in new frontend
"Data flow through multiple assignments with grouping and method in RHS" ignore {
"Data flow through multiple assignments with grouping and method in RHS" in {
val cpg = code("""
|def foo()
|x = 1
Expand All @@ -48,11 +46,10 @@ class MultipleAssignmentTests extends RubyCode2CpgFixture(withPostProcessing = t

val src = cpg.identifier.name("x").l
val sink = cpg.call.name("puts").l
sink.reachableByFlows(src).l.size shouldBe 2
sink.reachableByFlows(src).size shouldBe 2
}

// Works in deprecated
"Data flow through single LHS and splatting RHS" ignore {
"Data flow through single LHS and splatting RHS" in {
val cpg = code("""
|x=1
|y=*x
Expand All @@ -61,7 +58,7 @@ class MultipleAssignmentTests extends RubyCode2CpgFixture(withPostProcessing = t

val src = cpg.identifier.name("x").l
val sink = cpg.call.name("puts").l
sink.reachableByFlows(src).l.size shouldBe 2
sink.reachableByFlows(src).size shouldBe 2
}

}
Loading