Merge pull request github#13941 from yoff/python/test-nice-location

Python: fix nice locations for import aliases

Author: RasmusWL

python/ql/lib/analysis/DefinitionTracking.qll

@@ -492,9 +492,14 @@ class NiceLocationExpr extends Expr {
     // for `import xxx` or for `import xxx as yyy`.
     this.(ImportExpr).getLocation().hasLocationInfo(f, bl, bc, el, ec)
     or
-    /* Show y for `y` in `from xxx import y` */
-    exists(string name |
-      name = this.(ImportMember).getName() and
+    // Show y for `y` in `from xxx import y`
+    // and y for `yyy as y` in `from xxx import yyy as y`.
+    exists(string name, Alias alias |
+      // This alias will always exist, as `from xxx import y`
+      // is expanded to `from xxx imprt y as y`.
+      this = alias.getValue() and
+      name = alias.getAsname().(Name).getId()
+    |
       this.(ImportMember).getLocation().hasLocationInfo(f, _, _, el, ec) and
       bl = el and
       bc = ec - name.length() + 1

python/ql/lib/change-notes/2023-08-10-fix-alias-locations.md

@@ -0,0 +1,4 @@
+---
+category: fix
+---
+* Fixed the computation of locations for imports with aliases in jump-to-definition.

python/ql/test/library-tests/locations/imports/import_statements.py

@@ -0,0 +1,4 @@
+from nova.api.openstack.placement import microversion
+from nova.api.openstack.placement.objects import resource_provider as rp_obj
+from nova.api.openstack.placement.policies import allocation_candidate as \
+    policies

python/ql/test/library-tests/locations/imports/imports.expected

@@ -0,0 +1,6 @@
+| import_statements.py | 1 | 6 | 1 | 33 |
+| import_statements.py | 1 | 42 | 1 | 53 |
+| import_statements.py | 2 | 6 | 2 | 41 |
+| import_statements.py | 2 | 71 | 2 | 76 |
+| import_statements.py | 3 | 6 | 3 | 42 |
+| import_statements.py | 4 | 5 | 4 | 12 |

python/ql/test/library-tests/locations/imports/imports.ql

@@ -0,0 +1,6 @@
+import python
+import analysis.DefinitionTracking
+
+from NiceLocationExpr expr, string f, int bl, int bc, int el, int ec
+where expr.hasLocationInfo(f, bl, bc, el, ec)
+select f, bl, bc, el, ec