Initial public release of nearby library

Signed-off-by: Alexey Polyudov <apolyudov@google.com>
Change-Id: I85d490e448375aa4eb7b09680757c02fff1420b4

cpp/platform/impl/sample/BUILD

@@ -0,0 +1,34 @@
+# Copyright 2020 Google LLC
+#
+# Licensed 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
+#
+#     https://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.
+
+cc_library(
+    name = "sample",
+    srcs = [
+        "sample_wifi_medium.cc",
+        "sample_wifi_medium.h",
+    ],
+    hdrs = ["sample_platform.h"],
+    visibility = [
+        "//googlemac/iPhone/Shared/Nearby/Connections:__subpackages__",
+        "//core:__subpackages__",
+        "//location/nearby/setup/core:__subpackages__",
+    ],
+    deps = [
+        "//platform:types",
+        "//platform:utils",
+        "//platform/api",
+        "//platform/port:string",
+        "//absl/time",
+    ],
+)

cpp/platform/impl/sample/CMakeLists.txt

@@ -0,0 +1,32 @@
+# Copyright 2020 Google LLC
+#
+# Licensed 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
+#
+#     https://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.
+
+add_library(platform_impl_sample STATIC)
+
+target_sources(platform_impl_sample
+  PRIVATE
+    sample_wifi_medium.cc
+  PUBLIC
+    sample_platform.h
+    sample_wifi_medium.h
+)
+
+target_link_libraries(platform_impl_sample
+  PUBLIC
+    absl::time
+    platform_api
+    platform_port_string
+    platform_types
+    platform_utils
+)

cpp/platform/impl/sample/sample_platform.h

@@ -0,0 +1,155 @@
+// Copyright 2020 Google LLC
+//
+// Licensed 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
+//
+//     https://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.
+
+#ifndef PLATFORM_IMPL_SAMPLE_SAMPLE_PLATFORM_H_
+#define PLATFORM_IMPL_SAMPLE_SAMPLE_PLATFORM_H_
+
+#include <cstdint>
+
+#include "platform/api/atomic_boolean.h"
+#include "platform/api/atomic_reference.h"
+#include "platform/api/ble.h"
+#include "platform/api/ble_v2.h"
+#include "platform/api/bluetooth_adapter.h"
+#include "platform/api/bluetooth_classic.h"
+#include "platform/api/condition_variable.h"
+#include "platform/api/count_down_latch.h"
+#include "platform/api/hash_utils.h"
+#include "platform/api/lock.h"
+#include "platform/api/multi_thread_executor.h"
+#include "platform/api/settable_future.h"
+#include "platform/api/single_thread_executor.h"
+#include "platform/api/system_clock.h"
+#include "platform/api/thread_utils.h"
+#include "platform/api/wifi.h"
+#include "platform/cancelable.h"
+#include "platform/impl/sample/sample_wifi_medium.h"
+#include "platform/port/string.h"
+#include "platform/ptr.h"
+#include "platform/runnable.h"
+
+namespace location {
+namespace nearby {
+namespace sample {
+
+// The SamplePlatform class below shows an example of the factory functions
+// and typedefs.
+class SamplePlatform {
+ public:
+  class SampleSubmittableExecutor
+      : public SubmittableExecutor<SampleSubmittableExecutor> {
+   public:
+    template <typename T>
+    Ptr<Future<T> > submit(Ptr<Callable<T> > callable) {
+      return Ptr<Future<T> >();
+    }
+  };
+
+  class SampleSingleThreadExecutor
+      : public SingleThreadExecutor<SampleSubmittableExecutor> {
+   public:
+    void execute(Ptr<Runnable> runnable) override {}
+    void shutdown() override {}
+  };
+
+  class SampleMultiThreadExecutor
+      : public MultiThreadExecutor<SampleSubmittableExecutor> {
+   public:
+    void execute(Ptr<Runnable> runnable) override {}
+    void shutdown() override {}
+  };
+
+  class SampleScheduledExecutor {
+   public:
+    Ptr<Cancelable> schedule(Ptr<Runnable> runnable,
+                             std::int64_t delay_millis) {
+      return Ptr<Cancelable>();
+    }
+    void shutdown() {}
+  };
+
+  typedef SampleSingleThreadExecutor SingleThreadExecutorType;
+  static Ptr<SingleThreadExecutorType> createSingleThreadExecutor() {
+    return MakePtr(new SingleThreadExecutorType());
+  }
+
+  typedef SampleMultiThreadExecutor MultiThreadExecutorType;
+  static Ptr<MultiThreadExecutorType> createMultiThreadExecutor(
+      std::int32_t max_concurrency) {
+    return MakePtr(new MultiThreadExecutorType());
+  }
+
+  typedef SampleScheduledExecutor ScheduledExecutorType;
+  static Ptr<ScheduledExecutorType> createScheduledExecutor() {
+    return MakePtr(new ScheduledExecutorType());
+  }
+
+  static Ptr<BluetoothAdapter> createBluetoothAdapter() {
+    return Ptr<BluetoothAdapter>();
+  }
+
+  static Ptr<WifiMedium> createWifiMedium() {
+    return MakePtr(new SampleWifiMedium());
+  }
+
+  static Ptr<CountDownLatch> createCountDownLatch(std::int32_t count) {
+    return Ptr<CountDownLatch>();
+  }
+
+  template <typename T>
+  static Ptr<SettableFuture<T> > createSettableFuture() {
+    return Ptr<SettableFuture<T> >();
+  }
+
+  static Ptr<ThreadUtils> createThreadUtils() { return Ptr<ThreadUtils>(); }
+
+  static Ptr<SystemClock> createSystemClock() { return Ptr<SystemClock>(); }
+
+  static Ptr<AtomicBoolean> createAtomicBoolean(bool initial_value) {
+    return Ptr<AtomicBoolean>();
+  }
+
+  template <typename T>
+  static Ptr<AtomicReference<T> > createAtomicReference(T initial_value) {
+    return Ptr<AtomicReference<T> >();
+  }
+
+  static Ptr<BluetoothClassicMedium> createBluetoothClassicMedium() {
+    return Ptr<BluetoothClassicMedium>();
+  }
+
+  static Ptr<BLEMedium> createBLEMedium() { return Ptr<BLEMedium>(); }
+
+  static Ptr<BLEMediumV2> createBLEMediumV2() { return Ptr<BLEMediumV2>(); }
+
+  static Ptr<Lock> createLock() { return Ptr<Lock>(); }
+
+  static Ptr<ConditionVariable> createConditionVariable(Ptr<Lock> lock) {
+    return Ptr<ConditionVariable>();
+  }
+
+  static Ptr<HashUtils> createHashUtils() { return Ptr<HashUtils>(); }
+
+  static std::string getDeviceId() { return ""; }
+
+  static std::string getPayloadPath(int64_t payload_id) {
+    return "/tmp/" + std::to_string(payload_id);
+  }
+};
+
+}  // namespace sample
+}  // namespace nearby
+}  // namespace location
+
+#endif  // PLATFORM_IMPL_SAMPLE_SAMPLE_PLATFORM_H_

