require "unit_spec_helper"

describe Rpush::Daemon::TcpConnection do
  let(:rsa_key) { double }
  let(:certificate) { double }
  let(:password) { double }
  let(:x509_certificate) { OpenSSL::X509::Certificate.new(TEST_CERT) }
  let(:ssl_context) { double(:key= => nil, :cert= => nil, cert: x509_certificate) }
  let(:host) { 'gateway.push.apple.com' }
  let(:port) { '2195' }
  let(:tcp_socket) { double(setsockopt: nil, close: nil) }
  let(:ssl_socket) { double(:sync= => nil, connect: nil, close: nil, write: nil, flush: nil) }
  let(:logger) { double(info: nil, error: nil, warn: nil) }
  let(:app) { double(name: 'Connection 0', certificate: certificate, password: password) }
  let(:connection) { Rpush::Daemon::TcpConnection.new(app, host, port) }

  before do
    OpenSSL::SSL::SSLContext.stub(new: ssl_context)
    OpenSSL::PKey::RSA.stub(new: rsa_key)
    OpenSSL::X509::Certificate.stub(new: x509_certificate)
    TCPSocket.stub(new: tcp_socket)
    OpenSSL::SSL::SSLSocket.stub(new: ssl_socket)
    Rpush.stub(logger: logger)
    connection.stub(:reflect)
  end

  it "reads the number of bytes from the SSL socket" do
    ssl_socket.should_receive(:read).with(123)
    connection.connect
    connection.read(123)
  end

  it "selects on the SSL socket until the given timeout" do
    IO.should_receive(:select).with([ssl_socket], nil, nil, 10)
    connection.connect
    connection.select(10)
  end

  describe "when setting up the SSL context" do
    it "sets the key on the context" do
      OpenSSL::PKey::RSA.should_receive(:new).with(certificate, password).and_return(rsa_key)
      ssl_context.should_receive(:key=).with(rsa_key)
      connection.connect
    end

    it "sets the cert on the context" do
      OpenSSL::X509::Certificate.should_receive(:new).with(certificate).and_return(x509_certificate)
      ssl_context.should_receive(:cert=).with(x509_certificate)
      connection.connect
    end
  end

  describe "when connecting the socket" do
    it "creates a TCP socket using the configured host and port" do
      TCPSocket.should_receive(:new).with(host, port).and_return(tcp_socket)
      connection.connect
    end

    it "creates a new SSL socket using the TCP socket and SSL context" do
      OpenSSL::SSL::SSLSocket.should_receive(:new).with(tcp_socket, ssl_context).and_return(ssl_socket)
      connection.connect
    end

    it "sets the sync option on the SSL socket" do
      ssl_socket.should_receive(:sync=).with(true)
      connection.connect
    end

    it "connects the SSL socket" do
      ssl_socket.should_receive(:connect)
      connection.connect
    end

    it "sets the socket option TCP_NODELAY" do
      tcp_socket.should_receive(:setsockopt).with(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, true)
      connection.connect
    end

    it "sets the socket option SO_KEEPALIVE" do
      tcp_socket.should_receive(:setsockopt).with(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
      connection.connect
    end

    describe 'certificate expiry' do
      it 'reflects if the certificate will expire soon' do
        cert = OpenSSL::X509::Certificate.new(app.certificate)
        connection.should_receive(:reflect).with(:ssl_certificate_will_expire, app, cert.not_after)
        Timecop.freeze(cert.not_after - 3.days) { connection.connect }
      end

      it 'logs that the certificate will expire soon' do
        cert = OpenSSL::X509::Certificate.new(app.certificate)
        logger.should_receive(:warn).with("[#{app.name}] Certificate will expire at 2022-09-07 03:18:32 UTC.")
        Timecop.freeze(cert.not_after - 3.days) { connection.connect }
      end

      it 'does not reflect if the certificate will not expire soon' do
        cert = OpenSSL::X509::Certificate.new(app.certificate)
        connection.should_not_receive(:reflect).with(:ssl_certificate_will_expire, app, kind_of(Time))
        Timecop.freeze(cert.not_after - 2.months) { connection.connect }
      end

      it 'logs that the certificate has expired' do
        cert = OpenSSL::X509::Certificate.new(app.certificate)
        logger.should_receive(:error).with("[#{app.name}] Certificate expired at 2022-09-07 03:18:32 UTC.")
        Timecop.freeze(cert.not_after + 1.day) { connection.connect rescue Rpush::CertificateExpiredError }
      end

      it 'raises an error if the certificate has expired' do
        cert = OpenSSL::X509::Certificate.new(app.certificate)
        Timecop.freeze(cert.not_after + 1.day) do
          expect { connection.connect }.to raise_error(Rpush::CertificateExpiredError)
        end
      end
    end

    describe 'certificate revocation' do
      let(:cert_revoked_error) { OpenSSL::SSL::SSLError.new('certificate revoked') }
      before do
        ssl_socket.stub(:connect).and_raise(cert_revoked_error)
      end

      it 'reflects that the certificate has been revoked' do
        connection.should_receive(:reflect).with(:ssl_certificate_revoked, app, cert_revoked_error)
        expect { connection.connect }.to raise_error(Rpush::Daemon::TcpConnectionError, 'OpenSSL::SSL::SSLError, certificate revoked')
      end

      it 'logs that the certificate has been revoked' do
        logger.should_receive(:warn).with('[Connection 0] Certificate has been revoked.')
        expect { connection.connect }.to raise_error(Rpush::Daemon::TcpConnectionError, 'OpenSSL::SSL::SSLError, certificate revoked')
      end
    end
  end

  describe "when shuting down the connection" do
    it "closes the TCP socket" do
      connection.connect
      tcp_socket.should_receive(:close)
      connection.close
    end

    it "does not attempt to close the TCP socket if it is not connected" do
      connection.connect
      tcp_socket.should_not_receive(:close)
      connection.instance_variable_set("@tcp_socket", nil)
      connection.close
    end

    it "closes the SSL socket" do
      connection.connect
      ssl_socket.should_receive(:close)
      connection.close
    end

    it "does not attempt to close the SSL socket if it is not connected" do
      connection.connect
      ssl_socket.should_not_receive(:close)
      connection.instance_variable_set("@ssl_socket", nil)
      connection.close
    end

    it "ignores IOError when the socket is already closed" do
      tcp_socket.stub(:close).and_raise(IOError)
      connection.connect
      connection.close
    end
  end

  shared_examples_for "when the write fails" do
    before do
      connection.stub(:sleep)
      connection.connect
      ssl_socket.stub(:write).and_raise(error)
    end

    it 'reflects the connection has been lost' do
      connection.should_receive(:reflect).with(:tcp_connection_lost, app, kind_of(error.class))
      expect { connection.write(nil) }.to raise_error(Rpush::Daemon::TcpConnectionError)
    end

    it "logs that the connection has been lost once only" do
      logger.should_receive(:error).with("[Connection 0] Lost connection to gateway.push.apple.com:2195 (#{error.class.name}, #{error.message}), reconnecting...").once
      expect { connection.write(nil) }.to raise_error(Rpush::Daemon::TcpConnectionError)
    end

    it "retries to make a connection 3 times" do
      connection.should_receive(:reconnect).exactly(3).times
      expect { connection.write(nil) }.to raise_error(Rpush::Daemon::TcpConnectionError)
    end

    it "raises a TcpConnectionError after 3 attempts at reconnecting" do
      expect do
        connection.write(nil)
      end.to raise_error(Rpush::Daemon::TcpConnectionError, "Connection 0 tried 3 times to reconnect but failed (#{error.class.name}, #{error.message}).")
    end

    it "sleeps 1 second before retrying the connection" do
      connection.should_receive(:sleep).with(1)
      expect { connection.write(nil) }.to raise_error(Rpush::Daemon::TcpConnectionError)
    end
  end

  describe "when write raises an Errno::EPIPE" do
    it_should_behave_like "when the write fails"

    def error
      Errno::EPIPE.new('an message')
    end
  end

  describe "when write raises an Errno::ETIMEDOUT" do
    it_should_behave_like "when the write fails"

    def error
      Errno::ETIMEDOUT.new('an message')
    end
  end

  describe "when write raises an OpenSSL::SSL::SSLError" do
    it_should_behave_like "when the write fails"

    def error
      OpenSSL::SSL::SSLError.new('an message')
    end
  end

  describe "when write raises an IOError" do
    it_should_behave_like "when the write fails"

    def error
      IOError.new('an message')
    end
  end

  describe "when reconnecting" do
    before { connection.connect }

    it 'closes the socket' do
      connection.should_receive(:close)
      connection.send(:reconnect)
    end

    it 'connects the socket' do
      connection.should_receive(:connect_socket)
      connection.send(:reconnect)
    end
  end

  describe "when sending a notification" do
    before { connection.connect }

    it "writes the data to the SSL socket" do
      ssl_socket.should_receive(:write).with("blah")
      connection.write("blah")
    end

    it "flushes the SSL socket" do
      ssl_socket.should_receive(:flush)
      connection.write("blah")
    end
  end

  describe 'idle period' do
    before { connection.connect }

    it 'reconnects if the connection has been idle for more than the defined period' do
      Rpush::Daemon::TcpConnection.stub(idle_period: 60)
      Time.stub(now: Time.now + 61)
      connection.should_receive(:reconnect)
      connection.write('blah')
    end

    it 'resets the last touch time' do
      now = Time.now
      Time.stub(now: now)
      connection.write('blah')
      connection.last_touch.should eq now
    end

    it 'does not reconnect if the connection has not been idle for more than the defined period' do
      connection.should_not_receive(:reconnect)
      connection.write('blah')
    end

    it 'logs the the connection is idle' do
      Rpush::Daemon::TcpConnection.stub(idle_period: 60)
      Time.stub(now: Time.now + 61)
      Rpush.logger.should_receive(:info).with('[Connection 0] Idle period exceeded, reconnecting...')
      connection.write('blah')
    end
  end
end