Joyent: wait for node state to flip to 'ready' (#37305)

When provisioning a SmartOS machine on Joyent using salt-cloud, the IP
is often set before SSH is fully configured. This can result in a
successful SFTP transfer, followed by a failure to run
salt-bootstrap.sh.

salt/cloud/clouds/joyent.py

@@ -205,7 +205,9 @@ def query_instance(vm_=None, call=None):
         log.debug('Returned query data: {0}'.format(data))
 
         if 'primaryIp' in data[1]:
-            return data[1]['primaryIp']
+            # Wait for SSH to be fully configured on the remote side
+            if data[1]['state'] == 'running':
+                return data[1]['primaryIp']
         return None
 
     try:

tests/unit/cloud/clouds/joyent_test.py

@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+'''
+    :codeauthor: :email:`Eric Radman <ericshane@eradman.com>`
+'''
+
+# Import Salt Libs
+from __future__ import absolute_import
+
+# Import Salt Testing Libs
+from salttesting import TestCase, skipIf
+from salttesting.helpers import ensure_in_syspath
+from salttesting.mock import MagicMock, patch, NO_MOCK, NO_MOCK_REASON
+
+
+# Import Salt Libs
+from salt.cloud.clouds import joyent
+
+ensure_in_syspath('../../../')
+
+# Globals
+joyent.__utils__ = dict()
+joyent.__opts__ = dict()
+
+
+# Stubs
+def fake_wait_for_ip(check_for_ip_fn,
+                     interval=None,
+                     timeout=None,
+                     interval_multiplier=None):
+    '''
+    Callback that returns immediately instead of waiting
+    '''
+    assert isinstance(interval, int)
+    assert isinstance(timeout, int)
+    assert isinstance(interval_multiplier, int)
+    return check_for_ip_fn()
+
+
+@skipIf(NO_MOCK, NO_MOCK_REASON)
+class JoyentTestCase(TestCase):
+    '''
+    Unit TestCase for the salt.cloud.clouds.joyent module
+    '''
+    joyent.__utils__ = {
+        'cloud.fire_event': MagicMock()
+    }
+    joyent.__opts__ = {
+        'sock_dir': True,
+        'transport': True,
+        'providers': {'my_joyent': {}}
+    }
+    vm_ = {'name': 'vm3', 'driver': 'joyent'}
+
+    @patch('salt.utils.cloud.wait_for_ip', fake_wait_for_ip)
+    def test_query_instance_init(self):
+        '''
+        Initial provisioning, no IP assigned
+        '''
+        # Not yet reachable
+        reply = (200, {'state': 'provisioning'})
+        with patch.object(joyent, 'show_instance', return_value=reply):
+            result = joyent.query_instance(self.vm_)
+        self.assertTrue(joyent.__utils__['cloud.fire_event'].called_once())
+        self.assertEqual(result, None)
+
+    @patch('salt.utils.cloud.wait_for_ip', fake_wait_for_ip)
+    def test_query_instance_has_ip(self):
+        '''
+        IP address assigned but not yet ready
+        '''
+        reply = (200, {'primaryIp': '1.1.1.1', 'state': 'provisioning'})
+        with patch.object(joyent, 'show_instance', return_value=reply):
+            result = joyent.query_instance(self.vm_)
+        self.assertTrue(joyent.__utils__['cloud.fire_event'].called_once())
+        self.assertEqual(result, None)
+
+    @patch('salt.utils.cloud.wait_for_ip', fake_wait_for_ip)
+    def test_query_instance_ready(self):
+        '''
+        IP address assigned, and VM is ready
+        '''
+        reply = (200, {'primaryIp': '1.1.1.1', 'state': 'running'})
+        with patch.object(joyent, 'show_instance', return_value=reply):
+            result = joyent.query_instance(self.vm_)
+        self.assertTrue(joyent.__utils__['cloud.fire_event'].called_once())
+        self.assertEqual(result, '1.1.1.1')
+
+
+if __name__ == '__main__':
+    from integration import run_tests
+    run_tests(JoyentTestCase, needs_daemon=False)