Signal-iOS/Signal/test/util/QRCodeParserTest.swift
Evan Hahn 370ff654e7
Change license to AGPL
Change license to AGPL

This commit:

- Updates the `LICENSE` file

- Start every file with something like:

      // Copyright YEAR_FIRST_PUBLISHED Signal Messenger, LLC
      // SPDX-License-Identifier: AGPL-3.0-only

---

First, I removed existing license headers with this Ruby 3.1.2 script:

    require 'set'

    EXTENSIONS_TO_CHECK = Set['.h', '.hpp', '.cpp', '.m', '.mm', '.pch', '.swift']

    same = 0
    different = 0

    all_files = `git ls-files`.lines.map { |line| line.strip }
    all_files.each do |relative_path|
      if relative_path == 'Pods'
        next
      end

      unless EXTENSIONS_TO_CHECK.include? File.extname(relative_path)
        next
      end

      path = File.expand_path(relative_path)

      contents = File.read(path)
      new_contents = contents.sub(/\/\/\n\/\/  Copyright .*\n\/\/\n\n/, '')

      if contents == new_contents
        same += 1
      else
        different += 1
      end

      File.write(path, new_contents)
    end

    puts "updated #{different} file(s), left #{same} untouched"

I'm sure this script could be improved, but it worked well enough.

Then, I created `Scripts/lint/lint-license-headers` and ran it to auto-
fix a lot of files. This changed the mode of some files, but I think
that's actually desirable. For example,
`SignalServiceKit/src/Util/AppContext.m` previously had a mode of
`0755/-rwxr-xr-x`, and it's now `0644/-rw-r--r--`.

Then I fixed some stragglers and updated the precommit script.

See [a similar change in the Desktop app][0].

[0]: 8bfaf598af
2022-10-13 08:25:37 -05:00

141 lines
7.1 KiB
Swift

