Added support for alternate SSH ports in AsusWRT (#4832) #6109

swbradshaw · 2017-02-19T21:36:38Z

My Asus router doesn't run SSH on port 22. This allows Home Assistant to work now by exposing this the SSH port as a parameter.

Related issue (if applicable): fixes #4832

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.io#1721

Example entry for configuration.yaml (if applicable):

device_tracker:
  - platform: asuswrt
    host: YOUR_ROUTER_IP
    username: YOUR_ADMIN_USERNAME
    password: YOUR_ADMIN_PASSWORD
    protocol: ssh
    port: 22222

Checklist:

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.github.io

If the code communicates with devices, web services, or third-party tools:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
New dependencies have been added to the REQUIREMENTS variable (example).
New dependencies are only imported inside functions that use them (example).
New dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

If the code does not interact with devices:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
Tests have been added to verify that the new code works.

mention-bot · 2017-02-19T21:36:39Z

@swbradshaw, thanks for your PR! By analyzing the history of the files in this pull request, we identified @fabaff, @linjef and @SEJeff to be potential reviewers.

homeassistant · 2017-02-19T21:36:39Z

Hello @swbradshaw,

When attempting to inspect the commits of your pull request for CLA signature status among all authors we encountered commit(s) which were not linked to a GitHub account, thus not allowing us to determine their status(es).

The commits that are missing a linked GitHub account are the following:

402a77978c1391d67f059155a9b123d06bfe4a05 - This commit has something that looks like an email address (swbradshaw@gmail.com). Maybe try linking that to GitHub?.

Unfortunately, we are unable to accept this pull request until this situation is corrected.

Here are your options:

If you had an email address set for the commit that simply wasn't linked to your GitHub account you can link that email now and it will retroactively apply to your commits. The simplest way to do this is to click the link to one of the above commits and look for a blue question mark in a blue circle in the top left. Hovering over that bubble will show you what email address you used. Clicking on that button will take you to your email address settings on GitHub. Just add the email address on that page and you're all set. GitHub has more information about this option in their help center.
If you didn't use an email address at all, it was an invalid email, or it's one you can't link to your GitHub, you will need to change the authorship information of the commit and your global Git settings so this doesn't happen again going forward. GitHub provides some great instructions on how to change your authorship information in their help center.
- If you only made a single commit you should be able to run
```
git commit --amend --author="Author Name <email@address.com>"
```
  (substituting Author Name and email@address.com for your actual information) to set the authorship information.
- If you made more than one commit and the commit with the missing authorship information is not the most recent one you have two options:
  1. You can re-create all commits missing authorship information. This is going to be the easiest solution for developers that aren't extremely confident in their Git and command line skills.
  2. You can use this script that GitHub provides to rewrite history. Please note: this should be used only if you are very confident in your abilities and understand its impacts.
- Whichever method you choose, I will come by to re-check the pull request once you push the fixes to this branch.

We apologize for this inconvenience, especially since it usually bites new contributors to Home Assistant. We hope you understand the need for us to protect ourselves and the great community we all have built legally. The best thing to come out of this is that you only need to fix this once and it benefits the entire Home Assistant and GitHub community.

Thanks, I look forward to checking this PR again soon! ❤️

SEJeff

Even though it is super simple, best seems to be a single code path for the ssh args.

SEJeff · 2017-02-19T21:39:59Z

homeassistant/components/device_tracker/asuswrt.py


        if self.protocol == 'ssh':
+
+            if self.port != DEFAULT_SSH_PORT:
+                self.ssh_args['port'] = self.port


This is entirely fine, but my take would be to simply always be explicit about the port. That way the code path that you use when specifying an alternate port is always used.

I agree. I think when I made this change a couple months ago, I did so because the asus_wrt tests were really picky about the port, so I was trying to keep the port 22 when nothing was specified. I was trying (unsuccessfully) to get the tests to pass. I have since figured out the tests, so I'll make this change.

homeassistant · 2017-02-19T21:53:37Z

Hi @swbradshaw,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

houndci-bot · 2017-02-19T21:53:41Z

homeassistant/components/device_tracker/asuswrt.py


        if self.protocol == 'ssh':
+


blank line contains whitespace

homeassistant · 2017-02-19T21:54:44Z

Hi @swbradshaw,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

SEJeff

Looks good to me (from a python standpoint), but I'm just getting back into the swing of contributing to HASS, and would prefer someone who's been a bit more active than me to merge this.

@swbradshaw mind signing the CLA? It isn't a (c) assignment or anything nasty like that.

Also you'll need to update the tests for the new invocation to include port=22 I believe.

swbradshaw · 2017-02-19T22:42:40Z

@SEJeff The CLA was already signed. It looks like the Travis builds are broken after I made the change you suggested. :-( This is the part I got stuck on last time. Give me a couple days and I'll see if I can correct these.

pvizeli · 2017-02-19T23:15:58Z

homeassistant/components/device_tracker/asuswrt.py

@@ -112,12 +115,16 @@ def __init__(self, config):
        self.ssh_key = config.get('ssh_key', config.get('pub_key', ''))
        self.protocol = config[CONF_PROTOCOL]
        self.mode = config[CONF_MODE]
+        self.port = config.get(CONF_PORT, 22)


use only config[CONF_PORT] you have set default on vol.

@pvizeli Thanks for the feedback. Commited this change.

…pvizeli

…pvizeli

swbradshaw

These changes were completed in latest commit

Added support for alternate SSH ports in AsusWRT (home-assistant#4832)

402a779

homeassistant added cla-error platform: device_tracker.asuswrt labels Feb 19, 2017

SEJeff reviewed Feb 19, 2017

View reviewed changes

Always set the SSH port in SSH arguments

543ce3a

homeassistant added the cla-needed label Feb 19, 2017

houndci-bot reviewed Feb 19, 2017

View reviewed changes

homeassistant/components/device_tracker/asuswrt.py Outdated

if self.protocol == 'ssh':

Copy link

houndci-bot Feb 19, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

blank line contains whitespace

Removed whitespace

5a49113

homeassistant added cla-needed cla-signed and removed cla-needed labels Feb 19, 2017

SEJeff approved these changes Feb 19, 2017

View reviewed changes

Adding port=22 to the mock calls

04df4c4

homeassistant added the cla-signed label Feb 19, 2017

pvizeli requested changes Feb 19, 2017

View reviewed changes

Changed config.get(CONF_PORT) to config[CONF_PORT] per feedback from @…

6d33e65

…pvizeli

swbradshaw commented Feb 20, 2017

View reviewed changes

swbradshaw mentioned this pull request Feb 20, 2017

Added SSH port config (#4832) home-assistant/home-assistant.io#1721

Merged

pvizeli approved these changes Feb 20, 2017

View reviewed changes

pvizeli merged commit 37a8035 into home-assistant:dev Feb 20, 2017

home-assistant locked and limited conversation to collaborators Jun 2, 2017

ghost added integration: asuswrt and removed platform: device_tracker.asuswrt labels Mar 21, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added support for alternate SSH ports in AsusWRT (#4832) #6109

Added support for alternate SSH ports in AsusWRT (#4832) #6109

swbradshaw commented Feb 19, 2017 •

edited

mention-bot commented Feb 19, 2017

homeassistant commented Feb 19, 2017

SEJeff left a comment

SEJeff Feb 19, 2017

swbradshaw Feb 19, 2017

homeassistant commented Feb 19, 2017

houndci-bot Feb 19, 2017

homeassistant commented Feb 19, 2017

SEJeff left a comment •

edited

swbradshaw commented Feb 19, 2017

pvizeli Feb 19, 2017

swbradshaw Feb 20, 2017

swbradshaw left a comment

Added support for alternate SSH ports in AsusWRT (#4832) #6109

Added support for alternate SSH ports in AsusWRT (#4832) #6109

Conversation

swbradshaw commented Feb 19, 2017 • edited

mention-bot commented Feb 19, 2017

homeassistant commented Feb 19, 2017

SEJeff left a comment

Choose a reason for hiding this comment

SEJeff Feb 19, 2017

Choose a reason for hiding this comment

swbradshaw Feb 19, 2017

Choose a reason for hiding this comment

homeassistant commented Feb 19, 2017

houndci-bot Feb 19, 2017

Choose a reason for hiding this comment

homeassistant commented Feb 19, 2017

SEJeff left a comment • edited

Choose a reason for hiding this comment

swbradshaw commented Feb 19, 2017

pvizeli Feb 19, 2017

Choose a reason for hiding this comment

swbradshaw Feb 20, 2017

Choose a reason for hiding this comment

swbradshaw left a comment

Choose a reason for hiding this comment

swbradshaw commented Feb 19, 2017 •

edited

SEJeff left a comment •

edited