modules/core/src/test/java/org/apache/ignite/platform/PlatformDeployServiceTask.java

/*
 * 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.
 */

package org.apache.ignite.platform;

import java.sql.Timestamp;
import java.time.ZoneId;
import java.time.ZonedDateTime;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import java.util.concurrent.Callable;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.apache.ignite.Ignite;
import org.apache.ignite.IgniteCache;
import org.apache.ignite.IgniteException;
import org.apache.ignite.binary.BinaryObject;
import org.apache.ignite.cluster.ClusterNode;
import org.apache.ignite.compute.ComputeJob;
import org.apache.ignite.compute.ComputeJobAdapter;
import org.apache.ignite.compute.ComputeJobResult;
import org.apache.ignite.compute.ComputeTaskAdapter;
import org.apache.ignite.compute.ComputeTaskSplitAdapter;
import org.apache.ignite.internal.IgniteEx;
import org.apache.ignite.internal.binary.BinaryArray;
import org.apache.ignite.internal.util.lang.IgnitePair;
import org.apache.ignite.internal.util.typedef.F;
import org.apache.ignite.internal.util.typedef.internal.U;
import org.apache.ignite.platform.model.ACL;
import org.apache.ignite.platform.model.AccessLevel;
import org.apache.ignite.platform.model.Account;
import org.apache.ignite.platform.model.Address;
import org.apache.ignite.platform.model.Department;
import org.apache.ignite.platform.model.Employee;
import org.apache.ignite.platform.model.Key;
import org.apache.ignite.platform.model.Parameter;
import org.apache.ignite.platform.model.Role;
import org.apache.ignite.platform.model.User;
import org.apache.ignite.platform.model.Value;
import org.apache.ignite.resources.IgniteInstanceResource;
import org.apache.ignite.services.Service;
import org.apache.ignite.services.ServiceCallInterceptor;
import org.apache.ignite.services.ServiceConfiguration;
import org.apache.ignite.services.ServiceContext;
import org.apache.ignite.spi.metric.HistogramMetric;
import org.apache.ignite.spi.metric.Metric;
import org.apache.ignite.spi.metric.ReadOnlyMetricRegistry;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import static java.util.Calendar.JANUARY;
import static org.apache.ignite.internal.processors.service.GridServiceMetricsTest.sumHistogramEntries;
import static org.apache.ignite.internal.processors.service.IgniteServiceProcessor.serviceMetricRegistryName;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;

/**
 * Task that deploys a Java service.
 */
public class PlatformDeployServiceTask extends ComputeTaskAdapter<String, Object> {
    /** {@inheritDoc} */
    @NotNull @Override public Map<? extends ComputeJob, ClusterNode> map(List<ClusterNode> subgrid,
        @Nullable String serviceName) throws IgniteException {
        return Collections.singletonMap(new PlatformDeployServiceJob(serviceName), F.first(subgrid));
    }

    /** {@inheritDoc} */
    @Nullable @Override public Object reduce(List<ComputeJobResult> results) throws IgniteException {
        return results.get(0).getData();
    }

    /**
     * Job.
     */
    private static class PlatformDeployServiceJob extends ComputeJobAdapter {
        /** Service name. */
        private final String serviceName;

        /** Ignite. */
        @IgniteInstanceResource
        private Ignite ignite;

        /**
         * Ctor.
         *
         * @param serviceName Service name.
         */
        private PlatformDeployServiceJob(String serviceName) {
            assert serviceName != null;
            this.serviceName = serviceName;
        }

        /** {@inheritDoc} */
        @Override public Object execute() throws IgniteException {
            ServiceConfiguration svcCfg = new ServiceConfiguration();

            svcCfg.setStatisticsEnabled(true);
            svcCfg.setName(serviceName);
            svcCfg.setMaxPerNodeCount(1);
            svcCfg.setService(new PlatformTestService());
            svcCfg.setInterceptors(new PlatformTestServiceInterceptor());

            ignite.services().deploy(svcCfg);

            return null;
        }
    }

    /**
     * Test service.
     */
    public static class PlatformTestService implements Service, PlatformHelperService {
        /** */
        @IgniteInstanceResource
        private IgniteEx ignite;

        /** */
        private boolean isCancelled;

        /** */
        private boolean isInitialized;

        /** */
        private boolean isExecuted;

        /** */
        private ServiceContext svcCtx;

        /** {@inheritDoc} */
        @Override public void cancel(ServiceContext ctx) {
            isCancelled = true;
        }

