Add london_underground #8272

robmarkcole · 2017-07-01T06:26:46Z

Description:

This sensor displays the current status of London Underground tube lines. If there is a disruption, a description of the disruption is viewable as an attribute.
This pull request replaces #8235

Example entry for `configuration.yaml`:

sensor:
  - platform: london_underground
    line:
      - Bakerloo
      - Central
      - Circle
      - District
      - DLR
      - Hammersmith & City
      - Jubilee
      - London Overground
      - Metropolitan
      - Northern
      - Piccadilly
      - TfL Rail
      - Victoria
      - Waterloo & City

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

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

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.

Add tube_state sensor

balloob · 2017-07-01T06:33:42Z

homeassistant/components/sensor/tube_state.py

+    'Waterloo & City']
+URL = 'https://api.tfl.gov.uk/line/mode/tube,overground,dlr,tflrail/status'
+
+CONFIG_SCHEMA = vol.Schema({


You are a platform so please define a platform schema:

PLATFORM_SCHEMA = vol.Schema({ vol.Required(CONF_LINE): vol.In(TUBE_LINES), })

balloob · 2017-07-01T06:33:54Z

homeassistant/components/sensor/tube_state.py

+
+ATTRIBUTION = "Powered by TfL Open Data"
+CONF_LINE = 'line'
+DOMAIN = 'tube_state'


platforms don't have a domain. Please remove this line.

balloob · 2017-07-01T06:34:18Z

homeassistant/components/sensor/tube_state.py

+        sensors.append(LondonTubeSensor(line, data))
+
+    add_devices(sensors, True)
+    _LOGGER.info("The tube_state component is ready!")


Please remove these two log lines.

balloob · 2017-07-01T06:35:10Z

homeassistant/components/sensor/tube_state.py

+    def update(self):
+        """Get the latest data from TFL."""
+        response = requests.get(URL)
+        _LOGGER.info("TFL Request made")


Please don't log this as info. If it needs to be logged at all, make it debug

balloob · 2017-07-01T06:37:31Z

tests/components/sensor/test_tube_state.py

+        """Stop everything that was started."""
+        self.hass.stop()
+
+    def test_setup_with_config(self):


Please merge this test with the one below. So instead of tube_state.setup_platform(…) just call setup_component(…).

Then you can read the state from the state machine.

state = self.hass.states.get('sensor.london_overground') assert state.state == 'bla' assert state.attributes.get('Description') == 'Something'

Correct PLATFORM_SCHEMA

houndci-bot · 2017-07-01T07:23:45Z

tests/components/sensor/test_tube_state.py

+        self.hass.stop()
+
+
+    @requests_mock.Mocker()


too many blank lines (2)

balloob · 2017-07-01T07:25:53Z

🎉 🎉 🐬

Test still failing, don’t understand why

lwis · 2017-07-01T10:16:30Z

@robmarkcole self.hass.states.get('sensor.london_overground') is returning None.

robmarkcole · 2017-07-01T11:50:33Z

I don't understand why self.hass.states.get('sensor.london_overground') is returning None..
Test does pass with:

sensor = self.entities[0]
self.assertEqual(sensor.name, 'London Overground')
self.assertEqual(sensor.state, 'Minor Delays')
self.assertEqual(sensor.device_state_attributes['Description'], 'something')

Preferred method below returns None state = self.hass.states.get('sensor.london_overground')

houndci-bot · 2017-07-01T15:27:31Z

tests/components/sensor/test_tube_state.py

+        sensor = self.entities[0]
+        self.assertEqual(sensor.name, 'London Overground')
+        self.assertEqual(sensor.state, 'Minor Delays')
+        self.assertEqual(sensor.device_state_attributes['Description'], 'something')


line too long (84 > 79 characters)

houndci-bot · 2017-07-01T15:27:31Z

tests/components/sensor/test_tube_state.py

+            setup_component(self.hass, 'sensor', {'tube_state': self.config}))
+        #state = self.hass.states.get('sensor.london_overground')
+        #assert state.state == 'Minor Delays'
+        #assert state.attributes.get('Description') == 'something'


block comment should start with '# '

houndci-bot · 2017-07-01T15:27:31Z

tests/components/sensor/test_tube_state.py

+        self.assertTrue(
+            setup_component(self.hass, 'sensor', {'tube_state': self.config}))
+        #state = self.hass.states.get('sensor.london_overground')
+        #assert state.state == 'Minor Delays'


block comment should start with '# '

houndci-bot · 2017-07-01T15:27:31Z

tests/components/sensor/test_tube_state.py

+        self.assertEqual(len(self.entities), 1)
+        self.assertTrue(
+            setup_component(self.hass, 'sensor', {'tube_state': self.config}))
+        #state = self.hass.states.get('sensor.london_overground')


block comment should start with '# '

houndci-bot · 2017-07-01T15:28:56Z

tests/components/sensor/test_tube_state.py

+        self.assertEqual(sensor.name, 'London Overground')
+        self.assertEqual(sensor.state, 'Minor Delays')
+        self.assertEqual(sensor.device_state_attributes['Description'],
+                                                        'something')


continuation line over-indented for visual indent

robmarkcole · 2017-07-01T15:35:07Z

tests/components/sensor/test_tube_state.py

+        # assert state.state == 'Minor Delays'
+        # assert state.attributes.get('Description') == 'something'
+
+        sensor = self.entities[0]


This passes. Copied technique from test_wsdot.py

This technique should not be used. please remove.

balloob

The test needs fixing.

balloob · 2017-07-01T19:17:24Z

tests/components/sensor/test_tube_state.py

+class TestLondonTubeSensor(unittest.TestCase):
+    """Test the tube_state platform."""
+
+    def add_entities(self, new_entities, update_before_add=False):


Remove this.

balloob · 2017-07-01T19:17:31Z

tests/components/sensor/test_tube_state.py

+        """Initialize values for this testcase class."""
+        self.hass = get_test_home_assistant()
+        self.config = {CONF_LINE: ['London Overground']}
+        self.entities = []


Remove this.

balloob · 2017-07-01T19:17:40Z

tests/components/sensor/test_tube_state.py

+    def test_setup(self, mock_req):
+        """Test for operational tube_state sensor with proper attributes."""
+        mock_req.get(URL, text=load_fixture('tube_state.json'))
+        tube_state.setup_platform(self.hass, self.config, self.add_entities)


Remove this.

balloob · 2017-07-01T19:17:46Z

tests/components/sensor/test_tube_state.py

+        """Test for operational tube_state sensor with proper attributes."""
+        mock_req.get(URL, text=load_fixture('tube_state.json'))
+        tube_state.setup_platform(self.hass, self.config, self.add_entities)
+        self.assertEqual(len(self.entities), 1)


balloob · 2017-07-01T19:18:08Z

tests/components/sensor/test_tube_state.py

+        self.assertEqual(len(self.entities), 1)
+        self.assertTrue(
+            setup_component(self.hass, 'sensor', {'tube_state': self.config}))
+        # state = self.hass.states.get('sensor.london_overground')


Instead of commenting it out, check what the entity name is. It's right there in the test logs.

balloob · 2017-07-01T19:18:25Z

tests/components/sensor/test_tube_state.py

+        # assert state.state == 'Minor Delays'
+        # assert state.attributes.get('Description') == 'something'
+
+        sensor = self.entities[0]


This technique should not be used. please remove.

Test fails with: AssertionError: assert 0 > 0 where 0 = len([]) Surely I need tube_state.setup_platform ?

houndci-bot · 2017-07-02T06:26:40Z

tests/components/sensor/test_tube_state.py

+import unittest
+import requests_mock
+
+from homeassistant.components.sensor import tube_state


'homeassistant.components.sensor.tube_state' imported but unused

robmarkcole · 2017-07-02T06:28:33Z

tests/components/sensor/test_tube_state.py

+            setup_component(self.hass, 'sensor', {'tube_state': self.config}))
+
+        ids = self.hass.states.entity_ids()
+        assert len(ids) > 0


