ooni-probe-cli/internal/engine/experiment/imap/imap_test.go

package imap

import (
	"bufio"
	"context"
	"crypto/tls"
    //"encoding/json"
	"errors"
	"fmt"
	"net"
	"strings"
	"testing"

	"github.com/ooni/probe-cli/v3/internal/engine/mockable"
	"github.com/ooni/probe-cli/v3/internal/model"
)

func plaintextListener() net.Listener {
	l, err := net.Listen("tcp", "127.0.0.1:0")
	if err != nil {
		if l, err = net.Listen("tcp6", "[::1]:0"); err != nil {
			panic(fmt.Sprintf("httptest: failed to listen on a port: %v", err))
		}
	}
	return l
}

func tlsListener(l net.Listener) net.Listener {
	return tls.NewListener(l, &tls.Config{})
}

func listener_addr(l net.Listener) string {
	return l.Addr().String()
}

func ValidIMAPServer(conn net.Conn) {
	for {
		command, err := bufio.NewReader(conn).ReadString('\n')
		if err != nil {
			return
		}

		if strings.Contains(command, "NOOP") {
			conn.Write([]byte("A1 OK NOOP completed.\n"))
		} else if command == "STARTTLS" {
			conn.Write([]byte("A1 OK Begin TLS negotiation now.\n"))
			// TODO: conn.Close does not actually close connection? or does client not detect it?
			conn.Close()
			return
		}
        conn.Write([]byte("\n"))
	}
}

func TCPServer(l net.Listener) {
	for {
		conn, err := l.Accept()
		if err != nil {
			continue
		}
		defer conn.Close()
		conn.Write([]byte("* OK [CAPABILITY IMAP4rev1 SASL-IR LOGIN-REFERRALS ID ENABLE IDLE LITERAL+ STARTTLS LOGINDISABLED] howdy, ready.\n"))
		ValidIMAPServer(conn)
	}
}

func TestMeasurer_run(t *testing.T) {
	// runHelper is an helper function to run this set of tests.
	runHelper := func(input string) (*model.Measurement, model.ExperimentMeasurer, error) {
		m := NewExperimentMeasurer(Config{})
		if m.ExperimentName() != "imap" {
			t.Fatal("invalid experiment name")
		}
		if m.ExperimentVersion() != "0.0.1" {
			t.Fatal("invalid experiment version")
		}
		ctx := context.Background()
		meas := &model.Measurement{
			Input: model.MeasurementTarget(input),
		}
		sess := &mockable.Session{
			MockableLogger: model.DiscardLogger,
		}
		callbacks := model.NewPrinterCallbacks(model.DiscardLogger)
		err := m.Run(ctx, sess, meas, callbacks)
		return meas, m, err
	}

	t.Run("with empty input", func(t *testing.T) {
		_, _, err := runHelper("")
		if !errors.Is(err, errNoInputProvided) {
			t.Fatal("unexpected error", err)
		}
	})

	t.Run("with invalid URL", func(t *testing.T) {
		_, _, err := runHelper("\t")
		if !errors.Is(err, errInputIsNotAnURL) {
			t.Fatal("unexpected error", err)
		}
	})

	t.Run("with invalid scheme", func(t *testing.T) {
		_, _, err := runHelper("https://8.8.8.8:443/")
		if !errors.Is(err, errInvalidScheme) {
			t.Fatal("unexpected error", err)
		}
	})

	t.Run("with broken TLS", func(t *testing.T) {
		p := plaintextListener()
		defer p.Close()

		l := tlsListener(p)
		defer l.Close()
		addr := listener_addr(l)
		go TCPServer(l)

		meas, m, err := runHelper("imaps://" + addr)
		if err != nil {
			t.Fatal(err)
		}

		tk := meas.TestKeys.(*TestKeys)

		for _, run := range tk.Runs {
			for _, handshake := range run.TLSHandshakes {
				if *handshake.Failure != "unknown_failure: remote error: tls: unrecognized name" {
					t.Fatal("expected unrecognized_name in TLS handshake")
				}
			}

			if run.NoOpCounter != 0 {
				t.Fatalf("expected to not have any noops, not %d noops", run.NoOpCounter)
			}
		}

		ask, err := m.GetSummaryKeys(meas)
		if err != nil {
			t.Fatal("cannot obtain summary")
		}
		summary := ask.(SummaryKeys)
		if summary.IsAnomaly {
			t.Fatal("expected no anomaly")
		}
	})

	t.Run("with broken starttls", func(t *testing.T) {
		l := plaintextListener()
		defer l.Close()
		addr := listener_addr(l)

		go TCPServer(l)

		meas, m, err := runHelper("imap://" + addr)
		if err != nil {
			t.Fatal(err)
		}

		tk := meas.TestKeys.(*TestKeys)
        //bs, _ := json.Marshal(tk)
        //fmt.Println(string(bs))

		for _, run := range tk.Runs {
			for _, handshake := range run.TLSHandshakes {
				if *handshake.Failure != "unknown_failure: tls: first record does not look like a TLS handshake" {

					t.Fatal("expected broken handshake")
				}
			}

			if run.NoOpCounter != 0 {
				t.Fatalf("expected to not have any noops, not %d noops", run.NoOpCounter)
			}
		}

		ask, err := m.GetSummaryKeys(meas)
		if err != nil {
			t.Fatal("cannot obtain summary")
		}
		summary := ask.(SummaryKeys)
		if summary.IsAnomaly {
			t.Fatal("expected no anomaly")
		}
	})
}