Release v2.2.37

Changed Windows Terminal telnet console profile from OS X to Windows ref: #3193

.github/workflows/codeql.yml

@@ -0,0 +1,76 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "master" ]
+  schedule:
+    - cron: '27 6 * * 2'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Use only 'java' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

.gitignore

@@ -63,3 +63,4 @@ __pycache__
 
 # Virtualenv
 env
+venv

.whitesource

@@ -2,7 +2,8 @@
   "scanSettings": {
     "configMode": "AUTO",
     "configExternalURL": "",
-    "projectToken" : ""
+    "projectToken" : "",
+    "baseBranches": ["master", "2.2", "3.0"]
   },
   "checkRunSettings": {
     "vulnerableCheckRunConclusionLevel": "failure"

CHANGELOG

@@ -1,5 +1,10 @@
 # Change Log
 
+## 2.2.37 25/01/2023
+
+* Upgrade to PyQt5 v5.15.7
+* Changed Windows Terminal telnet console profile from OS X to windows ref: issue #3193
+
 ## 2.2.36 04/01/2023
 
 * Add Trusted Platform Module (TPM) support for Qemu VMs

MANIFEST.in

@@ -1,4 +1,4 @@
-include README.rst
+include README.md
 include AUTHORS
 include LICENSE
 include MANIFEST.in

README.md

@@ -0,0 +1,62 @@
+GNS3-gui
+========
+
+[![image](https://github.com/GNS3/gns3-gui/workflows/testing/badge.svg)](https://github.com/GNS3/gns3-gui/actions?query=workflow%3Atesting)
+
+[![image](https://img.shields.io/pypi/v/gns3-gui.svg)](https://pypi.python.org/pypi/gns3-gui)
+
+[![image](https://snyk.io/test/github/GNS3/gns3-gui/badge.svg)](https://snyk.io/test/github/GNS3/gns3-gui)
+
+GNS3 GUI repository.
+
+Installation
+------------
+
+Please see <https://docs.gns3.com/>
+
+Software dependencies
+---------------------
+
+PyQt5 which is either part of the Linux distribution or installable from
+PyPi. The other Python dependencies are automatically installed during
+the GNS3 GUI installation and are listed
+[here](https://github.com/GNS3/gns3-gui/blob/master/requirements.txt)
+
+For connecting to nodes using Telnet, a Telnet client is required. On
+Linux that's a terminal emulator like xterm, gnome-terminal, konsole
+plus the telnet program. For connecting to nodes with a GUI, a VNC
+client is required, optionally a SPICE client can be used for Qemu
+nodes.
+
+For using packet captures within GNS3, Wireshark should be installed.
+It's recommended, but if you don't need that functionality you can go
+without it.
+
+Development
+-----------
+
+If you want to update the interface, modify the .ui files using QT
+tools. And:
+
+``` {.bash}
+cd scripts
+python build_pyqt.py
+```
+
+### Debug
+
+If you want to see the full logs in the internal shell you can type:
+
+``` {.bash}
+debug 2
+```
+
+Or start the app with --debug flag.
+
+Due to the fact PyQT intercept you can use a web debugger for inspecting
+stuff: <https://github.com/Kozea/wdb>
+
+Security issues
+---------------
+
+Please contact us at <security@gns3.net>

README.rst

@@ -1,60 +0,0 @@
-GNS3-gui
-========
-
-.. image:: https://github.com/GNS3/gns3-gui/workflows/testing/badge.svg
-    :target: https://github.com/GNS3/gns3-gui/actions?query=workflow%3Atesting
-
-.. image:: https://img.shields.io/pypi/v/gns3-gui.svg
-    :target: https://pypi.python.org/pypi/gns3-gui
-
-.. image:: https://snyk.io/test/github/GNS3/gns3-gui/badge.svg
-    :target: https://snyk.io/test/github/GNS3/gns3-gui
-
-
-GNS3 GUI repository.
-
-Installation
-------------
-
-Please see https://docs.gns3.com/
-
-Software dependencies
----------------------
-
-PyQt5 which is either part of the Linux distribution or installable from PyPi. The other Python dependencies are automatically installed during the GNS3 GUI installation and are listed `here <https://github.com/GNS3/gns3-gui/blob/master/requirements.txt>`_
-
-For connecting to nodes using Telnet, a Telnet client is required. On Linux that's a terminal emulator like xterm, gnome-terminal, konsole plus the telnet program. For connecting to nodes with a GUI, a VNC client is required, optionally a SPICE client can be used for Qemu nodes.
-
-For using packet captures within GNS3, Wireshark should be installed. It's recommended, but if you don't need that functionality you can go without it.
-
-Development
--------------
-
-If you want to update the interface, modify the .ui files using QT tools. And:
-
-.. code:: bash
-
-    cd scripts
-    python build_pyqt.py
-
-Debug
-"""""
-
-If you want to see the full logs in the internal shell you can type:
-
-.. code:: bash
-    
-    debug 2
-
-
-Or start the app with --debug flag.
-
-Due to the fact PyQT intercept you can use a web debugger for inspecting stuff:
-https://github.com/Kozea/wdb
-
-Security issues
-----------------
-
-Please contact us at security@gns3.net
-
-

SECURITY.md

@@ -0,0 +1,5 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+Please use GitHub's report a vulnerability feature. More information can be found in https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability

gns3/crash_report.py

@@ -51,7 +51,7 @@ class CrashReport:
     Report crash to a third party service
     """
 
-    DSN = "https://078a549daea940e0a4b75fcad8399855@o19455.ingest.sentry.io/38506"
+    DSN = "https://433337b5780f4fe8abec8ee5e85c5897@o19455.ingest.sentry.io/38506"
     _instance = None
 
     def __init__(self):

gns3/main.py

@@ -220,10 +220,14 @@ def main():
         if not options.debug:
             try:
                 # hide the console
+                # win32console.AllocConsole()
                 console_window = win32console.GetConsoleWindow()
-                win32gui.ShowWindow(console_window, win32con.SW_HIDE)
+                if console_window:
+                    win32gui.ShowWindow(console_window, win32con.SW_HIDE)
+                else:
+                    log.warning("Could not get the console window")
             except win32console.error as e:
-                print("warning: could not allocate console: {}".format(e))
+                log.warning("Could not allocate console: {}".format(e))
 
     local_config = LocalConfig.instance()
 

gns3/settings.py

@@ -64,6 +64,7 @@ if sys.platform.startswith("win"):
                                              'SecureCRT (personal profile)': r'"{}\AppData\Local\VanDyke Software\SecureCRT\SecureCRT.exe" /T /N "%d" /TELNET %h %p'.format(userprofile),
                                              'TeraTerm Pro': r'"{}\teraterm\ttermpro.exe" /W="%d" /M="ttstart.macro" /T=1 %h %p'.format(program_files_x86),
                                              'Telnet': 'telnet %h %p',
+                                             'Windows Terminal': 'wt.exe -w 1 new-tab --title %d telnet %h %p',
                                              'Xshell 4': r'"{}\NetSarang\Xshell 4\xshell.exe" -url telnet://%h:%p'.format(program_files_x86),
                                              'Xshell 5': r'"{}\NetSarang\Xshell 5\xshell.exe" -url telnet://%h:%p -newtab %d'.format(program_files_x86),
                                              'ZOC 6': r'"{}\ZOC6\zoc.exe" "/TELNET:%h:%p" /TABBED "/TITLE:%d"'.format(program_files_x86)}
@@ -140,7 +141,6 @@ elif sys.platform.startswith("darwin"):
                     r""" -e 'end tell'""",
         'Royal TSX': "open 'rtsx://telnet%3A%2F%2F%h:%p'",
         'SecureCRT': '/Applications/SecureCRT.app/Contents/MacOS/SecureCRT /N "%d" /T /TELNET %h %p',
-        'Windows Terminal': 'wt.exe -w 1 new-tab --title %d telnet %h %p',
         'ZOC 6': '/Applications/zoc6.app/Contents/MacOS/zoc6 "/TELNET:%h:%p" /TABBED "/TITLE:%d"',
         'ZOC 7': '/Applications/zoc7.app/Contents/MacOS/zoc7 "/TELNET:%h:%p" /TABBED "/TITLE:%d"',
         'ZOC 8': '/Applications/zoc8.app/Contents/MacOS/zoc8 "/TELNET:%h:%p" /TABBED "/TITLE:%d"'

gns3/version.py

@@ -23,8 +23,8 @@
 # or negative for a release candidate or beta (after the base version
 # number has been incremented)
 
-__version__ = "2.2.36"
-__version_info__ = (2, 2, 36, 0)
+__version__ = "2.2.37"
+__version_info__ = (2, 2, 37, 0)
 
 if "dev" in __version__:
     try:

mac-requirements.txt

@@ -1,3 +1,3 @@
 -rrequirements.txt
 
-PyQt5==5.15.6
+PyQt5==5.15.7

setup.py

@@ -66,7 +66,7 @@ setup(
     author="Jeremy Grossmann",
     author_email="package-maintainer@gns3.net",
     description="GNS3 graphical interface for the GNS3 server.",
-    long_description=open("README.rst", "r").read(),
+    long_description=open("README.md", "r").read(),
     install_requires=open("requirements.txt", "r").read().splitlines(),
     entry_points={
         "gui_scripts": [

tests/test_http_client.py

@@ -311,7 +311,7 @@ def test_callbackConnect_major_version_invalid(http_client):
 
 def test_callbackConnect_minor_version_invalid(http_client):
 
-    new_version = "{}.{}.{}".format(__version_info__[0], __version_info__[1], __version_info__[2] + 1)
+    new_version = "{}.{}.{}".format(__version_info__[0], __version_info__[1] + 1, 0)
     params = {
         "local": True,
         "version": new_version
@@ -319,14 +319,23 @@ def test_callbackConnect_minor_version_invalid(http_client):
     mock = unittest.mock.MagicMock()
 
     http_client._query_waiting_connections.append((None, mock))
-    # Stable release
-    if __version_info__[3] == 0:
-        http_client._callbackConnect(params)
-        assert http_client._connected is False
-        mock.assert_called_with({"message": "Client version {} is not the same as server (controller) version {}".format(__version__, new_version)}, error=True, server=None)
-    else:
-        http_client._callbackConnect(params)
-        assert http_client._connected is True
+    http_client._callbackConnect(params)
+    assert http_client._connected is False
+    mock.assert_called_with({"message": "Client version {} is not the same as server (controller) version {}".format(__version__, new_version)}, error=True, server=None)
+
+
+def test_callbackConnect_patch_version(http_client):
+
+    new_version = "{}.{}.{}.{}".format(__version_info__[0], __version_info__[1], __version_info__[2], 42)
+    params = {
+        "local": True,
+        "version": new_version
+    }
+    mock = unittest.mock.MagicMock()
+
+    http_client._query_waiting_connections.append((None, mock))
+    http_client._callbackConnect(params)
+    assert http_client._connected is True
 
 
 def test_callbackConnect_non_gns3_server(http_client):