test65 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb249a06581fa2e69553600dc88ec52b620db6d5
+  data.tar.gz: cdbc6072308051d64c07c61e0c9d07ded8319b2e
+SHA512:
+  metadata.gz: cca5d442da99eb33a2fcc40f40029e4981e03fddeb037cb7b1e8b5123235b2725e0bc40a4e9927e9bb394827535048b9e5ad7d93ad360e25f99cfba2517ddc59
+  data.tar.gz: fdb97d5bbe8f9c7671904ab4591749740e2860d544416a04e269d13a5caac869da6c3173997d7b756b2db21b6ec0ff2ccd8cfed7fd75a7834b164514e2c5fd01

data/.gitignore

@@ -0,0 +1,5 @@
+*.out
+*.o
+*.lst
+pkg
+foo

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at peter.c.camilleri@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in test65.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 PeterCamilleri
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,159 @@
+# Test65
+
+This is a simple program written to allow the testing of 65C02 code that
+I am writing for the Commander X 16 neo-retro computer.
+
+Note: This program has recently undergone a lot of upgrades and is now ready
+to release as a Ruby gem.
+
+## Installation
+
+To install, first install the cc65 compiler and ensure that it is available at
+the command line. You can test the required components with:
+
+    ca65 --version
+    ld65 --version
+    sim65 --version
+    set CC65_HOME
+
+Then to install the gem, use:
+
+    $ gem install test65
+
+## Usage
+
+    test65 - Run tests of 65c02 assembler code.
+
+    Usage: test65 {options} {files}
+
+    Options:
+      --debug,   -d    Show (really) detailed debug info. Not normally required.
+      --help, -h, -?   Display this message and exit.
+      --list,    -l    Generate list files for each test.
+      --map,     -m    Generate map files for each test.
+      --keep,    -k    Keep object and output files. Do not clean up.
+      --path,    -p    Specify the path to the test files. (Only 1 allowed)
+      --quiet,   -q    Hide messages. Used to keep the test65 tests clean.
+      --verbose, -v    Display lots of useful progress info.
+      --version        Display the program version and exit.
+
+    Files: An optional list of test files.
+
+    Notes:
+    - By default, test files are located in a folder called "t65" in the current
+      folder or one of its parent folders.
+    - Wildcards are allowed for files but not the path.
+    - If no files are specified, then all files matching "t65*.a65" or "t65*.rb"
+      in the test folder are tested.
+    - If files are specified, only the specified file(s) are tested.
+
+## Test Files
+
+The test65 utility finds test files in one of two ways:
+
+1. The test files can be listed explicitly on the command line.
+2. Test files, of the appropriate extension, located in the test folder, are
+"batch" run.
+
+The tests are located in a test folder. This can be:
+
+1. Explicitly named using the --path option. (See above)
+2. Located in the t65 folder, either off of the current folder, or one of
+its parent folders.
+
+Test files can be:
+
+1. Assembly files with a suffix of ".a65".
+2. Ruby script files with a suffix of ".rb".
+
+Future versions may support alternate extension types for assembler (like
+".asm" for example) and tests written in the "C" language with extensions
+of ".c65" and maybe ".c".
+
+## Test Scripts in Ruby
+
+The test65 gem uses Ruby scripts to allow for cases not handled by the
+conventional defaults. The basic form of these scripts is:
+
+```
+# Minimum script to pass a test.
+
+Test65.script do
+  ca65 "min_pass.a65"
+  ld65
+  sim65
+end
+```
+
+The order matters and is:
+
+    assembly and compiling then linking then simulation
+
+If the order is wrong, there will be errors.
+
+### Assembly
+
+Code is assembled using the _ca65_ statement. It is supported by the
+_ca65\_inc\_paths_ method. They are:
+
+```
+ca65_inc_paths <path>, <optional more paths>, <etc>, <etc>, <etc>
+ca65 "source_file", "optional options"
+```
+
+Where _ca65\_inc\_paths_ is used to tell the assembler where to find included
+files and _ca65_ does the work of converting the source file to an
+object file.
+
+### Linking
+
+Code is linked using the _ld65_ statement. It is supported by the
+_ld65\_lib\_paths_ and _ld65\_libraries_. Here they are:
+
+```
+ld65_lib_paths "path to libraries", <etc>, <etc>, <etc>
+ld65_libraries "library", <etc>, <etc>, <etc>
+ld65 "optional options"
+```
+
+Where _ld65\_lib\_paths_ tells the linker where to find library files and
+_ld65\_libraries_ specifies those libraries. After any ld65 method, no further
+ca65* methods are permitted. After _ld65_ no further ld65* methods are
+permitted either.
+
+### Simulation
+
+Finally, the simulation phase runs the actual tests. This is simply:
+
+```
+sim65 "optional options"
+```
+
+When this is done, no further test statements are permitted. However it is
+possible to perform multiple tests in one script file. Simply code
+multiple Test65.script { ... } blocks in the one Ruby script file. They
+will be run one after another, in order.
+
+## Contributing
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+OR...
+
+* Make a suggestion by raising an
+ [issue](https://github.com/PeterCamilleri/test65/issues)
+. All ideas and comments are welcome.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](./LICENSE.txt).
+
+## Code of Conduct
+
+Everyone interacting in the test65project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](./CODE_OF_CONDUCT.md).