        /** {@inheritDoc} */
        @Override public void init(ServiceContext ctx) throws Exception {
            svcCtx = ctx;

            isInitialized = true;
        }

        /** {@inheritDoc} */
        @Override public void execute(ServiceContext ctx) throws Exception {
            isExecuted = true;
        }

        /**
         * Returns a value indicating whether this service is cancelled.
         */
        public boolean isCancelled() {
            return isCancelled;
        }

        /**
         * Returns a value indicating whether this service is initialized.
         */
        public boolean isInitialized() {
            return isInitialized;
        }

        /**
         * Returns a value indicating whether this service is executed.
         */
        public boolean isExecuted() {
            return isExecuted;
        }

        /** */
        public byte test(byte arg) {
            return (byte)(arg + 1);
        }

        /** */
        public short test(short arg) {
            return (short)(arg + 1);
        }

        /** */
        public int test(int arg) {
            return arg + 1;
        }

        /** */
        public long test(long arg) {
            return arg + 1;
        }

        /** */
        public float test(float arg) {
            return arg + 1.5f;
        }

        /** */
        public double test(double arg) {
            return arg + 2.5;
        }

        /** */
        public boolean test(boolean arg) {
            return !arg;
        }

        /** */
        public char test(char arg) {
            return (char)(arg + 1);
        }

        /** */
        public String test(String arg) {
            return arg == null ? null : arg + "!";
        }

        /** */
        public Timestamp test(Timestamp input) {
            Timestamp exp = new Timestamp(92, JANUARY, 1, 0, 0, 0, 0);

            if (!exp.equals(input))
                throw new RuntimeException("Expected \"" + exp + "\" but got \"" + input + "\"");

            return input;
        }

        /** */
        public UUID test(UUID input) {
            return input;
        }

        /** */
        public Byte testWrapper(Byte arg) {
            return arg == null ? null : (byte)(arg + 1);
        }

        /** */
        public Short testWrapper(Short arg) {
            return arg == null ? null : (short)(arg + 1);
        }

        /** */
        public Integer testWrapper(Integer arg) {
            return arg == null ? null : arg + 1;
        }

        /** */
        public Long testWrapper(Long arg) {
            return arg == null ? null : arg + 1;
        }

        /** */
        public Float testWrapper(Float arg) {
            return arg == null ? null : arg + 1.5f;
        }

        /** */
        public Double testWrapper(Double arg) {
            return arg == null ? null : arg + 2.5;
        }

        /** */
        public Boolean testWrapper(Boolean arg) {
            return arg == null ? null : !arg;
        }

        /** */
        public Character testWrapper(Character arg) {
            return arg == null ? null : (char)(arg + 1);
        }

        /** */
        public byte[] testArray(byte[] arg) {
            if (arg != null)
                for (int i = 0; i < arg.length; i++)
                    arg[i] += 1;

            return arg;
        }

        /** */
        public short[] testArray(short[] arg) {
            if (arg != null)
                for (int i = 0; i < arg.length; i++)
                    arg[i] += 1;

            return arg;
        }

        /** */
        public int[] testArray(int[] arg) {
            if (arg != null)
                for (int i = 0; i < arg.length; i++)
                    arg[i] += 1;

            return arg;
        }

        /** */
        public long[] testArray(long[] arg) {
            if (arg != null)
                for (int i = 0; i < arg.length; i++)
                    arg[i] += 1;

            return arg;
        }

        /** */
        public double[] testArray(double[] arg) {
            if (arg != null)
                for (int i = 0; i < arg.length; i++)
                    arg[i] += 1;

            return arg;
        }

        /** */
        public float[] testArray(float[] arg) {
            if (arg != null)
                for (int i = 0; i < arg.length; i++)
                    arg[i] += 1;

            return arg;
        }

        /** */
        public String[] testArray(String[] arg) {
            if (arg != null)
                for (int i = 0; i < arg.length; i++)
                    arg[i] += 1;

            return arg;
        }

        /** */
        public char[] testArray(char[] arg) {
            if (arg != null)
                for (int i = 0; i < arg.length; i++)
                    arg[i] += 1;

            return arg;
        }

        /** */
        public boolean[] testArray(boolean[] arg) {
            if (arg != null)
                for (int i = 0; i < arg.length; i++)
                    arg[i] = !arg[i];

            return arg;
        }

