Listing the information from ifcfg files

This patch adds a new control/model called Cfginterfaces and
Cfginterface to handle the configuration files of the network
interfaces. It includes changes in control and model files,
docs/API.md, i18n and Makefile.am.

A new unit test was added to support this new feature. The test
uses a python module called 'mock' that wasn't being used before,
thus an update in the README file was also made to add this package
as an unit test dependency.

Author: abhiramkulkarni

README

@@ -6,23 +6,32 @@ from Kimchi, that provides an intuitive web panel with common tools for
 configuring and operating Linux systems.
 
 The current features include:
- + retreive system health (sensors) stats
+ + retrieve system health (sensors) stats
  + user login account management,
  + network interface configuration,
  + configuration backup,
  + Power (ppc) firmware update,
  + Power policy management.
 
-Kimchi is an HTML5 based management tool for KVM. It is designed to make it as
-easy as possible to get started with KVM and create your first guest.
 
-- Note on Ubuntu/Debian:
+*** Dependencies for Ubuntu/Debian ***
 
 To run the source code in Ubuntu/Debian an extra package is required:
 
 $ sudo apt-get install python-libuser
 
-- Notes on Power policy management feature:
+This step is not required for installation using the .deb package.
+
+
+*** Dependencies for the unit tests ***
+
+To run the unit tests from the source code the python mock package
+is required:
+
+$ sudo pip install mock
+
+
+*** Notes on Power policy management feature ***
 
 The power policy management feature uses the 'tuned' service to control the
 power policies of the host. Problems have been reported with this package,
@@ -49,7 +58,8 @@ $ systemctl restart wokd.service
 If these steps do not solve the problem, try to update all 'tuned' related
 packages and the packages'selinux-policy' and 'selinux-policy-targeted'.
 
-Copyright notice:
+
+*** Copyright notice ***
 
 All the .gif and .png files in 'ui/css/base/images/' directory are licensed
 as follows:

controls/Makefile.am

@@ -21,6 +21,7 @@ controls_PYTHON = \
 	__init__.py \
 	backup.py \
 	capabilities.py \
+	cfginterfaces.py \
 	firmware.py \
 	ibm_sep.py \
 	interfaces.py \

controls/cfginterfaces.py

@@ -0,0 +1,36 @@
+#
+# Project Ginger
+#
+# Copyright IBM, Corp. 2015
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
+
+from wok.control.base import Collection, Resource
+
+
+class Cfginterfaces(Collection):
+    def __init__(self, model):
+        super(Cfginterfaces, self).__init__(model)
+        self.resource = Cfginterface
+
+
+class Cfginterface(Resource):
+    def __init__(self, model, ident):
+        super(Cfginterface, self).__init__(model, ident)
+        self.uri_fmt = '/network/cfginterfaces/%s'
+
+    @property
+    def data(self):
+        return self.info

controls/network.py

@@ -17,6 +17,7 @@
 # License along with this library; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
 
+from cfginterfaces import Cfginterfaces
 from interfaces import Interfaces
 from wok.control.base import Resource
 
@@ -28,6 +29,7 @@ def __init__(self, model):
         self.role_key = "administration"
         self.admin_methods = ['PUT']
         self.interfaces = Interfaces(model)
+        self.cfginterfaces = Cfginterfaces(model)
         self.uri_fmt = '/network/%s'
         self.update_params = ['nameservers', 'gateway']
         self.confirm_change = self.generate_action_handler('confirm_change')

docs/API.md

@@ -147,3 +147,65 @@ to use the API effectively, please consider the following general conventions
 * start: Start the SEP daemon on host server.
 * stop: Stop the SEP daemon on host server.
 
+### Resource: IBM Serviceable Event Provider (SEP)
+
+**URI:** /plugins/ginger/ibm_sep
+
+**Methods:**
+
+* **GET**: Retrieve a dictionary with the SEP status and subscription information:
+    * status: Status of the SEP agent. Can be 'running' or 'not running'.
+    * subscription: Dictionaries with the SEP subscription information:
+        * hostname: Hostname of the host server.
+        * port: Number of the network port used by the SEP agent.
+        * community: SNMP community name which host server is member.
+* **PUT**: Create and/or update a subscription
+
+*Actions (POST):**
+
+* start: Start the SEP daemon on host server.
+* stop: Stop the SEP daemon on host server.
+
+### Resource: Netork Inferface Configuration
+
+**URI:** /plugins/ginger/network/cfginterfaces/*:name*
+
+**Methods:**
+
+* **GET**: Retrieve the information available in network interface
+           file /etc/sysconfig/network-scripts/ifcfg-<name>
+    * BASIC_INFO: Basic information of network interface:
+        * NAME: Name of the interface.
+        * DEVICE: Device name of the interface.
+        * ONBOOT: 'Yes' if interface is to be brought up during boot,
+                  'No' if interface should not be brought up during boot.
+        * TYPE: Interface type (Ethernet,Bond,Vlan)
+        * MACADDR: Mac address of ethernet device.
+        * VLAN: 'Yes' If its vlan device.
+        * VLAN_ID: Vland of the vlan device.
+        * PHYSDEV: physical device associated with the vlan device.
+        * BONDING_OPTS: Bonding parameters of the Bond device.
+        * BONDING_MASTER: 'yes' if its bond device.
+        * SLAVES: Returns slaves associated with the bond.
+    * IPV4_INFO:IPV4 information of network interface:
+        * BOOTPROTO: Boot protocol for ipv4(dhcp,none,autoip)
+        * DEFROUTE: 'yes' Use default route
+        * DNS: 'DNS' ip
+        * PEERROUTES: 'yes' use PEERROUTES
+        * IPV4_FAILURE_FATAL: 'yes' ipv4 connections fails then
+                              interface is considered inactive
+        * PEERDNS: 'yes' use the peerdns configured
+        * IPADDR: ipv4 address of the interface
+        * NETMASK: netmask of the ipv4 address
+        * GATEWAY: Gateway assigned to the ipv4 address
+    * IPV6_INFO:IPV6 information of network interface:
+        * IPV6INIT: 'yes' to initalize ipv6 for the interface
+        * IPV6_AUTOCONF: 'yes' automatic mode for ipv6
+        * DHCPV6C: 'yes' dhcp automatic mode for ipv6
+        * IPV6_DEFROUTE: 'yes' Use default route
+        * IPV6_PEERROUTES: 'yes' use PEERROUTES
+        * IPV6_FAILURE_FATAL: 'yes' ipv6 connections fails then
+                              interface is considered inactive
+        * IPV6_PEERDNS: 'yes' use the peerdns configured
+        * IPV6ADDR: ipv6 address of the interface
+        * IPV6_DEFAULTGW: Gateway assigned to the ipv6 address

i18n.py

@@ -41,6 +41,8 @@
                      "the current IP/netmask)."),
     "GINNET0013E": _("Interface %(name)s is not editable because it belongs "
                      "to a vlan or bridge"),
+    "GINNET0014E": _("%(name)s is not valid network interface"),
+    "GINNET0015E": _("Error getting information from ifcfg file: '%(error)s'."),
 
     "GINUSER0001E": _("Specify name, password, group and profile for the new "
                       "user."),

models/Makefile.am

@@ -21,6 +21,7 @@ models_PYTHON = \
 	__init__.py \
 	backup.py \
 	capabilities.py \
+	cfginterfaces.py \
 	firmware.py \
 	ibm_sep.py \
 	interfaces.py \