cpp/platform/impl/sample/sample_wifi_medium.cc

@@ -0,0 +1,124 @@
+// Copyright 2020 Google LLC
+//
+// Licensed 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
+//
+//     https://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.
+
+#include "platform/impl/sample/sample_wifi_medium.h"
+
+#include <cstdint>
+
+#include "platform/prng.h"
+#include "absl/time/clock.h"
+#include "absl/time/time.h"
+
+namespace location {
+namespace nearby {
+namespace sample {
+
+namespace {
+
+const char* kOpenSSID = "__OPEN__";
+const char* kWpaPskSSID = "__WPA_PSK__";
+const char* kWepSSID = "__WEP__";
+const char* kNoInternetConnectivitySSID = "__NO_INTERNET_CONNECTIVITY__";
+const char* kConnectionFailureSSID = "__CONNECTION_FAILURE__";
+const char* kAuthFailureSSID = "__AUTH_FAILURE__";
+
+std::uint32_t boundedUInt32(std::uint32_t upper_limit) {
+  return Prng().nextUInt32() % (upper_limit + 1);
+}
+
+void randomSleep(std::uint32_t upper_limit_millis) {
+  absl::SleepFor(absl::Milliseconds(boundedUInt32(upper_limit_millis)));
+}
+
+}  // namespace
+
+std::vector<SampleWifiScanResult> SampleWifiMedium::canned_scan_results_;
+
+SampleWifiMedium::SampleWifiMedium() : current_ssid_() {
+  // One-time initialization of our static canned_scan_results_.
+  if (canned_scan_results_.empty()) {
+    canned_scan_results_.push_back(
+        SampleWifiScanResult(kOpenSSID, 1, 2401, WifiAuthType::OPEN));
+    canned_scan_results_.push_back(
+        SampleWifiScanResult(kWpaPskSSID, 2, 5002, WifiAuthType::WPA_PSK));
+    canned_scan_results_.push_back(
+        SampleWifiScanResult(kWepSSID, 3, 2403, WifiAuthType::WEP));
+    canned_scan_results_.push_back(SampleWifiScanResult(
+        kNoInternetConnectivitySSID, 4, 5004, WifiAuthType::OPEN));
+    canned_scan_results_.push_back(SampleWifiScanResult(
+        kConnectionFailureSSID, 5, 2405, WifiAuthType::OPEN));
+    canned_scan_results_.push_back(
+        SampleWifiScanResult(kAuthFailureSSID, 6, 5006, WifiAuthType::OPEN));
+  }
+}
+
+SampleWifiMedium::~SampleWifiMedium() {}
+
+bool SampleWifiMedium::scan(
+    Ptr<WifiMedium::ScanResultCallback> scan_result_callback) {
+  // Sleep for up to 10 seconds, to simulate performing an actual Wifi scan.
+  randomSleep(10 * 1000);
+
+  // Construct the response.
+  std::vector<ConstPtr<WifiScanResult> > scan_results;
+  for (std::vector<SampleWifiScanResult>::const_iterator it =
+           canned_scan_results_.begin();
+       it != canned_scan_results_.end(); it++) {
+    scan_results.push_back(ConstPtr<WifiScanResult>(
+        new SampleWifiScanResult(it->getSSID(), it->getSignalStrengthDbm(),
+                                 it->getFrequencyMhz(), it->getAuthType())));
+  }
+
+  // And report it back.
+  scan_result_callback->onScanResults(scan_results);
+
+  return false;
+}
+
+WifiConnectionStatus::Value SampleWifiMedium::connectToNetwork(
+    const std::string& ssid, const std::string& password,
+    WifiAuthType::Value auth_type) {
+  // Sleep for up to 10 seconds, to simulate actually connecting to the SSID.
+  randomSleep(10 * 1000);
+
+  if (kConnectionFailureSSID == ssid) {
+    return WifiConnectionStatus::CONNECTION_FAILURE;
+  }
+
+  if (kAuthFailureSSID == ssid) {
+    return WifiConnectionStatus::AUTH_FAILURE;
+  }
+
+  return WifiConnectionStatus::CONNECTED;
+}
+
+bool SampleWifiMedium::verifyInternetConnectivity() {
+  if (current_ssid_.empty()) {
+    return false;
+  }
+
+  // Sleep for up to 5 seconds, to simulate actually verifying internet
+  // connectivity.
+  randomSleep(5 * 1000);
+
+  return current_ssid_ != kNoInternetConnectivitySSID;
+}
+
+std::string SampleWifiMedium::getIPAddress() {
+  return current_ssid_.empty() ? "" : "1.2.3.4";
+}
+
+}  // namespace sample
+}  // namespace nearby
+}  // namespace location

