Skip to content

Commit

Permalink
[c#] fix member assignment LHS .code property (#5194)
Browse files Browse the repository at this point in the history
  • Loading branch information
@xavierpinho
xavierpinho authored Dec 31, 2024
1 parent 793dd44 commit 73e73f1
Show file tree
Hide file tree
Showing 2 changed files with 202 additions and 55 deletions.
2 changes: 1 addition & 1 deletion ...rpsrc2cpg/src/main/scala/io/joern/csharpsrc2cpg/astcreation/AstForPrimitivesCreator.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ trait AstForPrimitivesCreator(implicit withSchemaValidation: ValidationMode) { t
case Some(field) if field.node.node != DotNetJsonAst.VariableDeclarator =>
astForFieldIdentifier(typeFullName, identifierName, field)
case Some(field) =>
Ast(identifierNode(ident, identifierName, ident.code, field.typeFullName))
Ast(identifierNode(ident, identifierName, identifierName, field.typeFullName))
case None =>
// Check for static type reference
scope.tryResolveTypeReference(identifierName) match {
Expand Down
255 changes: 201 additions & 54 deletions ...ntends/csharpsrc2cpg/src/test/scala/io/joern/csharpsrc2cpg/querying/ast/MemberTests.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,73 +8,220 @@ import io.shiftleft.semanticcpg.language.*

class MemberTests extends CSharpCode2CpgFixture {

"a basic class declaration" should {
val cpg = code(
"""public class Car
"class with static and non-static members" should {
val cpg = code("""
|class Car
|{
| string color; // field
| static int maxSpeed = 200; // field
| public void fullThrottle() // method
| {
| Console.WriteLine("The car is going as fast as it can!");
| }
|}
|""".stripMargin,
"Car.cs"
)
| string color;
| static int maxSpeed = 200;
|}""".stripMargin)

"have the non-static member correctly set" in {
inside(cpg.member.nameExact("color").l) {
case color :: Nil =>
color.typeFullName shouldBe "System.String"
color.code shouldBe "string color"
color.modifier.modifierType.l shouldBe List(ModifierTypes.INTERNAL)
case xs =>
fail(s"Expected single `color` member, but got $xs")
}
}

"have the static member correctly set`" in {
inside(cpg.member.nameExact("maxSpeed").l) {
case maxSpeed :: Nil =>
maxSpeed.typeFullName shouldBe "System.Int32"
maxSpeed.code shouldBe "int maxSpeed = 200"
maxSpeed.modifier.modifierType.toSet shouldBe Set(ModifierTypes.INTERNAL, ModifierTypes.STATIC)
case xs =>
fail(s"Expected single `maxSpeed` member, but got $xs")
}
}
}

"generate members for fields" in {
val x = cpg.typeDecl.nameExact("Car").head
"class with initialized static member" should {
val cpg = code("""
|class Car
|{
| static int nonInitMaxSpeed = 200;
|}
|""".stripMargin)

val color = x.member.nameExact("color").head
color.typeFullName shouldBe "System.String"
color.code shouldBe "string color"
color.modifier.modifierType.l shouldBe ModifierTypes.INTERNAL :: Nil
"have the static member correctly set" in {
inside(cpg.member.nameExact("nonInitMaxSpeed").l) {
case nonInitMaxSpeed :: Nil =>
nonInitMaxSpeed.typeFullName shouldBe "System.Int32"
nonInitMaxSpeed.code shouldBe "int nonInitMaxSpeed = 200"
nonInitMaxSpeed.modifier.modifierType.l shouldBe List(ModifierTypes.INTERNAL, ModifierTypes.STATIC)
case xs =>
fail(s"Expected single `nonInitMaxSpeed` member, but got $xs")
}
}

val maxSpeed = x.member.nameExact("maxSpeed").head
maxSpeed.typeFullName shouldBe "System.Int32"
maxSpeed.code shouldBe "int maxSpeed = 200"
maxSpeed.modifier.modifierType.l shouldBe ModifierTypes.INTERNAL :: ModifierTypes.STATIC :: Nil
// TODO: Not supported yet.
"have a static constructor" ignore {
inside(cpg.typeDecl.nameExact("Car").method.nameExact(Defines.StaticInitMethodName).l) {
case cctor :: Nil =>
cctor.fullName shouldBe s"Car.${Defines.StaticInitMethodName}:void()"
cctor.modifier.modifierType.toSet shouldBe Set(ModifierTypes.STATIC, ModifierTypes.CONSTRUCTOR)
cctor.methodReturn.typeFullName shouldBe "void"
case xs =>
fail(s"Expected single static constructor, but got $xs")
}
}

// TODO: Not supported yet.
"have the static member initialization inside the static constructor" ignore {
inside(cpg.method.fullNameExact(s"Car.${Defines.StaticInitMethodName}:void()").body.assignment.l) {
case assignment :: Nil =>
assignment.target.code shouldBe "Car.nonInitMaxSpeed"
assignment.source.code shouldBe "200"
case xs =>
fail(s"Expected single assignment inside the static constructor, but got $xs")
}
}
}

"a basic class declaration with a static constructor" should {
val cpg = code(
"""public class Car
"class with initialized member" should {
val cpg = code("""
|class Car
|{
| string color; // field
| static int maxSpeed = 200; // field
| static int nonInitMaxSpeed; // field
|
| public void fullThrottle() // method
| {
| Console.WriteLine("The car is going as fast as it can!");
| }
|
| static Car() { // static constructor
| nonInitMaxSpeed = 2000;
| }
|
| string color = "red";
|}
|""".stripMargin,
"Car.cs"
)
|""".stripMargin)

"generate one static constructor" in {
"have the member correctly set" in {
inside(cpg.member.nameExact("color").l) {
case color :: Nil =>
color.typeFullName shouldBe "System.String"
color.code shouldBe "string color = \"red\""
color.modifier.modifierType.l shouldBe List(ModifierTypes.INTERNAL)
case xs =>
fail(s"Expected single `color` member, but got $xs")
}
}

// TODO: Not supported yet.
"have a constructor" ignore {
inside(cpg.typeDecl.nameExact("Car").method.nameExact(Defines.ConstructorMethodName).l) {
case ctor :: Nil =>
ctor.fullName shouldBe s"Car.${Defines.ConstructorMethodName}:void()"
ctor.modifier.modifierType.toSet shouldBe Set(ModifierTypes.INTERNAL, ModifierTypes.CONSTRUCTOR)
ctor.methodReturn.typeFullName shouldBe "void"
case xs =>
fail(s"Expected single constructor, but got $xs")
}
}

// TODO: Not supported yet.
"have the member initialization inside the constructor" ignore {
inside(cpg.method.fullNameExact(s"Car.${Defines.ConstructorMethodName}:void()").body.assignment.l) {
case assignment :: Nil =>
assignment.target.code shouldBe "Car.nonInitMaxSpeed"
assignment.source.code shouldBe "200"
case xs =>
fail(s"Expected single assignment inside the constructor, but got $xs")
}
}
}

"class with static constructor" should {
val cpg = code("""
|class Car
|{
| static Car()
| {
| }
|}""".stripMargin)
"have a static constructor correctly set" in {
inside(cpg.typeDecl.nameExact("Car").method.nameExact(Defines.StaticInitMethodName).l) {
case m :: Nil =>
m.fullName shouldBe s"Car.${Defines.StaticInitMethodName}:void()"
m.modifier.modifierType.l shouldBe ModifierTypes.STATIC :: ModifierTypes.CONSTRUCTOR :: Nil
m.methodReturn.typeFullName shouldBe "void"
case cctor :: Nil =>
cctor.fullName shouldBe s"Car.${Defines.StaticInitMethodName}:void()"
cctor.modifier.modifierType.toSet shouldBe Set(ModifierTypes.STATIC, ModifierTypes.CONSTRUCTOR)
cctor.methodReturn.typeFullName shouldBe "void"
case xs =>
fail(s"Expected single static constructor, but got $xs")
}
}
}

inside(m.assignment.l) {
case maxSpeed :: nonInitMaxSpeed :: Nil =>
maxSpeed.code shouldBe "maxSpeed = 200"
nonInitMaxSpeed.code shouldBe "nonInitMaxSpeed = 2000"
case _ => fail("Exactly 2 assignments expected")
}
case _ => fail("`Car` has no static initializer method")
"class with static constructor and initialized static member" should {
val cpg = code("""
|class Car
|{
| static int maxSpeed = 200;
| static Car()
| {
| }
|}""".stripMargin)
"have static member initialization inside static constructor" in {
inside(cpg.typeDecl.nameExact("Car").method.nameExact(Defines.StaticInitMethodName).body.assignment.l) {
case assignment :: Nil =>
assignment.code shouldBe "maxSpeed = 200"
assignment.source.code shouldBe "200"
// TODO: target is currently an identifier. Should it be `Car.maxSpeed` instead?
assignment.target.code shouldBe "maxSpeed"
case xs =>
fail(s"Expected single assignment inside static constructor, but got $xs")
}
}
}

"class with static constructor initializing a member, plus an initialized static member" should {
val cpg = code("""
|class Car
|{
| static int maxSpeed = 200;
| static int nonInitMaxSpeed;
| static Car()
| {
| nonInitMaxSpeed = 300;
| }
|}
|""".stripMargin)
"have static constructor with two assignments for initializing the members" in {
inside(cpg.typeDecl.nameExact("Car").method.nameExact(Defines.StaticInitMethodName).assignment.sortBy(_.code).l) {
case maxSpeedAssignment :: nonInitMaxSpeedAssignment :: Nil =>
maxSpeedAssignment.code shouldBe "maxSpeed = 200"
nonInitMaxSpeedAssignment.code shouldBe "nonInitMaxSpeed = 300"

// TODO: They should have the same representation
maxSpeedAssignment.target.code shouldBe "maxSpeed"
nonInitMaxSpeedAssignment.target.code shouldBe "Car.nonInitMaxSpeed"
case xs =>
fail(s"Expected two assignments, but got $xs")
}
}
}

"class with initialized member and default constructor" should {
val cpg = code("""
|class Car
|{
| string color = "red";
| Car()
| {
| }
|}""".stripMargin)
"have a constructor" in {
inside(cpg.typeDecl.nameExact("Car").method.nameExact(Defines.ConstructorMethodName).l) {
case ctor :: Nil =>
ctor.fullName shouldBe s"Car.${Defines.ConstructorMethodName}:void()"
ctor.modifier.modifierType.toSet shouldBe Set(ModifierTypes.CONSTRUCTOR)
ctor.methodReturn.typeFullName shouldBe "void"
case xs =>
fail(s"Expected single constructor, but got $xs")
}
}

"have the member initialization inside the constructor" in {
inside(cpg.method.fullNameExact(s"Car.${Defines.ConstructorMethodName}:void()").body.assignment.l) {
case assignment :: Nil =>
// TODO: test LHS: shouldn't it resemble `this.color`?
assignment.target.code shouldBe "color"
assignment.source.code shouldBe "\"red\""
case xs =>
fail(s"Expected single assignment inside the constructor, but got $xs")
}
}
}
Expand Down

0 comments on commit 73e73f1

Please sign in to comment.