        /** */
        public Timestamp[] testArray(Timestamp[] arg) {
            if (arg == null || arg.length != 1)
                throw new RuntimeException("Expected array of length 1");

            return new Timestamp[] {test(arg[0])};
        }

        /** */
        public UUID[] testArray(UUID[] arg) {
            return arg;
        }

        /** */
        public Integer testNull(Integer arg) {
            return arg == null ? null : arg + 1;
        }

        /** */
        public UUID testNullUUID(UUID arg) {
            return arg;
        }

        /** */
        public Timestamp testNullTimestamp(Timestamp arg) {
            return arg;
        }

        /** */
        public int testParams(Object... args) {
            return args.length;
        }

        /** */
        public int test(int x, String y) {
            return x + 1;
        }

        /** */
        public int test(String x, int y) {
            return y + 1;
        }

        /** */
        public PlatformComputeBinarizable testBinarizable(PlatformComputeBinarizable arg) {
            return arg == null ? null : new PlatformComputeBinarizable(arg.field + 1);
        }

        /** */
        public Object[] testBinarizableArrayOfObjects(Object[] arg) {
            if (arg == null)
                return null;

            for (int i = 0; i < arg.length; i++)
                arg[i] = arg[i] == null
                    ? null
                    : new PlatformComputeBinarizable(((PlatformComputeBinarizable)arg[i]).field + 1);

            return arg;
        }

        /** */
        public PlatformComputeBinarizable[] testBinarizableArray(PlatformComputeBinarizable[] arg) {
            return (PlatformComputeBinarizable[])testBinarizableArrayOfObjects(arg);
        }

        /** */
        public BinaryObject[] testBinaryObjectArray(Object arg0) {
            Object[] arg;

            if (BinaryArray.useBinaryArrays()) {
                assertTrue(arg0 instanceof BinaryArray);

                arg = ((BinaryArray)arg0).array();
            }
            else {
                assertTrue(arg0 instanceof Object[]);

                arg = (Object[])arg0;
            }

            BinaryObject[] res = new BinaryObject[arg.length];

            for (int i = 0; i < arg.length; i++) {
                int field = ((BinaryObject)arg[i]).field("Field");

                res[i] = ((BinaryObject)arg[i]).toBuilder().setField("Field", field + 1).build();
            }

            return res;
        }

        /** */
        public Collection testBinarizableCollection(Collection arg) {
            if (arg == null)
                return null;

            Collection<PlatformComputeBinarizable> res = new ArrayList<>(arg.size());

            for (Object x : arg)
                res.add(new PlatformComputeBinarizable(((PlatformComputeBinarizable)x).field + 1));

            return res;
        }

        /** */
        public BinaryObject testBinaryObject(BinaryObject o) {
            if (o == null)
                return null;

            return o.toBuilder().setField("field", 15).build();
        }

        /** */
        public Address testAddress(Address addr) {
            if (addr == null)
                return null;

            assertEquals("000", addr.getZip());
            assertEquals("Moscow", addr.getAddr());

            addr.setZip("127000");
            addr.setAddr("Moscow Akademika Koroleva 12");

            return addr;
        }

        /** */
        public int testOverload(Integer count, Employee[] emps) {
            assertNotNull(emps);
            assertEquals((int)count, emps.length);

            assertEquals("Sarah Connor", emps[0].getFio());
            assertEquals(1, emps[0].getSalary());

            assertEquals("John Connor", emps[1].getFio());
            assertEquals(2, emps[1].getSalary());

            return 42;
        }

        /** */
        public int testOverload(int count, Parameter[] params) {
            assertNotNull(params);
            assertEquals(count, params.length);

            assertEquals(1, params[0].getId());
            assertEquals(2, params[0].getValues().length);

            assertEquals(1, params[0].getValues()[0].getId());
            assertEquals(42, params[0].getValues()[0].getVal());

            assertEquals(2, params[0].getValues()[1].getId());
            assertEquals(43, params[0].getValues()[1].getVal());

            assertEquals(2, params[1].getId());
            assertEquals(2, params[1].getValues().length);

            assertEquals(3, params[1].getValues()[0].getId());
            assertEquals(44, params[1].getValues()[0].getVal());

            assertEquals(4, params[1].getValues()[1].getId());
            assertEquals(45, params[1].getValues()[1].getVal());

            return 43;
        }

        /** */
        public int testOverload(int first, int second) {
            return first + second;
        }