I have zero entities

Test log on https://github.com/robmarkcole/London-tube-status/blob/master/development/tox_output.txt

Config was wrong

houndci-bot · 2017-07-02T06:59:01Z

tests/components/sensor/test_london_tube.py

+import unittest
+import requests_mock
+
+from homeassistant.components.sensor import london_tube


'homeassistant.components.sensor.london_tube' imported but unused

houndci-bot · 2017-07-02T06:59:02Z

tests/components/sensor/test_london_tube.py

+import unittest
+import requests_mock
+
+from homeassistant.components.sensor import london_tube


'homeassistant.components.sensor.london_tube' imported but unused

Make consistent

houndci-bot · 2017-07-02T07:27:58Z

tests/components/sensor/test_london_underground.py

+import unittest
+import requests_mock
+
+from homeassistant.components.sensor import london_underground


'homeassistant.components.sensor.london_underground' imported but unused

robmarkcole · 2017-07-02T08:11:14Z

I'm not sure what needs to be done about the failing Travis @ https://travis-ci.org/home-assistant/home-assistant/jobs/249272537

balloob · 2017-07-02T18:32:32Z

Woohooo 🎉

robmarkcole · 2017-07-02T18:35:27Z

Fantastic 🤗

* Add tube_state Add tube_state sensor * Final cleanup * Make corrections Correct PLATFORM_SCHEMA * Fix space * Make test pass * Correct format of test Test still failing, don’t understand why * correct description * Make test pass Preferred method below returns None state = self.hass.states.get('sensor.london_overground') * Format for hound * indent * Make requested changes to test, not working Test fails with: AssertionError: assert 0 > 0 where 0 = len([]) Surely I need tube_state.setup_platform ? * Fixed test Config was wrong * Change component name to london_tube * Update name to london_underground Make consistent * cleanup

Add tube_state

6611d7b

Add tube_state sensor

homeassistant added new-platform cla-signed platform: sensor.tube_state labels Jul 1, 2017

balloobbot added the platform label Jul 1, 2017

