modules/nilrt_ip.py: Add EtherCAT Support #48617

alexvasiu · 2018-07-17T08:48:11Z

modules/nilrt_ip.py: Add EtherCAT Support

The possibilities for adapter mode are: TCP/IP, EhterCAT and Disabled.

Signed-off-by: Alexandru Vasiu alexandru.vasiu@ni.com
Signed-off-by: Ovidiu-Adrian Vancea ovidiu.vancea@ni.com

modules/nilrt_ip.py: Fix configparser compatibility

read_file is available only since python 3.2 so readfp should
be used instead

Signed-off-by: Alexandru Vasiu alexandru.vasiu@ni.com

The possibilities for adapter mode are: TCP/IP, EhterCAT and Disabled. Signed-off-by: Alexandru Vasiu <alexandru.vasiu@ni.com> Signed-off-by: Ovidiu-Adrian Vancea <ovidiu.vancea@ni.com>

rares-pop · 2018-07-17T11:24:40Z

salt/modules/nilrt_ip.py

+        config_parser = configparser.RawConfigParser(dict_type=CaseInsensitiveDict)
+        config_parser.read_file(config_file)
+        mode = '' if not config_parser.has_option(interface, 'mode') else \
+            _remove_quotes(config_parser.get(interface, 'mode').lower())


This seems to be an anti-pattern - doing an 'has_option' then a 'get()'. Can we use a default for the get() and do only that?

More than that, the first 5 lines seems to be a pattern that is repeated throughout the code. Can/Should we create a higher-level wrapper over the configparser to hide all this boilerplate code?

get() throws an exception if the option doesn't exist

We can make a class or a global variable where the config will be read only one time, but the problem is that if we write something with nirtcfg then we should reload config from INI_FILE in configparser, so a method like this one will be ok:

def _get_option_configparser(section, option, default_value='', file=INI_FILE): with salt.utils.files.fopen(file, 'r') as config_file: config_parser = configparser.RawConfigParser(dict_type=CaseInsensitiveDict) config_parser.read_file(config_file) if config_parser.has_section(section) and config_parser.has_option(option): return config_parser.get(section, option) return default_value

There should be some option to pass defaults to the get, so you can avoid the has_option/get pair.

We shouldn't need a class, but only a function that can take a list of keys and returns a dict with keys/values

rares-pop · 2018-07-17T11:28:12Z

salt/modules/nilrt_ip.py

+        if initial_mode == 'ethercat':
+            __salt__['system.set_reboot_required_witnessed']()
+        else:
+            disable(interface)


there seem to be a lot of disable(interface) followed by enable(interface). Should we create a 'restart' or something?

rares-pop · 2018-07-17T11:32:07Z

salt/modules/nilrt_ip.py