//
// Copyright 2021 Signal Messenger, LLC
// SPDX-License-Identifier: AGPL-3.0-only
//
import XCTest
@testable import Signal
class QRCodeParserTest: SignalBaseTest {
func testParse() {
struct SampleQRCode {
let qrCodeBase64: String
let symbolVersion: Int
let expectedMode: UInt
let expectedString: String?
}
let sampleQRCodes: [SampleQRCode] = [
SampleQRCode(qrCodeBase64: "QNJ1R3YXMgYnJpbGxpZw7A==",
symbolVersion: 1,
expectedMode: 4,
expectedString: "'Twas brillig"),
SampleQRCode(qrCodeBase64: "QPVGhpcyBpcyBhIFRlc3QggCC4npgOwR7BHsEQ==",
symbolVersion: 2,
expectedMode: 4,
expectedString: "This is a Test "),
SampleQRCode(qrCodeBase64: "QJc2hvcHBpbmcKDsEewR7A==",
symbolVersion: 1,
expectedMode: 4,
expectedString: "shopping\n"),
SampleQRCode(qrCodeBase64: "QZaHR0cDovL2VuLm0ud2lraXBlZGlhLm9yZw7BHsEewR7A==",
symbolVersion: 3,
expectedMode: 4,
expectedString: "http://en.m.wikipedia.org"),
SampleQRCode(qrCodeBase64: "QBQCBCi6YzXaOADsEewR7A==",
symbolVersion: 1,
expectedMode: 4,
expectedString: "@"),
SampleQRCode(qrCodeBase64: "Q6aHR0cDovL2l0dW5lcy5hcHBsZS5jb20vdXMvYXBwL2VuY3ljbG9wYWVkaWEtYnJpdGFubmljYS9pZBAlv+XLtAU/bXQ9OA7BHsEQ==",
symbolVersion: 6,
expectedMode: 4,
expectedString: "http://itunes.apple.com/us/app/encyclopaedia-britannica/id"),
// QRCodePayload current only supports mode 4, .byte.
// This QR code will fail to parse.
SampleQRCode(qrCodeBase64: "caQVaHR0cHM6Ly9jcnVuY2hpZnkuY29tAOw=",
symbolVersion: 3,
expectedMode: 7,
expectedString: nil),
SampleQRCode(qrCodeBase64: "QyaHR0cHM6Ly9zaXRlcy5nb29nbGUuY29tL3NpdGUvcGVueWVsaWRpa2Fua2JhL2hvbWUOwR7A==",
symbolVersion: 3,
expectedMode: 4,
expectedString: "https://sites.google.com/site/penyelidikankba/home"),
SampleQRCode(qrCodeBase64: "QKSSBsb3ZlIHlvdQ7BHsEQ==",
symbolVersion: 1,
expectedMode: 4,
expectedString: "I love you"),
SampleQRCode(qrCodeBase64: "QZaHR0cDovL21lbW9yeW5vdGZvdW5kLmNvbQ7BHsEewR7A==",
symbolVersion: 2,
expectedMode: 4,
expectedString: "http://memorynotfound.com"),
// QRCodePayload current only supports mode 4, .byte.
// This QR code will fail to parse.
SampleQRCode(qrCodeBase64: "caQVaHR0cDovL2NydW5jaGlmeS5jb20vAOwR7BHsEewR7A==",
symbolVersion: 2,
expectedMode: 7,
expectedString: nil),
SampleQRCode(qrCodeBase64: "QXaHR0cDovL3d3dy5xcnN0dWZmLmNvbS8OwR7BHsEewR7A==",
symbolVersion: 2,
expectedMode: 4,
expectedString: "http://www.qrstuff.com/"),
SampleQRCode(qrCodeBase64: "QWaHR0cHM6Ly93d3cuZm91bmRpdC5pZQ7BHsEewR7BHsEQ==",
symbolVersion: 2,
expectedMode: 4,
expectedString: "https://www.foundit.ie"),
SampleQRCode(qrCodeBase64: "RRaHR0cDovL2J3LXdpbmVsaXN0LXdlYnNpdGUtcHJvZC5zMy13ZWJzaXRlLXVzLXdlc3QtMi5hbWF6b25hd3MuY29tL3dpbmVsaXN0LWRlbW8vDsEewR7BHsEewR7BHsEewR7BHsEewR7BHs",
symbolVersion: 5,
expectedMode: 4,
expectedString: "http://bw-winelist-website-prod.s3-website-us-west-2.amazonaws.com/winelist-demo/"),
SampleQRCode(qrCodeBase64: "QeaHR0cDovL3d3dy5yZWljaG1hbm4tcmFjaW5nLmRlDsEQ==",
symbolVersion: 2,
expectedMode: 4,
expectedString: "http://www.reichmann-racing.de"),
SampleQRCode(qrCodeBase64: "QjaHR0cDovL3d3dy5ocnQubXN1LmVkdS9icmlkZ2V0LWJlaGUOwR7BHsEewR7BHsEewR7BHsEQ==",
symbolVersion: 3,
expectedMode: 4,
expectedString: "http://www.hrt.msu.edu/bridget-behe"),
SampleQRCode(qrCodeBase64: "QISGVsbG8gOikOwR7BHsEewR7A==",
symbolVersion: 1,
expectedMode: 4,
expectedString: "Hello :)"),
SampleQRCode(qrCodeBase64: "QNSGVsbG8gV29ybGQhIIBgmIXEKSE/CmgASAMkAa6I2KAJDsEewR7BHsEew=",
symbolVersion: 3,
expectedMode: 4,
expectedString: "Hello World! "),
SampleQRCode(qrCodeBase64: "QPd3d3LnhhbWFyaW4uY29tDsEQ==",
symbolVersion: 1,
expectedMode: 4,
expectedString: "www.xamarin.com"),
SampleQRCode(qrCodeBase64: "QsaHR0cDovL3BhdGhzLmlvbmludGVyYWN0aXZlLmNvbS9xcmd1aWRlY292ZXIOwR7BHsEewR7BHsEewR7BHsEQ==",
symbolVersion: 4,
expectedMode: 4,
expectedString: "http://paths.ioninteractive.com/qrguidecover")
]
for sampleQRCode in sampleQRCodes {
let qrCodeBase64 = sampleQRCode.qrCodeBase64
let symbolVersion = sampleQRCode.symbolVersion
let expectedMode = sampleQRCode.expectedMode
let expectedString = sampleQRCode.expectedString
let qrCodeData: Data = Data(base64Encoded: qrCodeBase64)!
Logger.verbose("qrCodeBase64: \(qrCodeBase64)")
Logger.verbose("qrCodeData: \(qrCodeData.hexadecimalString)")
guard let payload = QRCodePayload.parse(
codewords: qrCodeData,
qrCodeVersion: symbolVersion) else {
if expectedMode != 4 {
Logger.warn("Could not parse payload; expected for non-.byte mode.")
} else {
XCTFail("Could not parse payload: \(expectedMode).")
}
continue
}
Logger.verbose("payload.symbolVersion: \(payload.version)")
Logger.verbose("payload.mode: \(payload.mode)")
Logger.verbose("payload.data: \(payload.data.hexadecimalString)")
XCTAssertEqual(payload.mode.rawValue, expectedMode)
if let expectedString = expectedString {
if let string = payload.asString {
Logger.verbose("payload.string: \(string)")
XCTAssertEqual(string, expectedString)
} else {
XCTFail("Missing string.")
}
} else {
XCTFail("Missing expectedString.")
}
}
}
}