data/asminc/test65.i65

@@ -0,0 +1,87 @@
+; Macro definitions for testing 65c02 code using sim65.
+
+.import exit:absolute ; Make sure we have this symbol defined.
+
+; Exit tests and return success!
+.macro tests_pass
+  lda #0
+  jmp exit
+.endmacro
+
+; Exit tests and return an error code :-(
+.macro tests_fail err_code
+  .ifconst err_code
+    .if (err_code < 2) || (err_code > 255)
+      .fatal "Invalid error code. Allowed values 2..255"
+    .endif
+
+    lda #err_code
+    jmp exit
+  .else
+    .fatal "Error code must be a constant"
+  .endif
+.endmacro
+
+; Exit tests and return an error code if the Z flag is cleared (ne)
+.macro fail_ne err_code
+  .local no_error
+  beq no_error
+  tests_fail err_code
+no_error:
+.endmacro
+
+; Exit tests and return an error code if the Z flag is set (eq)
+.macro fail_eq err_code
+  .local no_error
+  bne no_error
+  tests_fail err_code
+no_error:
+.endmacro
+
+; Exit tests and return an error code if the C flag is cleared (cc)
+.macro fail_cc err_code
+  .local no_error
+  bcs no_error
+  tests_fail err_code
+no_error:
+.endmacro
+
+; Exit tests and return an error code if the C flag is set (cs)
+.macro fail_cs err_code
+  .local no_error
+  bcc no_error
+  tests_fail err_code
+no_error:
+.endmacro
+
+; Exit tests and return an error code if the N flag is cleared (pl)
+.macro fail_pl err_code
+  .local no_error
+  bmi no_error
+  tests_fail err_code
+no_error:
+.endmacro
+
+; Exit tests and return an error code if the N flag is set (mi)
+.macro fail_mi err_code
+  .local no_error
+  bpl no_error
+  tests_fail err_code
+no_error:
+.endmacro
+
+; Exit tests and return an error code if the V flag is cleared (vc)
+.macro fail_vc err_code
+  .local no_error
+  bvs no_error
+  tests_fail err_code
+no_error:
+.endmacro
+
+; Exit tests and return an error code if the V flag is set (vs)
+.macro fail_vs err_code
+  .local no_error
+  bvc no_error
+  tests_fail err_code
+no_error:
+.endmacro

data/cfg/test65.cfg

@@ -0,0 +1,37 @@
+SYMBOLS {
+    __EXEHDR__:    type = import;
+    __STACKSIZE__: type = weak, value = $0800; # 2k stack
+}
+MEMORY {
+    ZP:     file = "",               start = $0000, size = $0100;
+    HEADER: file = %O,               start = $0000, size = $000C;
+    MAIN:   file = %O, define = yes, start = $0200, size = $FDF0 - __STACKSIZE__;
+}
+SEGMENTS {
+    ZEROPAGE:  load = ZP,     type = zp;
+    EXEHDR:    load = HEADER, type = ro;
+    STARTUP:   load = MAIN,   type = ro;
+    LOWCODE:   load = MAIN,   type = ro,  optional = yes;
+    ONCE:      load = MAIN,   type = ro,  optional = yes;
+    CODE:      load = MAIN,   type = ro;
+    RODATA:    load = MAIN,   type = ro;
+    PAGE_CODE: load = MAIN,   type = ro,  optional = yes, align = $100;
+    DATA:      load = MAIN,   type = rw;
+    PAGE_DATA: load = MAIN,   type = rw,  optional = yes, align = $100;
+    BSS:       load = MAIN,   type = bss, define   = yes;
+}
+FEATURES {
+    CONDES: type    = constructor,
+            label   = __CONSTRUCTOR_TABLE__,
+            count   = __CONSTRUCTOR_COUNT__,
+            segment = ONCE;
+    CONDES: type    = destructor,
+            label   = __DESTRUCTOR_TABLE__,
+            count   = __DESTRUCTOR_COUNT__,
+            segment = RODATA;
+    CONDES: type    = interruptor,
+            label   = __INTERRUPTOR_TABLE__,
+            count   = __INTERRUPTOR_COUNT__,
+            segment = RODATA,
+            import  = __CALLIRQ__;
+}

data/exe/test65

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+#The test65 command line script.
+
+require_relative '../lib/test65'
+
+Test65.process

data/help.txt

@@ -0,0 +1,24 @@
+test65 - Run tests of 65c02 assembler code.
+
+Usage: test65 {options} {files}
+
+Options:
+  --debug,   -d    Show (really) detailed debug info. Not normally required.
+  --help, -h, -?   Display this message and exit.
+  --list,    -l    Generate list files for each test.
+  --map,     -m    Generate map files for each test.
+  --keep,    -k    Keep object and output files. Do not clean up.
+  --path,    -p    Specify the path to the test files. (Only 1 allowed)
+  --quiet,   -q    Hide messages. Used to keep the test65 tests clean.
+  --verbose, -v    Display lots of useful progress info.
+  --version        Display the program version and exit.
+
+Files: An optional list of test files.
+
+Notes:
+- By default, test files are located in a folder called "t65" in the current
+  folder or one of its parent folders.
+- Wildcards are allowed for files but not the path.
+- If no files are specified, then all files matching "t65*.a65" or "t65*.rb"
+  in the test folder are tested.
+- If files are specified, only the specified file(s) are tested.

data/lib/test65.rb

@@ -0,0 +1,50 @@
+# test65
+
+require 'english'
+require 'getoptlong'
+require 'pathname'
+require 'rbconfig'
+require 'full_dup'
+
+require_relative 'test65/perform_test'
+require_relative 'test65/process_files'
+require_relative 'test65/process_args'
+require_relative 'test65/process_path'
+require_relative 'test65/build_file_list'
+require_relative 'test65/std_path'
+require_relative 'test65/host'
+require_relative 'test65/version'
+
+module Test65
+
+  #Figure out where the gem root folder is located
+  lib_path = File.dirname(File.absolute_path(__FILE__))
+  @gem_root = Pathname.new(lib_path).parent.to_s
+  @asminc = @gem_root + "/asminc"   # TODO remove this variable.
+
+  # Figure out where the compiler is.
+  temp = ENV["CC65_HOME"]
+  fail "The CC65_HOME variable is not set." unless temp
+  @cc65_home = temp.standardize_path
+
+  # The code entry point. Run some 65c02 tests.
+  # Returns
+  #   0 for success
+  #   Other for failure
+  def self.process
+    process_args
+    process_path
+    build_file_list
+    process_file_list
+
+  rescue => err
+    puts "Error: #{err.to_s}"
+    puts err.backtrace if @options[:debug]
+    exit(1)
+
+  ensure
+    # Always remove this file if it exists.
+    File.delete("_kwhyit") if File.exists?("_kwhyit")
+  end
+
+end

data/lib/test65/build_file_list.rb

@@ -0,0 +1,37 @@
+# Build the list of test and library files to be processed.
+
+module Test65
+  # Find the files to be tested.
+  def self.build_file_list
+    if @arg_files.empty?
+      scan_files
+    else
+      check_files
+    end
+
+    puts "Processing #{@test_files.length} test file(s)" if @options[:verbose]
+  end
+
+  # Scan the path for files to be processed.
+  def self.scan_files
+    @test_files = Dir.glob(@options[:path] + "/t65*.a65") +
+                  Dir.glob(@options[:path] + "/t65*.rb")
+    fail "Cannot locate any test files" if @test_files.empty?
+  end
+
+  # Check the list of files to be processed.
+  def self.check_files
+    @test_files = @arg_files.map do |file|
+      std_file = file.standardize_path
+
+      if !(found = Dir.glob(std_file)).empty?
+        found.map {|subfile| File.absolute_path(file) }
+      elsif !(found = Dir.glob(@options[:path] + "/" + std_file)).empty?
+        found
+      else
+        fail "Cannot locate the file #{file}"
+      end
+    end.flatten
+  end
+
+end

data/lib/test65/enclosures/ca65.rb

@@ -0,0 +1,35 @@
+# An enclosure for the ca65 assembler.
+class TestScript
+
+  # Setup ca65
+  def ca65_initialize
+    @options[:target] = "sim65c02"
+    @options[:ca65_paths] = ["#{@options[:gem_root]}/asminc"]
+    @options[:objs] = []
+  end
+
+  # Add some include paths for the assembler.
+  def ca65_inc_paths(*more_paths)
+    fail "Sequence error: ca65_inc_paths" unless @phase == :create
+    append_option(:inc_paths, more_paths)
+  end
+
+  # Assemble some files.
+  def ca65(file, options="")
+    fail "Sequence error: ca65" unless @phase == :create
+    source  = File.absolute_path(@options[:path] + "/" + file)
+    target  = "--target #{@options[:target]} "
+    paths   = build_args("-I", @options[:ca65_paths])
+
+    # Convert source assemble files into object files.
+    object = change_type(source, ".o")
+    list   = @options[:list] ? "-l " + change_type(source, ".lst") : ""
+    command = "ca65 #{target}#{paths}#{list}#{options} -o #{object} #{source} #{@quiet}\n"
+    puts command if @options[:debug]
+    system(command)
+    fail "Error assembling #{source.localize_path}" unless $?.exitstatus == 0
+
+    @options[:objs] << object
+  end
+
+end

data/lib/test65/enclosures/ld65.rb

@@ -0,0 +1,46 @@
+# An enclosure for the ld65 linker.
+
+class TestScript
+
+  # Setup ld65
+  def ld65_initialize
+    @options[:lib_paths] = []
+    @options[:libraries] = ["sim65c02.lib"]
+    @options[:ld65_options] = []
+    @options[:config] = "#{@options[:gem_root]}/cfg/test65.cfg"
+  end
+
+  # Add some library paths for the linker.
+  def ld65_lib_paths(*more_paths)
+    fail "Sequence error: ld65_lib_paths" unless [:create, :link].include?(@phase)
+    append_option(:lib_paths, more_paths)
+    @phase = :link
+  end
+
+  # Add some library paths for the linker.
+  def ld65_libraries(*more_libs)
+    fail "Sequence error: ld65_libraries" unless [:create, :link].include?(@phase)
+    append_option(:libraries, more_libs)
+    @phase = :link
+  end
+
+  def ld65(options="")
+    fail "Sequence error: ld65" unless [:create, :link].include?(@phase)
+    @phase = :simulate
+
+    @output   = change_type(@options[:objs][0], ".out")
+    @map_file = change_type(@options[:objs][0], ".map")
+    lib_paths = build_args("--lib-path", @options[:lib_paths])
+    objs      = build_args(@options[:objs])
+    libs      = build_args("--lib", @options[:libraries])
+    map       = @options[:map] ? "-m #{@map_file}" : ""
+    cfg       = "-C " + @options[:config] + " "
+
+    # Build the command and run it.
+    command = "ld65 #{lib_paths}#{libs}#{cfg}#{options} #{objs}#{map} -o #{@output} #{@quiet}\n"
+    puts command if @options[:debug]
+    system(command)
+    fail "Error linking #{@output.localize_path}." unless $?.exitstatus == 0
+  end
+
+end

data/lib/test65/enclosures/sim65.rb

@@ -0,0 +1,23 @@
+# An enclosure for the sim65 simulator.
+
+class TestScript
+
+  # Setup sim65
+  def sim65_initialize
+    @options[:sim65_options] = []
+  end
+
+  # Run the simulator to get the actual test results.
+  def sim65(options="")
+    fail "Sequence error: sim65" unless @phase == :simulate
+    @phase = :done
+
+    # Build the command and run it.
+    command = "sim65 #{options} #{@output} #{@quiet}\n"
+    puts command if @options[:debug]
+    system(command)
+    status = $?.exitstatus
+    fail "Test #{@output.localize_path} failed with error code: #{status}" unless status == 0
+  end
+
+end

data/lib/test65/enclosures/utils.rb

@@ -0,0 +1,26 @@
+# Utility methods
+
+class TestScript
+
+  # Create a file name with a new extension.
+  def change_type(file, new_ext)
+    file.gsub(/\...?.?\z/, new_ext)
+  end
+
+  # Construct a series of arguments.
+  def build_args(prefix = nil, args)
+    pre = prefix ? prefix + " " : ""
+    args.inject("") {|str, arg| str << pre + arg + " "}
+  end
+
+  # Append to an option.
+  def append_option(key, *value)
+    @options[key] = ((@options[key] || []) + [value]).flatten
+  end
+
+  # Adjust a list of files to include the path to the test file.
+  def adjust(files)
+    files.map { |file| @options[:path] + "/" + file }
+  end
+
+end

data/lib/test65/host.rb

@@ -0,0 +1,13 @@
+# Is this program running on a Windows host?
+
+class Object
+
+private
+
+  # Are we running under Windows?
+  def windows?
+    # Is this a Windows based system
+    @win ||= RbConfig::CONFIG['host_os'] =~ /mswin|msys|mingw|bccwin|wince|emc/
+  end
+
+end

data/lib/test65/perform_test.rb

@@ -0,0 +1,45 @@
+# Run a test script for the test65 program.
+
+require_relative 'enclosures/utils'
+require_relative 'enclosures/ca65'
+require_relative 'enclosures/ld65'
+require_relative 'enclosures/sim65'
+
+class TestScript
+
+  # Create a test script object and set up its default options.
+  def initialize(options={})
+    @options = options.full_dup
+    @phase   = :create
+
+    ca65_initialize
+    ld65_initialize
+    sim65_initialize
+
+    @quiet = @options[:quiet].to_s
+  end
+
+  # Cleanup after ourselves
+  def clean_up
+    # Remove objects and executable unless told to keep them.
+    unless @options[:keep]
+      File.delete(@output) if File.exists?(@output)
+
+      @options[:objs].each do |file|
+        File.delete(file) if File.exists?(file)
+      end
+    end
+
+    # Remove listing files unless they were requested.
+    unless @options[:list]
+      @options[:objs].each do |file|
+        file = change_type(file, ".lst")
+        File.delete(file) if File.exists?(file)
+      end
+    end
+
+    # Remove the map file if needed.
+    File.delete(@map_file) if !@options[:map] && File.exists?(@map_file)
+  end
+
+end

data/lib/test65/process_args.rb

@@ -0,0 +1,66 @@
+# Process the command line arguments for the test65 program.
+
+module Test65
+  # Process the command line arguments.
+  def self.process_args
+    @options = {}
+
+    opts = GetoptLong.new(
+      ["--debug",      "-d",       GetoptLong::NO_ARGUMENT],
+      ["--help",       "-h", "-?", GetoptLong::NO_ARGUMENT],
+      ["--list",       "-l",       GetoptLong::NO_ARGUMENT],
+      ["--map",        "-m",       GetoptLong::NO_ARGUMENT],
+      ["--keep",       "-k",       GetoptLong::NO_ARGUMENT],
+      ["--path",       "-p",       GetoptLong::REQUIRED_ARGUMENT],
+      ["--quiet",      "-q",       GetoptLong::NO_ARGUMENT],
+      ["--verbose",    "-v",       GetoptLong::NO_ARGUMENT],
+      ["--version",                GetoptLong::NO_ARGUMENT])
+
+    opts.each do |opt, arg|
+      case opt
+      when "--debug"
+        @options[:debug] = true
+      when "--help"
+        puts IO.read(@gem_root + "/help.txt")
+        exit
+      when "--keep"
+        @options[:keep] = true
+      when "--list"
+        @options[:list] = true
+      when "--map"
+        @options[:map] = true
+      when "--path"
+        unless @options[:path]
+          @options[:path] = File.absolute_path(arg.standardize_path)
+        else
+          fail "Multiple path options are not allowed."
+        end
+      when "--quiet"
+        @options[:quiet] = "2> _kwhyit"
+      when "--verbose"
+        @options[:verbose] = true
+      when "--version"
+        puts "test65 Version #{VERSION}"
+        exit
+      else
+        fail "Invalid option: #{opt}"
+      end
+    end
+
+    # A list of files to test may follow the options.
+    @arg_files = ARGV
+
+    # Setup some default paths
+    @options[:gem_root]   = @gem_root
+    @options[:ca65_paths] = @gem_root + "/asminc"
+    @options[:cc65_home]  = @cc65_home
+
+  rescue => err
+    puts "Error: #{err.to_s}"
+    puts err.backtrace if @options[:debug]
+    puts
+    puts IO.read(@gem_root + "/help.txt")
+    exit
+  end
+
+end

data/lib/test65/process_files.rb

@@ -0,0 +1,48 @@
+# Process the test files.
+
+module Test65
+
+  # Process the list of files
+  def self.process_file_list
+    @error_count = 0
+
+    @test_files.each do |file|
+      process_file(file)
+    end
+
+    if @error_count > 0
+      fail "#{@error_count} tests failed."
+    else
+      puts "OK: All tests passed."
+    end
+  end
+
+  # Process a file.
+  def self.process_file(file)
+    puts file.localize_path if @options[:verbose]
+
+    case File.extname(file)
+    when ".a65"
+      script { ca65(File.basename(file)); ld65; sim65 }
+
+    when ".rb"
+      load file
+
+    else
+      fail "Don't know how to process #{file}"
+    end
+  end
+
+  # Process a test script.
+  def self.script(&block)
+    test_script = TestScript.new(@options)
+    test_script.instance_exec(&block)
+  rescue => err
+    puts err
+    puts err.backtrace if @options[:debug]
+    @error_count += 1
+  ensure
+    test_script.clean_up
+  end
+
+end

data/lib/test65/process_path.rb

@@ -0,0 +1,36 @@
+# Process the path to the test files.
+
+module Test65
+
+  # Determine the path to test files.
+  def self.process_path
+    path = @options[:path] || get_default_path
+
+    localized_path = path.localize_path
+    fail "Path #{localized_path} does not exist."  unless File.exists?(path)
+    fail "Path #{localized_path} is not a folder." unless File.directory?(path)
+    puts "Using path: #{localized_path}" if @options[:verbose]
+
+    @options[:path] = path
+  end
+
+  # Get the default test file path if one was not supplied.
+  def self.get_default_path
+    search, parent = Pathname.new(Dir.pwd), nil
+
+    while true
+      test = search.to_s + "/t65"
+
+      if File.exists?(test)
+        return test if File.directory?(test)
+        fail "The file #{local_path(test)} is not a folder."
+      end
+
+      search, parent = search.parent, search
+
+      fail "Default path not found." if search == parent
+    end
+
+  end
+
+end

data/lib/test65/std_path.rb

@@ -0,0 +1,15 @@
+# Portable path handling methods for the Test65 program.
+
+class String
+
+  # Convert a path into standard form.
+  def standardize_path
+    self.gsub("\\", "/")
+  end
+
+  # Convert a path string into local system form.
+  def localize_path
+    windows? ? self.gsub("/", "\\") : self
+  end
+
+end

data/lib/test65/version.rb

@@ -0,0 +1,5 @@
+module Test65
+  VERSION = "0.5.0".freeze
+
+  DESCRIPTION = "test65: A testing framework for ca65.".freeze
+end

data/rakefile.rb

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test
+
+desc "What version of test65 is this?"
+task :vers do |t|
+  puts
+  puts "test65 version = #{::Test65::VERSION}"
+end

data/t65/asm_err.a65

@@ -0,0 +1,12 @@
+; See how we deal with an assembly error.
+
+.import exit:absolute
+.export _main
+
+.pc02
+
+.code
+
+_main:
+  lad #0    ; Deliberate error
+  jmp exit

data/t65/callee.a65

@@ -0,0 +1,14 @@
+; Test a script with multiple objects
+
+.export add_two:absolute
+.pc02
+.code
+
+.ifdef do_add_two
+
+add_two:
+  clc
+  adc #2
+  rts
+
+.endif

data/t65/caller.a65

@@ -0,0 +1,17 @@
+; Test a script with multiple objects
+.include "test65.i65"
+
+.import exit:absolute
+.import add_two:absolute
+.export _main
+
+.pc02
+
+.code
+
+_main:
+  lda #10
+  jsr add_two
+  cmp #12
+  fail_ne 10
+  tests_pass

data/t65/foo.txt

@@ -0,0 +1,3 @@
+See how we deal with a nonsense file.
+foo foo foo foo foo foo
+bar bar bar bar bar bar

data/t65/linker_err.a65

@@ -0,0 +1,13 @@
+; See how we deal with a linker error.
+
+.import exit:absolute
+.import an_error:absolute
+.export _main
+
+.pc02
+
+.code
+
+_main:
+  lda an_error
+  jmp exit

data/t65/macro_err1.a65

@@ -0,0 +1,11 @@
+; Test detecting an invalid err code.
+
+.include "test65.i65"
+.export _main
+.pc02
+
+.code
+
+_main:
+  tests_fail 1
+  tests_pass

data/t65/macro_err2.a65

@@ -0,0 +1,12 @@
+; Test detecting an non-constant err code.
+
+.include "test65.i65"
+.export _main
+.import an_error
+.pc02
+
+.code
+
+_main:
+  tests_fail an_error
+  tests_pass

data/t65/min_fail.a65

@@ -0,0 +1,12 @@
+; Minimum code that fails a test
+
+.import exit:absolute
+.export _main
+
+.pc02
+
+.code
+
+_main:
+  lda #$ff
+  jmp exit

data/t65/min_pass.a65

@@ -0,0 +1,12 @@
+; Minimum code that passes a test
+
+.import exit:absolute
+.export _main
+
+.pc02
+
+.code
+
+_main:
+  lda #0
+  jmp exit

data/t65/min_pass.rb

@@ -0,0 +1,9 @@
+# Minimum script to pass a test.
+
+Test65.script do
+
+  ca65 "min_pass.a65"
+  ld65
+  sim65
+
+end

data/t65/pass.a65

@@ -0,0 +1,10 @@
+; Minimum code that passes a test
+
+.include "test65.i65"
+.export _main
+.pc02
+
+.code
+
+_main:
+  tests_pass

data/t65/t65_min_pass.rb

@@ -0,0 +1,9 @@
+# Minimum script to pass a test.
+
+Test65.script do
+
+  ca65 "min_pass.a65"
+  ld65
+  sim65
+
+end

data/t65/t65_test_cfg.a65

@@ -0,0 +1,13 @@
+; Minimum code that passes a test
+
+.include "test65.i65"
+.export _main
+.pc02
+
+.zeropage
+mem1: .res 32
+
+.code
+
+_main:
+  tests_pass

data/t65/t65_test_macros.a65

@@ -0,0 +1,37 @@
+; Test a whole bunch of macros!
+
+.include "test65.i65"
+.export _main
+.pc02
+
+.code
+
+_main:
+  lda #$00
+  fail_ne 10
+
+  inc
+  fail_eq 20
+  fail_mi 30
+
+  dec
+  dec
+  fail_pl 40
+
+  clc
+  adc #$02
+  fail_cc 50
+
+  clc
+  adc #$00
+  fail_cs 60
+
+  clv
+  fail_vs 70
+
+  lda #$70
+  clc
+  adc #$70
+  fail_vc 80
+
+  tests_pass

data/t65/t65_two_files.rb

@@ -0,0 +1,10 @@
+# Test a script with two source files.
+
+Test65.script do
+
+  ca65 "caller.a65"
+  ca65 "callee.a65", "-D do_add_two"
+  ld65
+  sim65
+
+end

data/test65.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "test65/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "test65"
+  spec.version       = Test65::VERSION
+  spec.authors       = ["PeterCamilleri"]
+  spec.email         = ["peter.c.camilleri@gmail.com"]
+
+  spec.summary       = Test65::DESCRIPTION
+  spec.description   = "A testing framework for work on the Commander X 16."
+  spec.homepage      = "https://github.com/PeterCamilleri/test65"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+                          f.match(%r{^(test|docs)/})
+                        end
+  spec.bindir        = "exe"
+  spec.executables   = spec
+                         .files
+                         .reject { |f| f.downcase == 'exe/readme.md'}
+                         .grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "full_dup"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: test65
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- PeterCamilleri
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: full_dup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A testing framework for work on the Commander X 16.
+email:
+- peter.c.camilleri@gmail.com
+executables:
+- test65
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- asminc/test65.i65
+- cfg/test65.cfg
+- exe/test65
+- help.txt
+- lib/test65.rb
+- lib/test65/build_file_list.rb
+- lib/test65/enclosures/ca65.rb
+- lib/test65/enclosures/ld65.rb
+- lib/test65/enclosures/sim65.rb
+- lib/test65/enclosures/utils.rb
+- lib/test65/host.rb
+- lib/test65/perform_test.rb
+- lib/test65/process_args.rb
+- lib/test65/process_files.rb
+- lib/test65/process_path.rb
+- lib/test65/std_path.rb
+- lib/test65/version.rb
+- rakefile.rb
+- t65/asm_err.a65
+- t65/callee.a65
+- t65/caller.a65
+- t65/foo.txt
+- t65/linker_err.a65
+- t65/macro_err1.a65
+- t65/macro_err2.a65
+- t65/min_fail.a65
+- t65/min_pass.a65
+- t65/min_pass.rb
+- t65/pass.a65
+- t65/t65_min_pass.rb
+- t65/t65_test_cfg.a65
+- t65/t65_test_macros.a65
+- t65/t65_two_files.rb
+- test65.gemspec
+homepage: https://github.com/PeterCamilleri/test65
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: 'test65: A testing framework for ca65.'
+test_files: []