balloob reviewed Jul 1, 2017

View reviewed changes

Final cleanup

93642cd

homeassistant added the cla-signed label Jul 1, 2017

balloob reviewed Jul 1, 2017

View reviewed changes

balloob added this to the 0.48 milestone Jul 1, 2017

Make corrections

550965c

Correct PLATFORM_SCHEMA

homeassistant added the cla-signed label Jul 1, 2017

houndci-bot reviewed Jul 1, 2017

View reviewed changes

tests/components/sensor/test_tube_state.py Outdated

self.hass.stop()

@requests_mock.Mocker()

Copy link

houndci-bot Jul 1, 2017

Choose a reason for hiding this comment

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

too many blank lines (2)

Fix space

6b607ba

balloob approved these changes Jul 1, 2017

View reviewed changes

robmarkcole added 3 commits July 1, 2017 09:48

Make test pass

a798c4b

Correct format of test

ee1c342

Test still failing, don’t understand why

correct description

6714a1a

Make test pass

49e1b5d

Preferred method below returns None state = self.hass.states.get('sensor.london_overground')

homeassistant added the cla-signed label Jul 1, 2017

houndci-bot reviewed Jul 1, 2017

View reviewed changes

Format for hound

451cec4

houndci-bot reviewed Jul 1, 2017

View reviewed changes

indent

06eee1b

robmarkcole commented Jul 1, 2017

View reviewed changes

balloob requested changes Jul 1, 2017

View reviewed changes

balloob removed this from the 0.48 milestone Jul 1, 2017

Make requested changes to test, not working

90ee414

Test fails with: AssertionError: assert 0 > 0 where 0 = len([]) Surely I need tube_state.setup_platform ?

homeassistant added the cla-signed label Jul 2, 2017

houndci-bot reviewed Jul 2, 2017

View reviewed changes

robmarkcole commented Jul 2, 2017

View reviewed changes

robmarkcole added 2 commits July 2, 2017 07:51

Fixed test

31e6782

Config was wrong

Change component name to london_tube

075d6c4

houndci-bot reviewed Jul 2, 2017

View reviewed changes

robmarkcole changed the title ~~Add tube_state~~ Add london_tube Jul 2, 2017

Update name to london_underground

0e5c176

Make consistent

homeassistant added the cla-signed label Jul 2, 2017

houndci-bot reviewed Jul 2, 2017

View reviewed changes

robmarkcole changed the title ~~Add london_tube~~ Add london_underground Jul 2, 2017

cleanup

49274da

homeassistant added the cla-signed label Jul 2, 2017

balloob approved these changes Jul 2, 2017

View reviewed changes

balloob merged commit 865865c into home-assistant:dev Jul 2, 2017

robmarkcole deleted the london_tube_state branch July 2, 2017 18:37

balloob mentioned this pull request Jul 13, 2017

0.49 #8468

Merged

robmarkcole mentioned this pull request Jul 26, 2017

Adds uk_transport component #8600

Merged

home-assistant locked and limited conversation to collaborators Oct 20, 2017

ghost added integration: tube_state and removed platform: sensor.tube_state labels Mar 21, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add london_underground #8272

Add london_underground #8272

robmarkcole commented Jul 1, 2017 •

edited

Loading

balloob Jul 1, 2017

balloob Jul 1, 2017

balloob Jul 1, 2017

balloob Jul 1, 2017

balloob Jul 1, 2017

houndci-bot Jul 1, 2017

balloob commented Jul 1, 2017

lwis commented Jul 1, 2017

robmarkcole commented Jul 1, 2017 •

edited

Loading

houndci-bot Jul 1, 2017

houndci-bot Jul 1, 2017

houndci-bot Jul 1, 2017

houndci-bot Jul 1, 2017

houndci-bot Jul 1, 2017

robmarkcole Jul 1, 2017

balloob Jul 1, 2017

balloob left a comment

balloob Jul 1, 2017

balloob Jul 1, 2017

balloob Jul 1, 2017

balloob Jul 1, 2017

balloob Jul 1, 2017

balloob Jul 1, 2017

houndci-bot Jul 2, 2017

robmarkcole Jul 2, 2017

robmarkcole Jul 2, 2017

houndci-bot Jul 2, 2017

houndci-bot Jul 2, 2017

houndci-bot Jul 2, 2017

robmarkcole commented Jul 2, 2017

balloob commented Jul 2, 2017

robmarkcole commented Jul 2, 2017

Add london_underground #8272

Add london_underground #8272

Conversation

robmarkcole commented Jul 1, 2017 • edited Loading

Description:

Example entry for configuration.yaml:

Checklist:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

balloob commented Jul 1, 2017

lwis commented Jul 1, 2017

robmarkcole commented Jul 1, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

balloob left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

robmarkcole commented Jul 2, 2017

balloob commented Jul 2, 2017

robmarkcole commented Jul 2, 2017

robmarkcole commented Jul 1, 2017 •

edited

Loading

Example entry for `configuration.yaml`:

robmarkcole commented Jul 1, 2017 •

edited

Loading