Thomas Vachuska | 5c2f813 | 2015-04-08 23:09:08 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Thomas Vachuska | 5c2f813 | 2015-04-08 23:09:08 -0700 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.cli.net; |
| 17 | |
Andrea Campanella | e6e2b76 | 2017-02-22 21:55:53 +0100 | [diff] [blame] | 18 | import com.fasterxml.jackson.databind.node.ArrayNode; |
| 19 | import com.google.common.collect.ImmutableList; |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame^] | 20 | import org.apache.karaf.shell.api.action.Argument; |
| 21 | import org.apache.karaf.shell.api.action.Command; |
| 22 | import org.apache.karaf.shell.api.action.lifecycle.Service; |
| 23 | import org.apache.karaf.shell.api.action.Option; |
Andrea Campanella | e6e2b76 | 2017-02-22 21:55:53 +0100 | [diff] [blame] | 24 | import org.onosproject.cli.AbstractShellCommand; |
| 25 | import org.onosproject.net.driver.Behaviour; |
| 26 | import org.onosproject.net.driver.Driver; |
Thomas Vachuska | 11b99fc | 2017-04-27 12:51:04 -0700 | [diff] [blame] | 27 | import org.onosproject.net.driver.DriverService; |
Andrea Campanella | e6e2b76 | 2017-02-22 21:55:53 +0100 | [diff] [blame] | 28 | |
Yuta HIGUCHI | 4a6852e | 2017-10-27 17:15:39 -0700 | [diff] [blame] | 29 | import java.util.Comparator; |
Yuta HIGUCHI | 0083a51 | 2017-02-21 12:14:38 -0800 | [diff] [blame] | 30 | import java.util.List; |
| 31 | import java.util.Optional; |
Ray Milkey | 39616f3 | 2015-05-14 15:43:00 -0700 | [diff] [blame] | 32 | import java.util.Set; |
Yuta HIGUCHI | 0083a51 | 2017-02-21 12:14:38 -0800 | [diff] [blame] | 33 | import java.util.stream.Collectors; |
Ray Milkey | 39616f3 | 2015-05-14 15:43:00 -0700 | [diff] [blame] | 34 | |
Thomas Vachuska | 5c2f813 | 2015-04-08 23:09:08 -0700 | [diff] [blame] | 35 | /** |
| 36 | * Lists device drivers. |
| 37 | */ |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame^] | 38 | @Service |
Thomas Vachuska | 5c2f813 | 2015-04-08 23:09:08 -0700 | [diff] [blame] | 39 | @Command(scope = "onos", name = "drivers", |
| 40 | description = "Lists device drivers") |
| 41 | public class DriversListCommand extends AbstractShellCommand { |
| 42 | |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 43 | private static final String FMT = "driver=%s, extends=%s, mfr=%s, hw=%s, sw=%s"; |
Thomas Vachuska | 5c2f813 | 2015-04-08 23:09:08 -0700 | [diff] [blame] | 44 | private static final String FMT_B = " %s via %s"; |
| 45 | private static final String FMT_P = " %s=%s"; |
| 46 | |
| 47 | @Argument(index = 0, name = "driverName", description = "Driver name", |
| 48 | required = false, multiValued = false) |
| 49 | String driverName = null; |
| 50 | |
Yuta HIGUCHI | 4a6852e | 2017-10-27 17:15:39 -0700 | [diff] [blame] | 51 | @Option(name = "-s", aliases = "--sort", description = "Sort output by driver name", |
| 52 | required = false, multiValued = false) |
| 53 | private boolean sort = false; |
| 54 | |
| 55 | @Option(name = "-n", aliases = "--name", description = "Show driver name only", |
| 56 | required = false, multiValued = false) |
| 57 | private boolean nameOnly = false; |
| 58 | |
Thomas Vachuska | 5c2f813 | 2015-04-08 23:09:08 -0700 | [diff] [blame] | 59 | @Override |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame^] | 60 | protected void doExecute() { |
Thomas Vachuska | 11b99fc | 2017-04-27 12:51:04 -0700 | [diff] [blame] | 61 | DriverService service = get(DriverService.class); |
Thomas Vachuska | 5c2f813 | 2015-04-08 23:09:08 -0700 | [diff] [blame] | 62 | |
| 63 | if (driverName != null) { |
Andrea Campanella | 45f4d3d | 2017-02-23 14:45:21 +0100 | [diff] [blame] | 64 | printDriver(service.getDriver(driverName), true); |
Thomas Vachuska | 5c2f813 | 2015-04-08 23:09:08 -0700 | [diff] [blame] | 65 | } else { |
Ray Milkey | 39616f3 | 2015-05-14 15:43:00 -0700 | [diff] [blame] | 66 | if (outputJson()) { |
| 67 | json(service.getDrivers()); |
| 68 | } else { |
Yuta HIGUCHI | 4a6852e | 2017-10-27 17:15:39 -0700 | [diff] [blame] | 69 | service.getDrivers() |
| 70 | .stream() |
| 71 | .sorted(Comparator.comparing(Driver::name)) |
| 72 | .forEach(d -> printDriver(d, true)); |
Ray Milkey | 39616f3 | 2015-05-14 15:43:00 -0700 | [diff] [blame] | 73 | } |
Thomas Vachuska | 5c2f813 | 2015-04-08 23:09:08 -0700 | [diff] [blame] | 74 | } |
| 75 | } |
| 76 | |
Ray Milkey | 39616f3 | 2015-05-14 15:43:00 -0700 | [diff] [blame] | 77 | private void json(Driver driver) { |
| 78 | print("%s", jsonForEntity(driver, Driver.class)); |
| 79 | } |
| 80 | |
| 81 | private void json(Set<Driver> drivers) { |
| 82 | ArrayNode result = mapper().createArrayNode(); |
| 83 | drivers.forEach(driver -> result.add(jsonForEntity(driver, Driver.class))); |
| 84 | print("%s", result.toString()); |
| 85 | } |
| 86 | |
Andrea Campanella | 45f4d3d | 2017-02-23 14:45:21 +0100 | [diff] [blame] | 87 | private void printDriver(Driver driver, boolean first) { |
Ray Milkey | 39616f3 | 2015-05-14 15:43:00 -0700 | [diff] [blame] | 88 | if (outputJson()) { |
| 89 | json(driver); |
Yuta HIGUCHI | 4a6852e | 2017-10-27 17:15:39 -0700 | [diff] [blame] | 90 | } else if (nameOnly) { |
| 91 | print("%s", driver.name()); |
Yuta HIGUCHI | 0083a51 | 2017-02-21 12:14:38 -0800 | [diff] [blame] | 92 | } else { |
Andrea Campanella | e6e2b76 | 2017-02-22 21:55:53 +0100 | [diff] [blame] | 93 | List<Driver> parents = Optional.ofNullable(driver.parents()) |
| 94 | .orElse(ImmutableList.of()); |
Yuta HIGUCHI | 0083a51 | 2017-02-21 12:14:38 -0800 | [diff] [blame] | 95 | |
Andrea Campanella | e6e2b76 | 2017-02-22 21:55:53 +0100 | [diff] [blame] | 96 | List<String> parentsNames = parents.stream() |
| 97 | .map(Driver::name).collect(Collectors.toList()); |
| 98 | |
Andrea Campanella | 45f4d3d | 2017-02-23 14:45:21 +0100 | [diff] [blame] | 99 | if (first) { |
| 100 | print(FMT, driver.name(), parentsNames, |
| 101 | driver.manufacturer(), driver.hwVersion(), driver.swVersion()); |
| 102 | } else { |
| 103 | print(" Inherited from %s", driver.name()); |
| 104 | } |
| 105 | |
Andrea Campanella | e6e2b76 | 2017-02-22 21:55:53 +0100 | [diff] [blame] | 106 | driver.behaviours().forEach(b -> printBehaviour(b, driver)); |
Charles Chan | a59f9b76 | 2017-07-30 18:09:44 -0700 | [diff] [blame] | 107 | driver.properties().forEach((k, v) -> print(FMT_P, k, v)); |
| 108 | |
Andrea Campanella | 45f4d3d | 2017-02-23 14:45:21 +0100 | [diff] [blame] | 109 | //recursion call to print each parent |
| 110 | parents.stream().forEach(parent -> printDriver(parent, false)); |
Ray Milkey | 39616f3 | 2015-05-14 15:43:00 -0700 | [diff] [blame] | 111 | } |
Thomas Vachuska | 5c2f813 | 2015-04-08 23:09:08 -0700 | [diff] [blame] | 112 | } |
| 113 | |
Andrea Campanella | e6e2b76 | 2017-02-22 21:55:53 +0100 | [diff] [blame] | 114 | private void printBehaviour(Class<? extends Behaviour> behaviour, Driver driver) { |
| 115 | print(FMT_B, behaviour.getCanonicalName(), |
| 116 | driver.implementation(behaviour).getCanonicalName()); |
| 117 | } |
| 118 | |
Thomas Vachuska | 5c2f813 | 2015-04-08 23:09:08 -0700 | [diff] [blame] | 119 | } |