[inspect][flutter] reorg fuchsia_inspect_flutter
- Remove unused dependencies
- Remove invalid build targets
- Restructure directories like other libraries
- Rename functions and classes
Change-Id: I60897ff9051af6fc9ac305b19c3360c190dd72fb
diff --git a/packages/examples/BUILD.gn b/packages/examples/BUILD.gn
index ebae14a..8d6f67d 100644
--- a/packages/examples/BUILD.gn
+++ b/packages/examples/BUILD.gn
@@ -70,8 +70,6 @@
"//topaz/public/dart/fuchsia_inspect/examples/torus15:torus15_dart_test",
"//topaz/public/dart/fuchsia_inspect/test/inspect_flutter_integration_tester",
"//topaz/public/dart/fuchsia_inspect/test/inspect_flutter_integration_tester:inspect_dart_integration_test_driver",
- "//topaz/public/dart/fuchsia_inspect_flutter",
- "//topaz/public/dart/fuchsia_inspect_flutter:fuchsia_flutter_test",
"//topaz/public/dart/fuchsia_modular/examples/slider_mod",
"//topaz/public/dart/fuchsia_modular/examples/slider_mod:slider_mod_tests",
]
diff --git a/packages/tests/BUILD.gn b/packages/tests/BUILD.gn
index d75b3fd..c0cf75b 100644
--- a/packages/tests/BUILD.gn
+++ b/packages/tests/BUILD.gn
@@ -24,7 +24,7 @@
"//topaz/public/dart/composition_delegate:composition_delegate_tests($host_toolchain)",
"//topaz/public/dart/fuchsia_inspect:fuchsia_inspect_package_unittests($host_toolchain)",
"//topaz/public/dart/fuchsia_inspect/examples/torus15:torus15_flutter_test($host_toolchain)",
- "//topaz/public/dart/fuchsia_inspect_flutter:fuchsia_flutter_test($host_toolchain)",
+ "//topaz/public/dart/fuchsia_inspect_flutter:inspect_flutter_test($host_toolchain)",
"//topaz/public/dart/fuchsia_logger:fuchsia_logger_package_unittests($host_toolchain)",
"//topaz/public/dart/fuchsia_modular:fuchsia_modular_package_unittests($host_toolchain)",
"//topaz/public/dart/fuchsia_modular_flutter:fuchsia_modular_flutter_unittests($host_toolchain)",
diff --git a/public/dart/fuchsia_inspect_flutter/BUILD.gn b/public/dart/fuchsia_inspect_flutter/BUILD.gn
index ecf6977..e8c382e 100644
--- a/public/dart/fuchsia_inspect_flutter/BUILD.gn
+++ b/public/dart/fuchsia_inspect_flutter/BUILD.gn
@@ -3,11 +3,8 @@
# found in the LICENSE file.
import("//build/dart/dart_library.gni")
-import("//build/dart/test.gni")
import("//build/testing/environments.gni")
-import("//topaz/runtime/dart/dart_fuchsia_test.gni")
import("//topaz/runtime/dart/flutter_test.gni")
-import("//topaz/runtime/flutter_runner/flutter_app.gni")
dart_library("fuchsia_inspect_flutter") {
package_name = "fuchsia_inspect_flutter"
@@ -15,20 +12,20 @@
sdk_category = "partner"
sources = [
- "WidgetTreeTraversal.dart",
+ "inspect_flutter.dart",
+ "src/inspect_flutter.dart",
]
deps = [
"//third_party/dart-pkg/git/flutter/packages/flutter",
"//topaz/public/dart/fuchsia_inspect",
- "//topaz/public/dart/fuchsia_modular",
]
}
-flutter_test("fuchsia_flutter_test") {
+flutter_test("inspect_flutter_test") {
source_dir = "test"
sources = [
- "fuchsia_flutter_test.dart",
+ "inspect_flutter_test.dart",
]
deps = [
@@ -36,6 +33,5 @@
"//third_party/dart-pkg/git/flutter/packages/flutter_test",
"//topaz/public/dart/fuchsia_inspect/examples/inspect_mod:test_vmo_reader",
"//topaz/public/dart/fuchsia_services",
- "//topaz/public/dart/zircon",
]
}
diff --git a/public/dart/fuchsia_inspect_flutter/README.md b/public/dart/fuchsia_inspect_flutter/README.md
index 12eed4e..2e3c91d 100644
--- a/public/dart/fuchsia_inspect_flutter/README.md
+++ b/public/dart/fuchsia_inspect_flutter/README.md
@@ -23,11 +23,11 @@
directory. The tests can be run using
```
-$ fx run-host-tests fuchsia_flutter_test
+$ fx run-host-tests inspect_flutter_test
```
## Source layout
-The main implementation is in `lib/WidgetTreeTraversal.dart`, which also
-includes unit tests in the test folder one directory up.
+The main implementation is in `lib/src/inspect_flutter.dart`, which also
+has unit tests in `test/`.
diff --git a/public/dart/fuchsia_inspect_flutter/lib/inspect_flutter.dart b/public/dart/fuchsia_inspect_flutter/lib/inspect_flutter.dart
new file mode 100644
index 0000000..42440bf
--- /dev/null
+++ b/public/dart/fuchsia_inspect_flutter/lib/inspect_flutter.dart
@@ -0,0 +1,7 @@
+// Copyright 2019 The Fuchsia Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+/// The Inspect_Flutter API for Dart.
+export 'src/inspect_flutter.dart'
+ show InspectFlutter;
diff --git a/public/dart/fuchsia_inspect_flutter/lib/WidgetTreeTraversal.dart b/public/dart/fuchsia_inspect_flutter/lib/src/inspect_flutter.dart
similarity index 97%
rename from public/dart/fuchsia_inspect_flutter/lib/WidgetTreeTraversal.dart
rename to public/dart/fuchsia_inspect_flutter/lib/src/inspect_flutter.dart
index 17482bf..2059391 100644
--- a/public/dart/fuchsia_inspect_flutter/lib/WidgetTreeTraversal.dart
+++ b/public/dart/fuchsia_inspect_flutter/lib/src/inspect_flutter.dart
@@ -7,11 +7,12 @@
/// This class provides methods to convert from Flutter DiagnosticsNodes to
/// Inspect format nodes.
-class WidgetTreeTraversal {
+class InspectFlutter {
/// Converts an diagnostics tree into a Node tree
/// Creates a Node with Inspect data based on what
/// information was in the DiagnosticsNode and attaches
/// it to the parent
+ @visibleForTesting
static void inspectFromDiagnostic(DiagnosticsNode diagnostics, Node parent) {
/// Finds the name of the widget and assigns it to the name of the node.
String name = '';
diff --git a/public/dart/fuchsia_inspect_flutter/meta/fuchsia_flutter_test.cmx b/public/dart/fuchsia_inspect_flutter/meta/fuchsia_flutter_test.cmx
deleted file mode 100644
index f86f28a..0000000
--- a/public/dart/fuchsia_inspect_flutter/meta/fuchsia_flutter_test.cmx
+++ /dev/null
@@ -1,21 +0,0 @@
-{
- "program": {
- "data": "data/fuchsia_flutter_test"
- },
- "sandbox": {
- "services": [
- "fuchsia.cobalt.LoggerFactory",
- "fuchsia.fonts.Provider",
- "fuchsia.logger.LogSink",
- "fuchsia.modular.Clipboard",
- "fuchsia.modular.ContextWriter",
- "fuchsia.modular.ModuleContext",
- "fuchsia.netstack.Netstack",
- "fuchsia.sys.Environment",
- "fuchsia.ui.input.ImeService",
- "fuchsia.ui.policy.Presenter",
- "fuchsia.ui.scenic.Scenic",
- "fuchsia.wlan.service.Wlan"
- ]
- }
-}
diff --git a/public/dart/fuchsia_inspect_flutter/test/fuchsia_flutter_test.dart b/public/dart/fuchsia_inspect_flutter/test/inspect_flutter_test.dart
similarity index 91%
rename from public/dart/fuchsia_inspect_flutter/test/fuchsia_flutter_test.dart
rename to public/dart/fuchsia_inspect_flutter/test/inspect_flutter_test.dart
index f63559d..06313a8 100644
--- a/public/dart/fuchsia_inspect_flutter/test/fuchsia_flutter_test.dart
+++ b/public/dart/fuchsia_inspect_flutter/test/inspect_flutter_test.dart
@@ -5,8 +5,7 @@
// ignore_for_file: implementation_imports
import 'package:test/test.dart';
-import 'package:fuchsia_inspect_flutter/WidgetTreeTraversal.dart';
-import 'package:flutter/material.dart';
+import 'package:fuchsia_inspect_flutter/src/inspect_flutter.dart';
import 'package:flutter/foundation.dart';
import 'package:fuchsia_inspect/inspect.dart';
import 'package:test_vmo_reader/vmo_reader.dart' show VmoReader;
@@ -16,7 +15,7 @@
import 'package:fuchsia_services/services.dart';
import 'package:test_vmo_reader/util.dart';
-// This class was made to test the WidgetTreeTraversal class
+// This class was made to test the InspectFlutter class
// The FakeDiagnosticsNode allows properties and children
// to be added to the node.
class FakeDiagnosticsNode extends DiagnosticsNode {
@@ -78,7 +77,7 @@
..addProperty('prop3', 'value3')
..addChild('widget', 'node2')
..children[0].addProperty('widget', 'node2'));
- WidgetTreeTraversal.inspectFromDiagnostic(fakeNode, root);
+ InspectFlutter.inspectFromDiagnostic(fakeNode, root);
expect(VmoReader(vmo).toString(), matches(RegExp(
r'<> Node: "root"\n'
r'<> >> Node: "node1_\d+"\n'
@@ -98,7 +97,7 @@
..addProperty('prop2', 'value2')
..addProperty('prop3', 'value3')
..addProperty(null, null));
- WidgetTreeTraversal.inspectFromDiagnostic(fakeNode, root);
+ InspectFlutter.inspectFromDiagnostic(fakeNode, root);
expect(VmoReader(vmo).toString(), matches(RegExp(
r'<> Node: "root"\n'
r'<> >> Node: "node1_\d+"\n'
@@ -115,7 +114,7 @@
..addProperty('prop1', 'value1')
..addProperty('prop2', 'value2')
..addProperty('prop3', 'value3'));
- WidgetTreeTraversal.inspectFromDiagnostic(fakeNode, root);
+ InspectFlutter.inspectFromDiagnostic(fakeNode, root);
expect(VmoReader(vmo).toString(),(
'<> Node: "root"\n'
''