+    '''
+    if __grains__['lsb_distrib_id'] == 'nilrt':
+        initial_mode = _get_adaptermode_info(interface)
+        _set_adapter_mode(interface, 'EtherCAT')


why you spell 'EtherCAT' here, but do this in other places: if initial_mode == 'ethercat':

that is for network settings to understand the mode is EtherCAT but when I parse INI_FILE, I user CaseInsensitiveDict so that will transform EtherCAT in ethercat

how about creating a constant and use that everywhere?

I find confusing to see both 'EtherCAT' and 'ethercat' as values.

I will make a constant:

NIRTCFG_ETHERCAT = 'EtherCAT'

rares-pop · 2018-07-18T13:58:36Z

salt/modules/nilrt_ip.py


    # some versions of nirtcfg don't set the dhcpenabled/linklocalenabled variables
    # when selecting "DHCP or Link Local" from MAX, so return it by default to avoid
    # having the requestmode "None" because none of the conditions above matched.
    return 'dhcp_linklocal'


+def _get_adapter_mode_info(interface):


can this benefit from the newly created function? - _get_config_options

Forgot about that function ... I'll change it

rares-pop · 2018-07-18T13:59:41Z

salt/modules/nilrt_ip.py

        },
        'hwaddr': interface.hwaddr[:-1]
    }
+    with salt.utils.files.fopen(INI_FILE, 'r') as config_file:


Is this used anywhere?

I will delete that

rares-pop · 2018-07-18T14:28:05Z

salt/modules/nilrt_ip.py

        },
        'hwaddr': interface.hwaddr[:-1]
    }
+    with salt.utils.files.fopen(INI_FILE, 'r') as config_file:
+        config_parser = configparser.RawConfigParser(dict_type=CaseInsensitiveDict)


shouldn't this use the _persist_config method? And have that method fixed to use the config parser?

should we rename the _persist_config and _get_config_options to match i.e. (save/load or serialize/deserialize or something that makes sense).

Maybe _save_config for _persist_config and _load_config for _get_config_options

That makes sense

alexvasiu · 2018-07-18T14:40:21Z

salt/modules/nilrt_ip.py

+    '''
+    return adaptermode for given interface
+    '''
+    mode = _load_config(interface, ['mode'])['mode']


I didn't put default_value = 'tcpip' because the file may be corrupted and mode should be one of these values:

disabled

ethercat

tcpip (default value)

rares-pop · 2018-07-18T14:41:40Z

salt/modules/nilrt_ip.py

+    '''
+    return adaptermode for given interface
+    '''
+    mode = _load_config(interface, ['mode'])['mode']


this will raise if 'mode' is not in the file.

Should you go with:
mode = _load_config(interface, ['mode']).get('mode') ?

If mode is not in file, _load_config will return the default_value for it:

mode = { 'mode': '' }

Ah, forgot about that.

rares-pop · 2018-07-18T14:49:20Z

salt/modules/nilrt_ip.py

-        if out['retcode'] != 0:
-            msg = 'Couldn\'t disable interface {0}. Error: {1}'.format(interface, out['stderr'])
-            raise salt.exceptions.CommandExecutionError(msg)
+        initial_mode = _get_adapter_mode_info(interface)


up/down code is almost identical. Can you create a worker to share the logic?

A function called _change_state(state) and state can be up or down ?

Looks good to me!

The possibilities for adapter mode are: TCP/IP, EhterCAT and Disabled. Signed-off-by: Alexandru Vasiu <alexandru.vasiu@ni.com> Signed-off-by: Ovidiu-Adrian Vancea <ovidiu.vancea@ni.com>

read_file is available only since python 3.2 so readfp should be used instead Signed-off-by: Alexandru Vasiu <alexandru.vasiu@ni.com>

rares-pop · 2018-07-19T07:53:19Z

Things look good to me.

@gtmanfred can you take a look on these? They are something we'd need for Fluorine.

gtmanfred

rares-pop

There is still a small cleanup to be made. I'm fine doing it in a different review since the functionality is correct as is.

rares-pop · 2018-07-20T13:22:38Z

salt/modules/nilrt_ip.py

@@ -404,43 +495,81 @@ def get_interfaces_details():
    return {'interfaces': list(map(_get_info, _interfaces))}


-def up(interface, iface_type=None):  # pylint: disable=invalid-name,unused-argument
+def _set_adapter_mode(interface, mode):


I overlooked this before - but this shouldn't be needed. We should use _save_config() directly instead of this

rares-pop · 2018-07-20T13:23:42Z

salt/modules/nilrt_ip.py

@@ -504,7 +621,7 @@ def disable(interface):
    return down(interface)


-def _persist_config(section, token, value):
+def _save_config(section, token, value):


I thought this was supposed to use the configparser too. Did we change our mind?

for reading, we use config parser and for writing nirtcfg (is also used by the system) ... we should test if the file will be corrupted if we are writing at the same time with nirtcfg and config parser

Okay. It looks good!

rares-pop · 2018-07-20T13:24:11Z

salt/modules/nilrt_ip.py

+    if __grains__['lsb_distrib_id'] == 'nilrt':
+        initial_mode = _get_adapter_mode_info(interface)
+        _set_adapter_mode(interface, NIRTCFG_ETHERCAT)
+        if __salt__['cmd.run_all']('{0} --set section={1},token=MasterID,value={2}'.


why not _save_config()?

rallytime

I just have a couple of small requests.

rallytime · 2018-07-23T14:22:19Z

salt/modules/nilrt_ip.py

@@ -258,45 +259,102 @@ def _remove_quotes(value):
    return value


-def _get_requestmode_info(interface):
+def _load_config(section, options, default_value='', file=INI_FILE):


Can we use a variable name other than file here? It's a reserved word and can cause problems.

rallytime · 2018-07-23T14:22:44Z

salt/modules/nilrt_ip.py

@@ -258,45 +259,102 @@ def _remove_quotes(value):
    return value


-def _get_requestmode_info(interface):
+def _load_config(section, options, default_value='', file=INI_FILE):
+    """


I know this is picky, but can you use single quotes for docstrings? That's how we like them in Salt. :)

rallytime · 2018-07-23T14:23:54Z

salt/modules/nilrt_ip.py

-    '''
-    Enable the specified interface
+def _change_state(interface, new_state):
+    """


Single quotes here, too.

rallytime · 2018-07-23T14:24:31Z

salt/modules/nilrt_ip.py

+
+
+def _restart(interface):
+    """


And here. :)

Signed-off-by: Alexandru Vasiu <alexandru.vasiu@ni.com>

rallytime · 2018-07-26T21:36:07Z

@rares-pop How does this look to you now?

