Merge branch 'main' into powershell-cfg-for-if-and-match

MathiasVP · MathiasVP · commit dbbb9b32f876 · 2024-09-09T18:09:19.000+01:00
diff --git a/powershell/downgrades/d8eb95bd91979583b569cdd50de46c59210f2aa9/old.dbscheme b/powershell/downgrades/d8eb95bd91979583b569cdd50de46c59210f2aa9/old.dbscheme
diff --git a/powershell/downgrades/d8eb95bd91979583b569cdd50de46c59210f2aa9/semmlecode.powershell.dbscheme b/powershell/downgrades/d8eb95bd91979583b569cdd50de46c59210f2aa9/semmlecode.powershell.dbscheme
diff --git a/powershell/downgrades/d8eb95bd91979583b569cdd50de46c59210f2aa9/upgrade.properties b/powershell/downgrades/d8eb95bd91979583b569cdd50de46c59210f2aa9/upgrade.properties
@@ -0,0 +1,2 @@
+description: Making column types more specific
+compatibility: full
diff --git a/powershell/ql/consistency-queries/CfgConsistency.ql b/powershell/ql/consistency-queries/CfgConsistency.ql
@@ -0,0 +1 @@
+import semmle.code.powershell.controlflow.internal.ControlFlowGraphImpl::Consistency
diff --git a/powershell/ql/consistency-queries/qlpack.yml b/powershell/ql/consistency-queries/qlpack.yml
@@ -0,0 +1,9 @@
+name: codeql/powershell-consistency-queries
+groups: 
+  - powershell
+  - microsoft-all
+  - test
+  - consistency-queries
+dependencies:
+  microsoft-sdl/powershell-all: ${workspace}
+warnOnImplicitThis: true
diff --git a/powershell/ql/lib/qlpack.yml b/powershell/ql/lib/qlpack.yml
@@ -6,6 +6,7 @@ groups:
 dbscheme: semmlecode.powershell.dbscheme
 extractor: powershell
 library: true
+upgrades: upgrades
 dependencies:
   codeql/controlflow: ${workspace}
 warnOnImplicitThis: true
diff --git a/powershell/ql/lib/semmle/code/powershell/Ast.qll b/powershell/ql/lib/semmle/code/powershell/Ast.qll
@@ -3,7 +3,7 @@ import powershell
 class Ast extends @ast {
   string toString() { none() }
 
-  Ast getParent() { parent(this, result) } // TODO: Flip parent and child in relation in the extractor
+  Ast getParent() { parent(this, result) }
 
   Location getLocation() { none() }
 }
