Merge pull request #8 from faucetsdn/os-ken-2.9.0

Import os-ken 2.9.0 source.

.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+---
+default_language_version:
+  # force all unspecified python hooks to run python3
+  python: python3
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: mixed-line-ending
+        args: ['--fix', 'lf']
+        exclude: '.*\.(svg)$'
+      - id: check-byte-order-marker
+      - id: check-executables-have-shebangs
+      - id: check-merge-conflict
+      - id: debug-statements
+      - id: check-yaml
+  - repo: https://github.com/lucas-c/pre-commit-hooks
+    rev: v1.5.4
+    hooks:
+      - id: remove-tabs
+        exclude: '.*\.(svg)$'
+  - repo: local
+    hooks:
+      - id: flake8
+        name: flake8
+        additional_dependencies:
+          - hacking>=3.2.0,<3.3.0
+        language: python
+        entry: flake8
+        files: '^.*\.py$'
+        exclude: '^(doc|releasenotes|tools)/.*$'

doc/Makefile

@@ -17,116 +17,116 @@ ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) sou
 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
 
 help:
-	@echo "Please use \`make <target>' where <target> is one of"
-	@echo "  html       to make standalone HTML files"
-	@echo "  dirhtml    to make HTML files named index.html in directories"
-	@echo "  singlehtml to make a single large HTML file"
-	@echo "  pickle     to make pickle files"
-	@echo "  json       to make JSON files"
-	@echo "  htmlhelp   to make HTML files and a HTML help project"
-	@echo "  qthelp     to make HTML files and a qthelp project"
-	@echo "  devhelp    to make HTML files and a Devhelp project"
-	@echo "  epub       to make an epub"
-	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
-	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
-	@echo "  text       to make text files"
-	@echo "  man        to make manual pages"
-	@echo "  changes    to make an overview of all changed/added/deprecated items"
-	@echo "  linkcheck  to check all external links for integrity"
-	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+    @echo "Please use \`make <target>' where <target> is one of"
+    @echo "  html       to make standalone HTML files"
+    @echo "  dirhtml    to make HTML files named index.html in directories"
+    @echo "  singlehtml to make a single large HTML file"
+    @echo "  pickle     to make pickle files"
+    @echo "  json       to make JSON files"
+    @echo "  htmlhelp   to make HTML files and a HTML help project"
+    @echo "  qthelp     to make HTML files and a qthelp project"
+    @echo "  devhelp    to make HTML files and a Devhelp project"
+    @echo "  epub       to make an epub"
+    @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+    @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+    @echo "  text       to make text files"
+    @echo "  man        to make manual pages"
+    @echo "  changes    to make an overview of all changed/added/deprecated items"
+    @echo "  linkcheck  to check all external links for integrity"
+    @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
 
 clean:
