Integration test to load the default example of the default SDK and c…

…hange the example (apache#24731) * Integration test to load the default example of the default SDK and change the example (apache#24730) (apache#24729) * Fix formatting and README (apache#24730) * Support collection v1.17.0 (apache#24730) * LoadingIndicator on chaning examples, remove duplicating licenses (apache#24730) * Add a missing license header (apache#24730) * Integration test for changing SDK and running code (apache#24779) (apache#382) * Integration test for changing SDK and running code (apache#24779) * Rename an integration test (apache#24779) * Use enum to switch SDK in integration test (apache#24779) * Find SDK in a dropdown by key (apache#24779) * Add a TODO (apache#24779) * Fix exports (apache#24779) * Issue24779 integration changing sdk from 24370 (apache#387) * Integration test for changing SDK and running code (apache#24779) * Rename an integration test (apache#24779) * Use enum to switch SDK in integration test (apache#24779) * Find SDK in a dropdown by key (apache#24779) * Add a TODO (apache#24779) * Fix exports (apache#24779) * Integration tests miscellaneous UI (apache#383) * miscellaneous ui integration tests * reverted pubspec.lock * gradle tasks ordered alhpabetically * integration tests refactoring * clean code * integration tests miscellaneous ui fix pr * rename method * added layout adaptivity * A minor cleanup (apache#24779) Co-authored-by: Dmitry Repin <[email protected]> Co-authored-by: Dmitry Repin <[email protected]>
twosom · Jan 6, 2023 · f9d30c3 · f9d30c3
1 parent e724425
commit f9d30c3
Show file tree

Hide file tree

Showing 63 changed files with 1,749 additions and 717 deletions.
diff --git a/.gitignore b/.gitignore
@@ -127,6 +127,7 @@ website/www/yarn-error.log
 **/.packages
 **/generated_plugin_registrant.dart
 playground/frontend/playground_components/pubspec.lock
+playground/frontend/playground_components_dev/pubspec.lock
 
 # Ignore Beam Playground Terraform
 **/.terraform

diff --git a/learning/tour-of-beam/frontend/pubspec.yaml b/learning/tour-of-beam/frontend/pubspec.yaml
@@ -27,7 +27,7 @@ environment:
   flutter: '>=3.3.2'
 
 dependencies:
-  app_state: ^0.8.1
+  app_state: ^0.8.4
   collection: ^1.16.0
   easy_localization: ^3.0.1
   easy_localization_ext: ^0.1.0

diff --git a/playground/frontend/README.md b/playground/frontend/README.md
@@ -141,6 +141,37 @@ Code can be automatically reformatted using:
 flutter format ./lib
 ```
 
+### Unit Tests
+
+To delete all generated files and re-generate them again and then run tests:
+
+```bash
+./gradlew :playground:frontend:playground_components_test
+./gradlew :playground:frontend:test
+```
+
+To run tests without re-generating files:
+
+```bash
+cd playground/frontend/playground_components
+flutter test
+cd ..
+flutter test
+```
+
+### Integration Tests
+
+Integration tests currently can be run only on a local development machine.
+Server testing has not been verified yet.
+
+1. Install and run Chrome Driver: https://chromedriver.chromium.org/downloads
+2. Run it on port 4444: `chromedriver --port=4444`
+3. Run:
+
+```bash
+./gradlew :playground:frontend:integrationTest
+```
+
 ## Localization
 
 The project is in the process of migrating from

diff --git a/playground/frontend/build.gradle b/playground/frontend/build.gradle
@@ -17,18 +17,11 @@
  */
 
 
-apply plugin: 'org.apache.beam.module'
-apply plugin: 'base'
+apply(plugin: "org.apache.beam.module")
+apply(plugin: "base")
 applyDockerNature()
 
-def playgroundBackendUrl = project.playgroundBackendUrl
-def analyticsUA = project.analyticsUA
-def playgroundBackendJavaRouteUrl = project.playgroundBackendJavaRouteUrl
-def playgroundBackendGoRouteUrl = project.playgroundBackendGoRouteUrl
-def playgroundBackendPythonRouteUrl = project.playgroundBackendPythonRouteUrl
-def playgroundBackendScioRouteUrl = project.playgroundBackendScioRouteUrl
-
-def playgroundJobServerProject = "${project.path.replace('-container', '')}"
+def playgroundJobServerProject = "${project.path.replace("-container", "")}"
 
 description = project(playgroundJobServerProject).description + " :: Container"
 
@@ -37,10 +30,10 @@ configurations {
 }
 
 dependencies {
-  dockerDependency project(path: playgroundJobServerProject, configuration: "shadow")
+  dockerDependency(project(path: playgroundJobServerProject, configuration: "shadow"))
 }
 
-task generate {
+tasks.register("generate") {
   dependsOn("playground_components:generate")
 
   dependsOn("generateCode")
@@ -49,7 +42,7 @@ task generate {
   description = "Generates all generated files."
 }
 
-task printPath {
+tasks.register("printPath") {
   doLast {
     exec {
       executable("printenv")
@@ -58,7 +51,7 @@ task printPath {
   }
 }
 
-task analyze  {
+tasks.register("analyze") {
   dependsOn("playground_components:generateCode")
   dependsOn("generateCode")
 
@@ -74,7 +67,7 @@ task analyze  {
   }
 }
 
-task pubGet {
+tasks.register("pubGet") {
   group = "build"
   description = "Get packages for the playground frontend project"
   doLast {
@@ -85,7 +78,7 @@ task pubGet {
   }
 }
 
-task format {
+tasks.register("format") {
   group = "build"
   description = "Idiomatically format Dart source code"
   doLast {
@@ -97,9 +90,10 @@ task format {
   }
 }
 
-task run {
+tasks.register("run") {
   group = "application"
   description = "Run application on Google Chrome"
+
   doLast {
     exec {
       executable("flutter")
@@ -108,7 +102,7 @@ task run {
   }
 }
 
-task test {
+tasks.register("test") {
   dependsOn("playground_components:generateCode")
   dependsOn("generateCode")
 
@@ -123,14 +117,14 @@ task test {
   }
 }
 
-task precommit {
+tasks.register("precommit") {
   dependsOn("playground_components:precommit")
 
   dependsOn("analyze")
   dependsOn("test")
 }
 
-task generateCode {
+tasks.register("generateCode") {
   dependsOn("playground_components:generateCode")
 
   dependsOn("cleanFlutter")
@@ -147,7 +141,7 @@ task generateCode {
   }
 }
 
-task cleanFlutter {
+tasks.register("cleanFlutter") {
   group = "build"
   description = "Remove build artifacts"
 
@@ -159,7 +153,7 @@ task cleanFlutter {
   }
 }
 
-task cleanGenerated {
+tasks.register("cleanGenerated") {
   dependsOn("playground_components:cleanGenerated")
 
   group = "build"
@@ -188,75 +182,59 @@ ext.deleteFilesByRegExp = { re ->
   }
 }
 
+tasks.register("integrationTest") {
+  dependsOn("integrationTest_standalone_change_example_sdk_run")
+  dependsOn("integrationTest_standalone_miscellaneous_ui")
+}
+
+tasks.register("integrationTest_standalone_change_example_sdk_run") {
+  runIntegrationTest("standalone_change_example_sdk_run", "/")
+}
+
+tasks.register("integrationTest_standalone_miscellaneous_ui") {
+  runIntegrationTest("standalone_miscellaneous_ui", "/")
+}
+
+void runIntegrationTest(String path, String url) {
+  exec {
+    executable("flutter")
+    args(
+      "drive",
+      "--driver=test_driver/integration_test.dart",
+      "--target=integration_test/${path}_test.dart",
+      "--web-launch-url='$url'",
+      "--device-id=chrome",
+    )
+  }
+}
+
 task copyDockerfileDependencies(type: Copy) {
    group = "build"
    description = "Copy files that required to build docker container"
    copy {
-      from '.'
-      into 'build/'
-      exclude 'build'
-      exclude 'Dockerfile'
+      from(".")
+      into("build/")
+      exclude("build")
+      exclude("Dockerfile")
    }
    copy {
-      from '../playground'
-      into 'build/playground'
+      from("../playground")
+      into("build/playground")
    }
 }
 
 docker {
   group = "build"
   description = "Build container for playground frontend application"
-  name containerImageName(
-          name: project.docker_image_default_repo_prefix + "playground-frontend",
-          root: project.rootProject.hasProperty(["docker-repository-root"]) ?
-                  project.rootProject["docker-repository-root"] :
-                  project.docker_image_default_repo_root)
-  files "./build/"
-  tags containerImageTags()
-  buildArgs(['FLUTTER_VERSION': project.rootProject.hasProperty(["flutter-version"]) ?
-                                project.rootProject["flutter-version"] :
-                                "3.3.2" ])
+  name = containerImageName(
+    name: project.docker_image_default_repo_prefix + "playground-frontend",
+    root: project.rootProject.hasProperty(["docker-repository-root"])
+            ? project.rootProject["docker-repository-root"]
+            : project.docker_image_default_repo_root
+  )
+  files("./build/")
+  tags(containerImageTags())
 }
 
 // Ensure that we build the required resources and copy and file dependencies from related projects
-dockerPrepare.dependsOn copyDockerfileDependencies
-
-task("createConfig") {
-  group = "build"
-  description = "Generate config for the playground frontend project"
-  doLast {
-    def configFileName = "config.g.dart"
-    def modulePath = project(":playground:frontend").projectDir.absolutePath
-    def file = new File(modulePath + "/lib", configFileName)
-    file.write("""/*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements.  See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership.  The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License.  You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-const String kApiClientURL =
-    '${playgroundBackendUrl}';
-const String kAnalyticsUA = '${analyticsUA}';
-const String kApiJavaClientURL =
-    '${playgroundBackendJavaRouteUrl}';
-const String kApiGoClientURL =
-    '${playgroundBackendGoRouteUrl}';
-const String kApiPythonClientURL =
-    '${playgroundBackendPythonRouteUrl}';
-const String kApiScioClientURL =
-    '${playgroundBackendScioRouteUrl}';
-""")
-  }
-}
+dockerPrepare.dependsOn(copyDockerfileDependencies)
diff --git a/playground/frontend/integration_test/common/common.dart b/playground/frontend/integration_test/common/common.dart
@@ -0,0 +1,39 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import 'package:flutter_test/flutter_test.dart';
+import 'package:playground/main.dart' as app;
+
+Future<void> init(WidgetTester wt) async {
+  app.main();
+  await wt.pumpAndSettle();
+}
+
+void expectHasDescendant(Finder ancestor, Finder descendant) {
+  expect(
+    find.descendant(of: ancestor, matching: descendant),
+    findsOneWidget,
+  );
+}
+
+void expectSimilar(double a, double b) {
+  Matcher closeToFraction(num value, double fraction) =>
+      closeTo(value, value * fraction);
+  Matcher onePerCentTolerance(num value) => closeToFraction(value, 0.01);
+  expect(a, onePerCentTolerance(b));
+}