Ignore the extension's Python files when debugging. (#5103)

(for #3201)

Author: ericsnowcurrently

.github/test_plan.md

@@ -297,6 +297,8 @@ class FailingTests(unittest.TestCase):
     - [ ] `Run Test` works
     - [ ] `Debug Test` works
     - [ ] Module/suite setup methods are also run (run the `test_setup` method to verify)
+- [ ] while debugging tests, an uncaught exception in a test does not
+      cause ptvsd to raise SystemExit
 
 #### [`pytest`](https://code.visualstudio.com/docs/python/unit-testing#_pytest-configuration-settings)
 ```python

news/2 Fixes/3201.md

@@ -0,0 +1 @@
+Ignore the extension's Python files when debugging.

pythonFiles/ptvsd_launcher.py

@@ -19,13 +19,11 @@
         sys.path.insert(0, ptvs_lib_path)
     try:
         import ptvsd
-        import ptvsd.debugger as vspd
         from ptvsd.__main__ import main
         ptvsd_loaded = True
     except ImportError:
         ptvsd_loaded = False
         raise
-    vspd.DONT_DEBUG.append(os.path.normcase(__file__))
 except:
     traceback.print_exc()
     print('''

pythonFiles/testlauncher.py

@@ -20,8 +20,6 @@ def exclude_current_file_from_debugger():
     # Load the debugger package
     try:
         import ptvsd
-        import ptvsd.debugger as vspd
-        vspd.DONT_DEBUG.append(os.path.normcase(__file__))
     except:
         traceback.print_exc()
         print('''

pythonFiles/visualstudio_py_testlauncher.py

@@ -222,7 +222,7 @@ def main():
     (opts, _) = parser.parse_args()
 
     if opts.debug:
-        from ptvsd.visualstudio_py_debugger import DONT_DEBUG, DEBUG_ENTRYPOINTS, get_code
+        from ptvsd.visualstudio_py_debugger import DEBUG_ENTRYPOINTS, get_code
 
     sys.path[0] = os.getcwd()
     if opts.result_port:
@@ -238,7 +238,7 @@ def main():
         sys.stderr = _TestOutput(sys.stderr, is_stdout = False)
 
     if opts.debug:
-        DONT_DEBUG.append(os.path.normcase(__file__))
+        # TODO: Stop using this internal API? (See #3201.)
         DEBUG_ENTRYPOINTS.add(get_code(main))
 
         pass

src/client/unittests/common/debugLauncher.ts

@@ -72,6 +72,13 @@ export class DebugLauncher implements ITestDebugLauncher {
                 request: 'test'
             };
         }
+        if (!debugConfig.rules) {
+            debugConfig.rules = [];
+        }
+        debugConfig.rules.push({
+            path: path.join(EXTENSION_ROOT_DIR, 'pythonFiles'),
+            include: false
+        });
         this.applyDefaults(debugConfig!, workspaceFolder, configSettings);
 
         return this.convertConfigToArgs(debugConfig!, workspaceFolder, options);

src/test/providers/foldingProvider.test.ts

@@ -14,9 +14,12 @@ suite('Provider - Folding Provider', () => {
     const docStringFileAndExpectedFoldingRanges: FileFoldingRanges[] = [
         {
             file: path.join(pythonFilesPath, 'attach_server.py'), ranges: [
-                new FoldingRange(0, 14), new FoldingRange(44, 73, FoldingRangeKind.Comment),
-                new FoldingRange(95, 143), new FoldingRange(149, 150, FoldingRangeKind.Comment),
-                new FoldingRange(305, 313), new FoldingRange(320, 322)
+                new FoldingRange(0, 14),
+                new FoldingRange(44, 73, FoldingRangeKind.Comment),
+                new FoldingRange(98, 146),
+                new FoldingRange(152, 153, FoldingRangeKind.Comment),
+                new FoldingRange(312, 320),
+                new FoldingRange(327, 329)
             ]
         },
         {

src/test/pythonFiles/folding/attach_server.py

@@ -83,9 +83,12 @@
 ATCH = to_bytes('ATCH')
 REPL = to_bytes('REPL')
 
+PY_ROOT = os.path.normcase(__file__)
+while os.path.basename(PY_ROOT) != 'pythonFiles':
+    PY_ROOT = os.path.dirname(PY_ROOT)
+
 _attach_enabled = False
 _attached = threading.Event()
-vspd.DONT_DEBUG.append(os.path.normcase(__file__))
 
 
 class AttachAlreadyEnabledError(Exception):
@@ -238,6 +241,10 @@ def server_thread_func():
 
                 elif response == ATCH:
                     debug_options = vspd.parse_debug_options(read_string(client))
+                    debug_options.setdefault('rules', []).append({
+                        'path': PY_ROOT,
+                        'include': False,
+                        })
                     if redirect_output:
                         debug_options.add('RedirectOutput')
 

src/test/pythonFiles/folding/noComments.py

@@ -35,9 +35,12 @@
 ATCH = to_bytes('ATCH')
 REPL = to_bytes('REPL')
 
+PY_ROOT = os.path.normcase(__file__)
+while os.path.basename(PY_ROOT) != 'pythonFiles':
+    PY_ROOT = os.path.dirname(PY_ROOT)
+
 _attach_enabled = False
 _attached = threading.Event()
-vspd.DONT_DEBUG.append(os.path.normcase(__file__))
 
 
 class AttachAlreadyEnabledError(Exception):
@@ -187,6 +190,10 @@ def server_thread_func():
 
                 elif response == ATCH:
                     debug_options = vspd.parse_debug_options(read_string(client))
+                    debug_options.setdefault('rules', []).append({
+                        'path': PY_ROOT,
+                        'include': False,
+                        })
                     if redirect_output:
                         debug_options.add('RedirectOutput')
 

src/test/pythonFiles/folding/noDocStrings.py

@@ -83,9 +83,12 @@
 ATCH = to_bytes('ATCH')
 REPL = to_bytes('REPL')
 
+PY_ROOT = os.path.normcase(__file__)
+while os.path.basename(PY_ROOT) != 'pythonFiles':
+    PY_ROOT = os.path.dirname(PY_ROOT)
+
 _attach_enabled = False
 _attached = threading.Event()
-vspd.DONT_DEBUG.append(os.path.normcase(__file__))
 
 
 class AttachAlreadyEnabledError(Exception):
@@ -187,6 +190,10 @@ def server_thread_func():
 
                 elif response == ATCH:
                     debug_options = vspd.parse_debug_options(read_string(client))
+                    debug_options.setdefault('rules', []).append({
+                        'path': PY_ROOT,
+                        'include': False,
+                        })
                     if redirect_output:
                         debug_options.add('RedirectOutput')