-	-rm -rf $(BUILDDIR)/*
+    -rm -rf $(BUILDDIR)/*
 
 html:
-	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
-	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+    $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+    @echo
+    @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
 dirhtml:
-	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
-	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+    $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+    @echo
+    @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
 
 singlehtml:
-	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
-	@echo
-	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+    $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+    @echo
+    @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
 
 pickle:
-	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
-	@echo
-	@echo "Build finished; now you can process the pickle files."
+    $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+    @echo
+    @echo "Build finished; now you can process the pickle files."
 
 json:
-	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
-	@echo
-	@echo "Build finished; now you can process the JSON files."
+    $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+    @echo
+    @echo "Build finished; now you can process the JSON files."
 
 htmlhelp:
-	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
-	@echo
-	@echo "Build finished; now you can run HTML Help Workshop with the" \
-	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+    $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+    @echo
+    @echo "Build finished; now you can run HTML Help Workshop with the" \
+          ".hhp project file in $(BUILDDIR)/htmlhelp."
 
 qthelp:
-	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
-	@echo
-	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
-	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/os_ken.qhcp"
-	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/os_ken.qhc"
+    $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+    @echo
+    @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+          ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+    @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/os_ken.qhcp"
+    @echo "To view the help file:"
+    @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/os_ken.qhc"
 
 devhelp:
-	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
-	@echo
-	@echo "Build finished."
-	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/os_ken"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/os_ken"
-	@echo "# devhelp"
+    $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+    @echo
+    @echo "Build finished."
+    @echo "To view the help file:"
+    @echo "# mkdir -p $$HOME/.local/share/devhelp/os_ken"
+    @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/os_ken"
+    @echo "# devhelp"
 
 epub:
-	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
-	@echo
-	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+    $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+    @echo
+    @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
 
 latex:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo
-	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
-	@echo "Run \`make' in that directory to run these through (pdf)latex" \
-	      "(use \`make latexpdf' here to do that automatically)."
+    $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+    @echo
+    @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+    @echo "Run \`make' in that directory to run these through (pdf)latex" \
+          "(use \`make latexpdf' here to do that automatically)."
 
 latexpdf:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo "Running LaTeX files through pdflatex..."
-	$(MAKE) -C $(BUILDDIR)/latex all-pdf
-	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+    $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+    @echo "Running LaTeX files through pdflatex..."
+    $(MAKE) -C $(BUILDDIR)/latex all-pdf
+    @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 
 text:
-	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
-	@echo
-	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+    $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+    @echo
+    @echo "Build finished. The text files are in $(BUILDDIR)/text."
 
 man:
-	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
-	@echo
-	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+    $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+    @echo
+    @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
 
 changes:
-	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
-	@echo
-	@echo "The overview file is in $(BUILDDIR)/changes."
+    $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+    @echo
+    @echo "The overview file is in $(BUILDDIR)/changes."
 
 linkcheck:
-	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
-	@echo
-	@echo "Link check complete; look for any errors in the above output " \
-	      "or in $(BUILDDIR)/linkcheck/output.txt."
+    $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+    @echo
+    @echo "Link check complete; look for any errors in the above output " \
+          "or in $(BUILDDIR)/linkcheck/output.txt."
 
 doctest:
-	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
-	@echo "Testing of doctests in the sources finished, look at the " \
-	      "results in $(BUILDDIR)/doctest/output.txt."
+    $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+    @echo "Testing of doctests in the sources finished, look at the " \
+          "results in $(BUILDDIR)/doctest/output.txt."

doc/source/library_bgp_speaker.rst

@@ -47,8 +47,8 @@ instance advertizes some prefixes.
                              peer_down_handler=detect_peer_down)
 
         speaker.neighbor_add('192.168.177.32', 64513)
-	# uncomment the below line if the speaker needs to talk with a bmp server.
-	# speaker.bmp_server_add('192.168.177.2', 11019)
+    # uncomment the below line if the speaker needs to talk with a bmp server.
+    # speaker.bmp_server_add('192.168.177.2', 11019)
         count = 1
         while True:
             eventlet.sleep(30)

doc/source/man/osken_manager.rst

@@ -77,10 +77,10 @@ app
 --ctl-cert CTL_CERT
     controller certificate
 
---ctl-privkey CTL_PRIVKEY  
+--ctl-privkey CTL_PRIVKEY
     controller private key
 
---default-log-level DEFAULT_LOG_LEVEL  
+--default-log-level DEFAULT_LOG_LEVEL
     default log level
 
 --explicit-drop
@@ -99,37 +99,37 @@ app
 --log-file LOG_FILE
     log file name
 
---log-file-mode LOG_FILE_MODE  
+--log-file-mode LOG_FILE_MODE
     default log file permission
 
---neutron-admin-auth-url NEUTRON_ADMIN_AUTH_URL  
+--neutron-admin-auth-url NEUTRON_ADMIN_AUTH_URL
     auth url for connecting to neutron in admin context
 
---neutron-admin-password NEUTRON_ADMIN_PASSWORD  
+--neutron-admin-password NEUTRON_ADMIN_PASSWORD
     password for connecting to neutron in admin context
 
---neutron-admin-tenant-name NEUTRON_ADMIN_TENANT_NAME  
+--neutron-admin-tenant-name NEUTRON_ADMIN_TENANT_NAME
     tenant name for connecting to neutron in admin context
 
---neutron-admin-username NEUTRON_ADMIN_USERNAME  
+--neutron-admin-username NEUTRON_ADMIN_USERNAME
     username for connecting to neutron in admin context
 
---neutron-auth-strategy NEUTRON_AUTH_STRATEGY  
+--neutron-auth-strategy NEUTRON_AUTH_STRATEGY
     auth strategy for connecting to neutron in admincontext
 
---neutron-controller-addr NEUTRON_CONTROLLER_ADDR  
+--neutron-controller-addr NEUTRON_CONTROLLER_ADDR
     openflow method:address:port to set controller ofovs bridge
 
---neutron-url NEUTRON_URL  
+--neutron-url NEUTRON_URL
     URL for connecting to neutron
 
---neutron-url-timeout NEUTRON_URL_TIMEOUT  
+--neutron-url-timeout NEUTRON_URL_TIMEOUT
     timeout value for connecting to neutron in seconds
 
 --noexplicit-drop
     The inverse of --explicit-drop
 
---noinstall-lldp-flow  
+--noinstall-lldp-flow
     The inverse of --install-lldp-flow
 
 --noobserve-links
@@ -147,13 +147,13 @@ app
 --observe-links
     observe link discovery events.
 
---ofp-listen-host OFP_LISTEN_HOST  
+--ofp-listen-host OFP_LISTEN_HOST
     openflow listen host
 
---ofp-ssl-listen-port OFP_SSL_LISTEN_PORT  
+--ofp-ssl-listen-port OFP_SSL_LISTEN_PORT
     openflow ssl listen port
 
---ofp-tcp-listen-port OFP_TCP_LISTEN_PORT  
+--ofp-tcp-listen-port OFP_TCP_LISTEN_PORT
     openflow tcp listen port
 
 --use-stderr
@@ -168,17 +168,17 @@ app
 --version
     show program's version number and exit
 
---wsapi-host WSAPI_HOST  
+--wsapi-host WSAPI_HOST
     webapp listen host
 
---wsapi-port WSAPI_PORT  
+--wsapi-port WSAPI_PORT
     webapp listen port
-  
---test-switch-dir TEST-SWITCH_DIR  
+
+--test-switch-dir TEST-SWITCH_DIR
     test files directory
 
---test-switch-target TEST-SWITCH_TARGET  
+--test-switch-target TEST-SWITCH_TARGET
     target sw dp-id
 
---test-switch-tester TEST-SWITCH_TESTER  
+--test-switch-tester TEST-SWITCH_TESTER
     tester sw dp-id

etc/os_ken/os_ken.conf

@@ -1,4 +1,4 @@
-# Sample configuration file 
+# Sample configuration file
 
 [DEFAULT]