        /** */
        public Employee[] testEmployees(Employee[] emps) {
            if (emps == null)
                return null;

            assertEquals(2, emps.length);

            assertEquals("Sarah Connor", emps[0].getFio());
            assertEquals(1, emps[0].getSalary());

            assertEquals("John Connor", emps[1].getFio());
            assertEquals(2, emps[1].getSalary());

            Employee kyle = new Employee();

            kyle.setFio("Kyle Reese");
            kyle.setSalary(3);

            return new Employee[] { kyle };
        }

        /** */
        public Collection testDepartments(Collection deps) {
            if (deps == null)
                return null;

            assertEquals(2, deps.size());

            Iterator<Department> iter = deps.iterator();

            assertEquals("HR", iter.next().getName());
            assertEquals("IT", iter.next().getName());

            Collection<Department> res = new ArrayList<>();

            Department d = new Department();

            d.setName("Executive");

            res.add(d);

            return res;
        }

        /** */
        public Map testMap(Map map) {
            if (map == null)
                return null;

            assertTrue(map.containsKey(new Key(1)));
            assertTrue(map.containsKey(new Key(2)));

            assertEquals("value1", ((Value)map.get(new Key(1))).getVal());
            assertEquals("value2", ((Value)map.get(new Key(2))).getVal());

            Map m = new HashMap();

            m.put(new Key(3), new Value("value3"));

            return m;
        }

        /** */
        public Account[] testAccounts() {
            return new Account[] {
                new Account("123", 42),
                new Account("321", 0)
            };
        }

        /** */
        public User[] testUsers() {
            return new User[] {
                new User(1, ACL.ALLOW, new Role("admin", AccessLevel.SUPER)),
                new User(2, ACL.DENY, new Role("user", AccessLevel.USER))
            };
        }

        /** */
        public void testDateArray(Timestamp[] dates) {
            assertNotNull(dates);
            assertEquals(2, dates.length);
            assertEquals(new Timestamp(new Date(82, Calendar.APRIL, 1, 0, 0, 0).getTime()), dates[0]);
            assertEquals(new Timestamp(new Date(91, Calendar.OCTOBER, 1, 0, 0, 0).getTime()), dates[1]);
        }

        /** */
        public Timestamp testDate(Timestamp date) {
            if (date == null)
                return null;

            assertEquals(new Timestamp(new Date(82, Calendar.APRIL, 1, 0, 0, 0).getTime()), date);

            return new Timestamp(new Date(91, Calendar.OCTOBER, 1, 0, 0, 0).getTime());
        }

        /** */
        public void testUTCDateFromCache() {
            IgniteCache<Integer, Timestamp> cache = ignite.cache("net-dates");

            cache.put(3, new Timestamp(new Date(82, Calendar.APRIL, 1, 0, 0, 0).getTime()));
            cache.put(4, new Timestamp(new Date(91, Calendar.OCTOBER, 1, 0, 0, 0).getTime()));

            assertEquals(new Timestamp(new Date(82, Calendar.APRIL, 1, 0, 0, 0).getTime()), cache.get(1));
            assertEquals(new Timestamp(new Date(91, Calendar.OCTOBER, 1, 0, 0, 0).getTime()), cache.get(2));
        }

        /** */
        public void testLocalDateFromCache() {
            IgniteCache<Integer, Timestamp> cache = ignite.cache("net-dates");

            ZoneId msk = ZoneId.of("Europe/Moscow");

            //This Date in Europe/Moscow have offset +4.
            Timestamp ts1 = new Timestamp(ZonedDateTime.of(1982, 4, 1, 1, 0, 0, 0, msk).toInstant().toEpochMilli());
            //This Date in Europe/Moscow have offset +3.
            Timestamp ts2 = new Timestamp(ZonedDateTime.of(1982, 3, 31, 22, 0, 0, 0, msk).toInstant().toEpochMilli());

            assertEquals(ts1, cache.get(5));
            assertEquals(ts2, cache.get(6));

            cache.put(7, ts1);
            cache.put(8, ts2);
        }

        /** */
        public void testException(String exCls) throws Exception {
            switch (exCls) {
                case "InterruptedException": throw new InterruptedException("Test");
                case "IllegalArgumentException": throw new IllegalArgumentException("Test");
                case "TestMapped1Exception": throw new TestMapped1Exception("Test");
                case "TestMapped2Exception": throw new TestMapped2Exception("Test");
                case "TestUnmappedException": throw new TestUnmappedException("Test");
                default: throw new IgniteException("Unexpected exception class: " + exCls);
            }
        }

