terriajs/test/Models/Catalog/CatalogItems/OpenStreetMapCatalogItemSpec.ts

Geospatial data visualization platform.

import { configure, runInAction } from "mobx";
import WebMercatorTilingScheme from "terriajs-cesium/Source/Core/WebMercatorTilingScheme";
import UrlTemplateImageryProvider from "terriajs-cesium/Source/Scene/UrlTemplateImageryProvider";
import { ImageryParts } from "../../../../lib/ModelMixins/MappableMixin";
import OpenStreetMapCatalogItem from "../../../../lib/Models/Catalog/CatalogItems/OpenStreetMapCatalogItem";
import Terria from "../../../../lib/Models/Terria";

configure({
  enforceActions: "observed",
  computedRequiresReaction: true
});

describe("OpenStreetMapCatalogItem", function () {
  const testUrl = "https://example.com/ooo/";
  let item: OpenStreetMapCatalogItem;

  beforeEach(function () {
    item = new OpenStreetMapCatalogItem("test", new Terria());
  });

  it("has a type", function () {
    expect(OpenStreetMapCatalogItem.type).toBe("open-street-map");
  });

  describe("templateUrl", function () {
    it("has placeholders for tile coordinates", function () {
      runInAction(() => item.setTrait("definition", "url", testUrl));
      expect(item.templateUrl).toBe("https://example.com/ooo/{z}/{x}/{y}.png");
    });

    it("has placeholder for subdomains", function () {
      runInAction(() => {
        item.setTrait("definition", "url", testUrl);
        item.setTrait("definition", "subdomains", ["a", "b"]);
      });

      expect(item.templateUrl).toBe(
        "https://{s}.example.com/ooo/{z}/{x}/{y}.png"
      );
    });
  });

  describe("after loading", function () {
    beforeEach(async function () {
      runInAction(() => {
        item.setTrait("definition", "url", testUrl);
      });
      return item.loadMapItems();
    });

    it("returns exactly 1 mapItem", function () {
      expect(item.mapItems.length).toBe(1);
    });

    describe("the mapItem", function () {
      it("correctly sets the `alpha` value", function () {
        if (!ImageryParts.is(item.mapItems[0]))
          throw new Error("Expected MapItem to be an ImageryParts");
        runInAction(() => item.setTrait("definition", "opacity", 0.42));
        expect(item.mapItems[0].alpha).toBe(0.42);
      });

      it("correctly sets `show`", function () {
        if (!ImageryParts.is(item.mapItems[0]))
          throw new Error("Expected MapItem to be an ImageryParts");
        runInAction(() => item.setTrait("definition", "show", false));
        expect(item.mapItems[0].show).toBe(false);
        runInAction(() => item.setTrait("definition", "show", true));
        expect(item.mapItems[0].show).toBe(true);
      });

      it("correctly sets the `clippingRectangle` value", function () {
        item.setTrait("definition", "rectangle", {
          west: 0,
          south: -30,
          east: 30,
          north: 30
        });

        if (!ImageryParts.is(item.mapItems[0]))
          throw new Error("Expected MapItem to be an ImageryParts");
        expect(item.mapItems[0].clippingRectangle).toBeDefined();

        if (item.mapItems[0].clippingRectangle !== undefined) {
          expect(item.mapItems[0].clippingRectangle.west).toBeCloseTo(0, 8);

          expect(item.mapItems[0].clippingRectangle.south).toBeCloseTo(
            -0.5235987755982988,
            8
          );

          expect(item.mapItems[0].clippingRectangle.east).toBeCloseTo(
            0.5235987755982983,
            8
          );

          expect(item.mapItems[0].clippingRectangle.north).toBeCloseTo(
            0.5235987755982988,
            8
          );
        }

        runInAction(() =>
          item.setTrait("definition", "clipToRectangle", false)
        );
        expect(item.mapItems[0].clippingRectangle).toBe(undefined);
      });

      describe("imageryProvider", function () {
        it("should be a UrlTemplateImageryProvider", function () {
          if (!ImageryParts.is(item.mapItems[0]))
            throw new Error("Expected MapItem to be an ImageryParts");

          const imageryProvider = item.mapItems[0].imageryProvider;
          expect(
            imageryProvider instanceof UrlTemplateImageryProvider
          ).toBeTruthy();
        });

        it("has the correct properties", function () {
          runInAction(() => {
            item.setTrait("definition", "attribution", "foo bar baz");
            item.setTrait("definition", "subdomains", ["a"]);
          });

          if (!ImageryParts.is(item.mapItems[0]))
            throw new Error("MapItem is not an ImageryParts");
          const imageryProvider = item.mapItems[0].imageryProvider;
          expect(imageryProvider).not.toBeUndefined();
          if (imageryProvider) {
            expect({
              url: (imageryProvider as any).url,
              attribution: imageryProvider.credit.html,
              tilingScheme: imageryProvider.tilingScheme,
              tileWidth: imageryProvider.tileWidth,
              tileHeight: imageryProvider.tileHeight,
              minimumLevel: imageryProvider.minimumLevel,
              maximumLevel: imageryProvider.maximumLevel,
              subdomains: (imageryProvider as any)._subdomains
            }).toEqual({
              url: "https://{s}.example.com/ooo/{z}/{x}/{y}.png",
              attribution: "foo bar baz",
              tilingScheme: new WebMercatorTilingScheme(),
              tileWidth: 256,
              tileHeight: 256,
              minimumLevel: 0,
              maximumLevel: 25,
              subdomains: ["a"]
            });
          }
        });
      });
    });
  });
});