/*
    * 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
    *
    *      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.
   */
  package org.apache.commons.net.ntp;
  
  import static org.junit.jupiter.api.Assertions.assertEquals;
  import static org.junit.jupiter.api.Assertions.assertNotNull;
  import static org.junit.jupiter.api.Assertions.assertTrue;
  import static org.junit.jupiter.api.Assertions.fail;
  
  import java.io.IOException;
  import java.net.InetAddress;
  import java.time.Duration;
  
  import org.apache.commons.lang3.ThreadUtils;
  import org.apache.commons.net.examples.ntp.SimpleNTPServer;
  import org.junit.jupiter.api.AfterAll;
  import org.junit.jupiter.api.BeforeAll;
  import org.junit.jupiter.api.Test;
  
  /**
   * JUnit test class for NtpClient using SimpleNTPServer
   */
  class TestNtpClient {
  
      private static SimpleNTPServer server; //NOPMD test code
  
      @BeforeAll
      public static void oneTimeSetUp() throws IOException {
          // one-time initialization code
          server = new SimpleNTPServer(0);
          server.connect();
  
          try {
              server.start();
          } catch (final IOException e) {
              fail("failed to start NTP server: " + e);
          }
          assertTrue(server.isStarted());
          // System.out.println("XXX: time server started");
          boolean running = false;
          for (int retries = 0; retries < 5; retries++) {
              running = server.isRunning();
              if (running) {
                  break;
              }
              // if not running then sleep 2 seconds and try again
              ThreadUtils.sleepQuietly(Duration.ofMillis(2000));
          }
          assertTrue(running);
      }
  
      @AfterAll
      public static void oneTimeTearDown() {
          // one-time cleanup code
          if (server != null) {
              server.stop();
              server = null;
          }
      }
  
      @Test
      void testGetTime() throws IOException {
          final long currentTimeMillis = System.currentTimeMillis();
          final NTPUDPClient client = new NTPUDPClient();
          // timeout if response takes longer than 2 seconds
          client.setDefaultTimeout(Duration.ofSeconds(2));
          try {
              // Java 1.7: use InetAddress.getLoopbackAddress() instead
              final InetAddress addr = InetAddress.getByAddress("loopback", new byte[] { 127, 0, 0, 1 });
              final TimeInfo timeInfo = client.getTime(addr, server.getPort());
              assertNotNull(timeInfo);
              assertTrue(timeInfo.getReturnTime() >= currentTimeMillis);
              final NtpV3Packet message = timeInfo.getMessage();
              assertNotNull(message);
  
              final TimeStamp rcvTimeStamp = message.getReceiveTimeStamp();
              final TimeStamp xmitTimeStamp = message.getTransmitTimeStamp();
              assertTrue(xmitTimeStamp.compareTo(rcvTimeStamp) >= 0);
  
              final TimeStamp originateTimeStamp = message.getOriginateTimeStamp();
              assertNotNull(originateTimeStamp);
              assertTrue(originateTimeStamp.getTime() >= currentTimeMillis);
  
              assertEquals(NtpV3Packet.MODE_SERVER, message.getMode());
  
             // following assertions are specific to the SimpleNTPServer
 
             final TimeStamp referenceTimeStamp = message.getReferenceTimeStamp();
             assertNotNull(referenceTimeStamp);
             assertTrue(referenceTimeStamp.getTime() >= currentTimeMillis);
 
             assertEquals(NtpV3Packet.VERSION_3, message.getVersion());
             assertEquals(1, message.getStratum());
 
             assertEquals("LCL", NtpUtils.getReferenceClock(message));
         } finally {
             client.close();
         }
     }
 
 }