        /** */
        public Object testRoundtrip(Object x) {
            return x;
        }

        /** */
        public int testInterception(int val) {
            return val;
        }

        /** */
        public void sleep(long delayMs) {
            try {
                U.sleep(delayMs);
            }
            catch (Exception e) {
                throw new IgniteException(e);
            }
        }

        /** {@inheritDoc} */
        @Override public int testNumberOfInvocations(String svcName, String histName) {
            return ignite.compute().execute(new CountServiceMetricsTask(), new IgnitePair<>(svcName, histName));
        }

        /** */
        public Object contextAttribute(String name) {
            return svcCtx.currentCallContext().attribute(name);
        }

        /**
         * Calculates number of registered values among the service statistics. Can process all service metrics or
         * certain named one.
         */
        private static class CountServiceMetricsTask extends ComputeTaskSplitAdapter<IgnitePair<String>, Integer> {
            /** {@inheritDoc} */
            @Override public Integer reduce(List<ComputeJobResult> results) throws IgniteException {
                int cnt = 0;

                for (ComputeJobResult res : results) {
                    if (res.isCancelled()) {
                        throw new IgniteException("Unable to count invocations in service metrics. Job was canceled " +
                            "on node [" + res.getNode() + "].");
                    }

                    if (res.getException() != null) {
                        throw new IgniteException("Unable to count invocations in service metrics. Job failed on " +
                            "node [" + res.getNode() + "]: " + res.getException().getMessage(), res.getException());
                    }

                    if (res.getData() == null)
                        continue;

                    cnt += (int)res.getData();
                }

                return cnt;
            }

            /** {@inheritDoc} */
            @Override protected Collection<? extends ComputeJob> split(int gridSize,
                IgnitePair<String> arg) throws IgniteException {
                return Stream.generate(() -> new CountServiceMetricsLocallyJob(arg.get1(), arg.get2())).limit(gridSize).
                    collect(Collectors.toList());
            }

            /** Summs invocation of service methods by service statistics on certain node. */
            private static class CountServiceMetricsLocallyJob extends ComputeJobAdapter {
                /** Service name. */
                private final String svcName;

                /** Name of the histogramm. If {@code null}, every histogram in the service metric is processed. */
                @Nullable private final String histName;

                /** */
                @IgniteInstanceResource
                private IgniteEx ignite;

                /**
                 * @param svcName  Service name.
                 * @param histName Name of the histogramm. If {@code null}, every histogram in the service metric is
                 *                 processed.
                 */
                private CountServiceMetricsLocallyJob(String svcName, @Nullable String histName) {
                    this.svcName = svcName;
                    this.histName = histName;
                }

                /** {@inheritDoc} */
                @Override public Integer execute() throws IgniteException {
                    ReadOnlyMetricRegistry metrics = ignite.context().metric().registry(
                        serviceMetricRegistryName(svcName));

                    if (histName != null && !histName.isEmpty()) {
                        HistogramMetric hist = metrics.findMetric(histName);

                        return hist == null ? 0 : (int)sumHistogramEntries(hist);
                    }

                    int cnt = 0;

                    for (Metric metric : metrics) {
                        if (metric instanceof HistogramMetric)
                            cnt += sumHistogramEntries((HistogramMetric)metric);
                    }

                    return cnt;
                }
            }
        }
    }

    /** */
    public static class PlatformTestServiceInterceptor implements ServiceCallInterceptor {
        /** */
        private static final long serialVersionUID = 0L;

        /** {@inheritDoc} */
        @Override public Object invoke(String mtd, Object[] args, ServiceContext ctx, Callable<Object> next) throws Exception {
            Object res = next.call();

            if ("testInterception".equals(mtd))
                return (int)res * (int)res;

            return res;
        }
    }

    /** */
    public static class TestMapped1Exception extends RuntimeException {
        /** */
        public TestMapped1Exception(String msg) {
            super(msg);
        }
    }

    /** */
    public static class TestMapped2Exception extends RuntimeException {
        /** */
        public TestMapped2Exception(String msg) {
            super(msg);
        }
    }

    /** */
    public static class TestUnmappedException extends RuntimeException {
        /** */
        public TestUnmappedException(String msg) {
            super(msg);
        }
    }

    /**
     * Platform helper service.
     */
    private interface PlatformHelperService {
        /**
         * Calculates number of registered values among the service statistics.
         *
         * @return Number of registered values among the service statistics.
         */
        int testNumberOfInvocations(String svcName, String histName);
    }
}