rares-pop · 2018-07-27T08:10:21Z

@rallytime - the code looks good and works correctly.

In the near future we'll replace the _save_config to use the ConfigParser as opposed to a binary that's saving the things in the ini.. It's fine to leave it in a separate commit since it's not critical by any means and we have to check that the ConfigParser is 'thread-safe' in terms of not corrupting the ini file when called multiple times from multiple processes.

rallytime · 2018-07-27T13:31:17Z

@alexvasiu There's one lint error that needs to be fixed here: https://jenkinsci.saltstack.com/job/pr-lint/job/PR-48617/10/

Signed-off-by: Alexandru Vasiu <alexandru.vasiu@ni.com>

alexvasiu · 2018-07-27T14:17:11Z

@rallytime Fixed

UPDATE: Lint failed because of salt.modules.config

alexvasiu force-pushed the dev/avasiu/add_ethercat_support branch from 1cd1b8b to 14dcec7 Compare July 17, 2018 08:59

modules/nilrt_ip.py: Add EtherCAT Support

3e502c1

The possibilities for adapter mode are: TCP/IP, EhterCAT and Disabled. Signed-off-by: Alexandru Vasiu <alexandru.vasiu@ni.com> Signed-off-by: Ovidiu-Adrian Vancea <ovidiu.vancea@ni.com>

alexvasiu force-pushed the dev/avasiu/add_ethercat_support branch from 14dcec7 to 3e502c1 Compare July 17, 2018 10:46

rares-pop reviewed Jul 17, 2018

View reviewed changes

alexvasiu force-pushed the dev/avasiu/add_ethercat_support branch from 3e502c1 to b3d626d Compare July 18, 2018 11:17

rares-pop reviewed Jul 18, 2018

View reviewed changes

alexvasiu force-pushed the dev/avasiu/add_ethercat_support branch from b3d626d to e0f8d6a Compare July 18, 2018 14:37

alexvasiu commented Jul 18, 2018

View reviewed changes

rares-pop reviewed Jul 18, 2018

View reviewed changes

Alexandru Vasiu added 2 commits July 18, 2018 18:12

modules/nilrt_ip.py: Add EtherCAT Support

8c9dfb3

The possibilities for adapter mode are: TCP/IP, EhterCAT and Disabled. Signed-off-by: Alexandru Vasiu <alexandru.vasiu@ni.com> Signed-off-by: Ovidiu-Adrian Vancea <ovidiu.vancea@ni.com>

modules/nilrt_ip.py: Fix configparser compatibility

73f533e

read_file is available only since python 3.2 so readfp should be used instead Signed-off-by: Alexandru Vasiu <alexandru.vasiu@ni.com>

alexvasiu force-pushed the dev/avasiu/add_ethercat_support branch from e0f8d6a to 73f533e Compare July 18, 2018 15:13

gtmanfred approved these changes Jul 19, 2018

View reviewed changes

gtmanfred added the ZRELEASED - Fluorine reitred label label Jul 19, 2018

rares-pop reviewed Jul 20, 2018

View reviewed changes

rallytime suggested changes Jul 23, 2018

View reviewed changes

alexvasiu force-pushed the dev/avasiu/add_ethercat_support branch from 20210cb to 7cd5543 Compare July 24, 2018 06:42

modules/nilrt_ip.py: Clean-Up

a429ef8

Signed-off-by: Alexandru Vasiu <alexandru.vasiu@ni.com>

alexvasiu force-pushed the dev/avasiu/add_ethercat_support branch from 7cd5543 to a429ef8 Compare July 25, 2018 10:38

rallytime approved these changes Jul 26, 2018

View reviewed changes

modules/nilrt_ip.py: Fix argument for function _load_config

354e664

Signed-off-by: Alexandru Vasiu <alexandru.vasiu@ni.com>

alexvasiu force-pushed the dev/avasiu/add_ethercat_support branch from e54d761 to 354e664 Compare July 27, 2018 14:16

rallytime merged commit 73ec7fb into saltstack:develop Jul 27, 2018

modules/nilrt_ip.py: Add EtherCAT Support #48617

modules/nilrt_ip.py: Add EtherCAT Support #48617

Conversation

alexvasiu commented Jul 17, 2018 • 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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rares-pop commented Jul 19, 2018

gtmanfred left a comment

Choose a reason for hiding this comment

rares-pop left a comment • 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

rallytime 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

rallytime commented Jul 26, 2018

rares-pop commented Jul 27, 2018

rallytime commented Jul 27, 2018

alexvasiu commented Jul 27, 2018 • edited Loading

alexvasiu commented Jul 17, 2018 •

edited

Loading

rares-pop left a comment •

edited

Loading

alexvasiu commented Jul 27, 2018 •

edited

Loading