diff --git a/powershell/ql/lib/semmle/code/powershell/CatchClause.qll b/powershell/ql/lib/semmle/code/powershell/CatchClause.qll
@@ -5,15 +5,15 @@ class CatchClause extends @catch_clause, Ast {
 
   override string toString() { result = "catch {...}" }
 
-  StmtBlock getBody() { catch_clause(this, result, _) } // TODO: Change @ast to @stmt_block in dbscheme
+  StmtBlock getBody() { catch_clause(this, result, _) }
 
-  TypeConstraint getCatchType(int i) { catch_clause_catch_type(this, i, result) } // TODO: Change @ast to @type_constraint in dbscheme
+  TypeConstraint getCatchType(int i) { catch_clause_catch_type(this, i, result) }
 
-  TypeConstraint getACatchType() { result = this.getCatchType(_) }
+  int getNumberOfCatchTypes() { result = count(this.getACatchType()) }
 
-  int getNumberOfCatchTypes() { result = count(this.getCatchType(_)) }
+  TypeConstraint getACatchType() { result = this.getCatchType(_) }
 
-  predicate isCatchAll() { catch_clause(this, _, true) } // TODO: Should be equivalent to not exists(this.getACatchType())
+  predicate isCatchAll() { not exists(this.getACatchType()) }
 
   TryStmt getTryStmt() { result.getACatchClause() = this }
 
diff --git a/powershell/ql/lib/semmle/code/powershell/Configuration.qll b/powershell/ql/lib/semmle/code/powershell/Configuration.qll
@@ -5,9 +5,9 @@ class Configuration extends @configuration_definition, Stmt {
 
   override string toString() { result = "Configuration" }
 
-  Expr getName() { configuration_definition(this, _, _, result) } // TODO: Change @ast to @expression in dbscheme
+  Expr getName() { configuration_definition(this, _, _, result) }
 
-  ScriptBlockExpr getBody() { configuration_definition(this, result, _, _) } // TODO: Change @ast to @script_block in dbscheme
+  ScriptBlockExpr getBody() { configuration_definition(this, result, _, _) }
 
   predicate isMeta() { configuration_definition(this, _, 1, _) }
 
diff --git a/powershell/ql/lib/semmle/code/powershell/DataStmt.qll b/powershell/ql/lib/semmle/code/powershell/DataStmt.qll
@@ -11,5 +11,5 @@ class DataStmt extends @data_statement, Stmt {
 
   Expr getACmdAllowed() { result = this.getCmdAllowed(_) }
 
-  StmtBlock getBody() { data_statement(this, result) } // TODO: Change @ast to @stmt_block in dbscheme
+  StmtBlock getBody() { data_statement(this, result) }
 }
diff --git a/powershell/ql/lib/semmle/code/powershell/DoUntilStmt.qll b/powershell/ql/lib/semmle/code/powershell/DoUntilStmt.qll
@@ -5,7 +5,7 @@ class DoUntilStmt extends @do_until_statement, LoopStmt {
 
   override string toString() { result = "DoUntil" }
 
-  PipelineBase getCondition() { do_until_statement_condition(this, result) } // TODO: Change @ast to @pipeline_base in dbscheme
+  PipelineBase getCondition() { do_until_statement_condition(this, result) }
 
-  final override StmtBlock getBody() { do_until_statement(this, result) } // TODO: Change @ast to @stmt_block in dbscheme
+  final override StmtBlock getBody() { do_until_statement(this, result) }
 }
diff --git a/powershell/ql/lib/semmle/code/powershell/DoWhileStmt.qll b/powershell/ql/lib/semmle/code/powershell/DoWhileStmt.qll
@@ -5,7 +5,7 @@ class DoWhileStmt extends @do_while_statement, LoopStmt {
 
   override string toString() { result = "DoWhile" }
 
-  PipelineBase getCondition() { do_while_statement_condition(this, result) } // TODO: Change @ast to @pipeline_base in dbscheme
+  PipelineBase getCondition() { do_while_statement_condition(this, result) }
 
-  final override StmtBlock getBody() { do_while_statement(this, result) } // TODO: Change @ast to @stmt_block in dbscheme
+  final override StmtBlock getBody() { do_while_statement(this, result) }
 }
diff --git a/powershell/ql/lib/semmle/code/powershell/ExitStmt.qll b/powershell/ql/lib/semmle/code/powershell/ExitStmt.qll
@@ -6,7 +6,7 @@ class ExitStmt extends @exit_statement, Stmt {
   override string toString() { if this.hasPipeline() then result = "exit ..." else result = "exit" }
 
   /** ..., if any. */
-  PipelineBase getPipeline() { exit_statement_pipeline(this, result) } // TODO: Change @ast to @pipeline_base in dbscheme
+  PipelineBase getPipeline() { exit_statement_pipeline(this, result) }
 
   predicate hasPipeline() { exists(this.getPipeline()) }
 }
diff --git a/powershell/ql/lib/semmle/code/powershell/ForEachStmt.qll b/powershell/ql/lib/semmle/code/powershell/ForEachStmt.qll
@@ -5,11 +5,11 @@ class ForEachStmt extends @foreach_statement, LoopStmt {
 
   override string toString() { result = "forach(... in ...)" }
 
-  final override StmtBlock getBody() { foreach_statement(this, _, _, result, _) } // TODO: Change @ast to @stmt_block in dbscheme
+  final override StmtBlock getBody() { foreach_statement(this, _, _, result, _) }
 
-  VarAccess getVariable() { foreach_statement(this, result, _, _, _) } // TODO: Change @ast to @variable_expression in dbscheme
+  VarAccess getVariable() { foreach_statement(this, result, _, _, _) }
 
-  PipelineBase getIterableExpr() { foreach_statement(this, _, result, _, _) } // TODO: Change @ast to @pipeline_base in dbscheme
+  PipelineBase getIterableExpr() { foreach_statement(this, _, result, _, _) }
 
   predicate isParallel() { foreach_statement(this, _, _, _, 1) }
 }
diff --git a/powershell/ql/lib/semmle/code/powershell/ForStmt.qll b/powershell/ql/lib/semmle/code/powershell/ForStmt.qll
@@ -5,11 +5,11 @@ class ForStmt extends @for_statement, LoopStmt {
 
   override string toString() { result = "for(...;...;...)" }
 
-  PipelineBase getInitializer() { for_statement_initializer(this, result) } // TODO: Change @ast to @pipeline_base in dbscheme
+  PipelineBase getInitializer() { for_statement_initializer(this, result) }
 
-  PipelineBase getCondition() { for_statement_condition(this, result) } // TODO: Change @ast to @pipeline_base in dbscheme
+  PipelineBase getCondition() { for_statement_condition(this, result) }
 
-  PipelineBase getIterator() { for_statement_iterator(this, result) } // TODO: Change @ast to @pipeline_base in dbscheme
+  PipelineBase getIterator() { for_statement_iterator(this, result) }
 
-  final override StmtBlock getBody() { for_statement(this, result) } // TODO: Change @ast to @stmt_block in dbscheme
+  final override StmtBlock getBody() { for_statement(this, result) }
 }
diff --git a/powershell/ql/lib/semmle/code/powershell/GotoStmt.qll b/powershell/ql/lib/semmle/code/powershell/GotoStmt.qll
@@ -1,8 +1,8 @@
 import powershell
 
 /** A `break` or `continue` statement. */
-class GotoStmt extends @labelled_statement, Stmt { // TODO: Rename @labelled_statement to @goto_statement
+class GotoStmt extends @labelled_statement, Stmt {
 
   /** ..., if any. */
-  Expr getLabel() { statement_label(this, result) } // TODO: Replace @ast with @expression
+  Expr getLabel() { statement_label(this, result) }
 }
diff --git a/powershell/ql/lib/semmle/code/powershell/IfStmt.qll b/powershell/ql/lib/semmle/code/powershell/IfStmt.qll
@@ -7,18 +7,18 @@ class IfStmt extends @if_statement, Stmt {
     if this.hasElse() then result = "if (...) {...} else {...}" else result = "if (...) {...}"
   }
 
-  PipelineBase getCondition(int i) { if_statement_clause(this, i, result, _) } // TODO: Change @ast to @pipeline_base in dbscheme
+  PipelineBase getCondition(int i) { if_statement_clause(this, i, result, _) }
 
   PipelineBase getACondition() { result = this.getCondition(_) }
 
-  StmtBlock getThen(int i) { if_statement_clause(this, i, _, result) } // TODO: Change @ast to @statement_block in dbscheme
+  StmtBlock getThen(int i) { if_statement_clause(this, i, _, result) }
 
   int getNumberOfConditions() { result = count(this.getACondition()) }
 
   StmtBlock getAThen() { result = this.getThen(_) }
 
   /** ..., if any. */
-  StmtBlock getElse() { if_statement_else(this, result) } // TODO: Change @ast to @stmt_block in dbscheme
+  StmtBlock getElse() { if_statement_else(this, result) }
 
   predicate hasElse() { exists(this.getElse()) }
 }
diff --git a/powershell/ql/lib/semmle/code/powershell/ReturnStmt.qll b/powershell/ql/lib/semmle/code/powershell/ReturnStmt.qll
@@ -7,7 +7,7 @@ class ReturnStmt extends @return_statement, Stmt {
     if this.hasPipeline() then result = "return ..." else result = "return"
   }
 
-  PipelineBase getPipeline() { return_statement_pipeline(this, result) } // TODO: Change @ast to @pipeline_base in dbscheme
+  PipelineBase getPipeline() { return_statement_pipeline(this, result) }
 
   predicate hasPipeline() { exists(this.getPipeline()) }
 }
diff --git a/powershell/ql/lib/semmle/code/powershell/TryStmt.qll b/powershell/ql/lib/semmle/code/powershell/TryStmt.qll
@@ -12,7 +12,7 @@ class TryStmt extends @try_statement, Stmt {
   /** ..., if any. */
   StmtBlock getFinally() { try_statement_finally(this, result) }
 
-  StmtBlock getBody() { try_statement(this, result) } // TODO: Change @ast to @stmt_block in dbscheme
+  StmtBlock getBody() { try_statement(this, result) }
 
   predicate hasFinally() { exists(this.getFinally()) }
 }
diff --git a/powershell/ql/lib/semmle/code/powershell/WhileStmt.qll b/powershell/ql/lib/semmle/code/powershell/WhileStmt.qll
@@ -5,7 +5,7 @@ class WhileStmt extends @while_statement, LoopStmt {
 
   override string toString() { result = "while(...) {...}" }
 
-  PipelineBase getCondition() { while_statement_condition(this, result) } // TODO: Change @ast to @pipeline_base in dbscheme
+  PipelineBase getCondition() { while_statement_condition(this, result) }
 
-  final override StmtBlock getBody() { while_statement(this, result) } // TODO: Change @ast to @stmt_block in dbscheme
+  final override StmtBlock getBody() { while_statement(this, result) }
 }
diff --git a/powershell/ql/lib/semmle/code/powershell/controlflow/internal/ControlFlowGraphImpl.qll b/powershell/ql/lib/semmle/code/powershell/controlflow/internal/ControlFlowGraphImpl.qll
@@ -543,6 +543,8 @@ module Trees {
     override AstNode getChildNode(int i) { result = super.getElement(i) }
   }
 
+  class TypeConstraintTree extends LeafTree instanceof TypeConstraint { }
+
   class CatchClauseTree extends PreOrderTree instanceof CatchClause {
     final override predicate propagatesAbnormal(Ast child) { none() }
 
diff --git a/powershell/ql/lib/semmlecode.powershell.dbscheme b/powershell/ql/lib/semmlecode.powershell.dbscheme
diff --git a/powershell/ql/lib/upgrades/40bf985f18b7a9affb0c97d342fa2d43c629b905/old.dbscheme b/powershell/ql/lib/upgrades/40bf985f18b7a9affb0c97d342fa2d43c629b905/old.dbscheme
diff --git a/powershell/ql/lib/upgrades/40bf985f18b7a9affb0c97d342fa2d43c629b905/semmlecode.powershell.dbscheme b/powershell/ql/lib/upgrades/40bf985f18b7a9affb0c97d342fa2d43c629b905/semmlecode.powershell.dbscheme
diff --git a/powershell/ql/lib/upgrades/40bf985f18b7a9affb0c97d342fa2d43c629b905/upgrade.properties b/powershell/ql/lib/upgrades/40bf985f18b7a9affb0c97d342fa2d43c629b905/upgrade.properties

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+description: Making column types more specific`
	`2`	`+compatibility: full`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+import semmle.code.powershell.controlflow.internal.ControlFlowGraphImpl::Consistency`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ import powershell`
`3`	`3`	`class Ast extends @ast {`
`4`	`4`	`string toString() { none() }`
`5`	`5`
`6`		`- Ast getParent() { parent(this, result) } // TODO: Flip parent and child in relation in the extractor`
	`6`	`+ Ast getParent() { parent(this, result) }`
`7`	`7`
`8`	`8`	`Location getLocation() { none() }`
`9`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,5 +11,5 @@ class DataStmt extends @data_statement, Stmt {`
`11`	`11`
`12`	`12`	`Expr getACmdAllowed() { result = this.getCmdAllowed(_) }`
`13`	`13`
`14`		`- StmtBlock getBody() { data_statement(this, result) } // TODO: Change @ast to @stmt_block in dbscheme`
	`14`	`+ StmtBlock getBody() { data_statement(this, result) }`
`15`	`15`	`}`