cpp/platform/impl/sample/sample_wifi_medium.h

@@ -0,0 +1,73 @@
+// Copyright 2020 Google LLC
+//
+// Licensed 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
+//
+//     https://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.
+
+#ifndef PLATFORM_IMPL_SAMPLE_SAMPLE_WIFI_MEDIUM_H_
+#define PLATFORM_IMPL_SAMPLE_SAMPLE_WIFI_MEDIUM_H_
+
+#include "platform/api/wifi.h"
+
+namespace location {
+namespace nearby {
+namespace sample {
+
+class SampleWifiScanResult : public WifiScanResult {
+ public:
+  SampleWifiScanResult(const std::string& ssid,
+                       std::int32_t signal_strength_dbm,
+                       std::int32_t frequency_mhz,
+                       WifiAuthType::Value auth_type)
+      : ssid_(ssid),
+        signal_strength_dbm_(signal_strength_dbm),
+        frequency_mhz_(frequency_mhz),
+        auth_type_(auth_type) {}
+  ~SampleWifiScanResult() override {}
+
+  std::string getSSID() const override { return ssid_; }
+  std::int32_t getSignalStrengthDbm() const override {
+    return signal_strength_dbm_;
+  }
+  std::int32_t getFrequencyMhz() const override { return frequency_mhz_; }
+  WifiAuthType::Value getAuthType() const override { return auth_type_; }
+
+ private:
+  const std::string ssid_;
+  const std::int32_t signal_strength_dbm_;
+  const std::int32_t frequency_mhz_;
+  const WifiAuthType::Value auth_type_;
+};
+
+class SampleWifiMedium : public WifiMedium {
+ public:
+  SampleWifiMedium();
+  ~SampleWifiMedium() override;
+
+  bool scan(Ptr<ScanResultCallback> scan_result_callback) override;
+  WifiConnectionStatus::Value connectToNetwork(
+      const std::string& ssid, const std::string& password,
+      WifiAuthType::Value auth_type) override;
+  bool verifyInternetConnectivity() override;
+  std::string getIPAddress() override;
+
+ private:
+  static std::vector<SampleWifiScanResult> canned_scan_results_;
+
+  // The SSID this Wifi stack is currently connected to; empty string if none.
+  std::string current_ssid_;
+};
+
+}  // namespace sample
+}  // namespace nearby
+}  // namespace location
+
+#endif  // PLATFORM_IMPL_SAMPLE_SAMPLE_WIFI_MEDIUM_H_