openSUSE / agama / 8393553212

25%

master: 72%

Build Type

push

github

Committed by web-flow

Commit Message

Expose the networking API over HTTP  (#1064)

# Implementation PBI description
---

In the previous PBI we documented a possible API and also created a POC
but it just allowed to query some configuration, so we have extended the
PR with the API implementation

## Implemented Network API

<details>
  <summary>Resource <b>/network/state</b></summary>
  
  - GET: get the current network state and general information 
  
  **Request example**
  
  ```json
$ curl -s localhost:3000/api/network/state -H @headers.txt | j
{
  "connectivity": true,
  "wireless_enabled": false,
  "networking_enabled": true
}
```

  - PUT: Update the current network state (currently only enabling wireless is supported)
  
  **Request example**

  ```json

$ cat state.json 
{
  "connectivity": true,
  "wireless_enabled": true,
  "networking_enabled": true
}
  
$ curl -s -X POST localhost:3000/api/network/state -H @headers.txt -H "Content-Type: application/json" -d @state.json  | jq
{
  "connectivity": true,
  "wireless_enabled": true,
  "networking_enabled": true
}
```
  
</details>
  
<details>
  <summary>Resource <b>/network/devices</b></summary>
  
  - GET: list of known devices
    - Attributes
      - Name: String
      - Type: Enum


**Request example**

```json
$ curl -s localhost:3000/network/devices -H @headers.txt | jq
[
  {
    "name": "enp2s0f0",
    "type": "Ethernet"
  },
  {
    "name": "wlp3s0",
    "type": "Wireless"
  },
  {
    "name": "eth0",
    "type": "Ethernet"
  }
 ``` 
</details>

<details>

<summary>Resource <b>/network/connections</b></summary>

  - GET: list of managed / known connections
  **Request example**
  
  ```json
$curl -s localhost:3000/api/network/connections -H @headers.txt | jq
[
  {
    "id": "lo",
    "method4": "manual",
    "method6": "manual",
    "addresses": [
      "127.0.0.1/8",
      "::1"
    ],
    "interface": "lo"
  },
  {
    "i... (continued)

Run Details

97 of 319 new or added lines in 11 files covered. (30.41%)

104 existing lines in 10 files now uncovered.

10970 of 15214 relevant lines covered (72.1%)

12.42 hits per line