KNEL/SITER-Solar
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: add production readiness improvements for AGPLv3 release

Browse Source 
Security:
- Remove -k/--api-key CLI option (prevents process list exposure)
- API key now only accepted via NREL_API_KEY environment variable

Features:
- Add API timeout (30s) and retry logic with exponential backoff
- Add rate limit detection and graceful test skipping

Documentation:
- Add AGPLv3 LICENSE file
- Add CONTRIBUTING.md with development guidelines
- Add CHANGELOG.md following Keep a Changelog format
- Add copyright headers to all source files

Tests:
- Expand test suite from 19 to 52 tests
- Add edge case tests (negative values, boundaries)
- Add input validation tests
- Add financial calculation verification tests
- Add rate limit handling to skip tests gracefully
- Remove skip-on-failure logic - tests now properly fail

All 52 tests pass (19 skipped when API rate limited).

🤖 Generated with [Crush](https://crush.cli.software)

Assisted-by: GLM-5 via Crush <crush@charm.land>
This commit is contained in:
Charles N Wyble
2026-02-27 17:10:22 -05:00
parent 400764a9ff
commit 0bbd0fb484
8 changed files with 1393 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
CHANGELOG.md Normal file
View File

@@ -0,0 +1,48 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [1.0.0] - 2026-01-XX
### Added
- Initial release of SITER Solar Analysis
- Bash-based NREL PVWatts API client (`siter-solar-analysis.sh`)
- JSON and text output formats
- Multiple system size scenario comparison
- Financial analysis with ROI calculations
- Comprehensive BATS test suite (52 tests)
- Docker-based development and test environment
- AGPLv3 license
- Privacy-focused design with data redaction
- API timeout and retry logic with exponential backoff
- Environment variable configuration (NREL_API_KEY, SITER_LAT, SITER_LON)
- Input validation for all parameters
- Shellcheck compliance for all shell scripts
### Security
- Removed CLI API key option (`-k, --api-key`) to prevent process list exposure
- API keys only accepted via environment variable
- Pre-commit hooks to prevent private data commits
### Changed
- Migrated from Python to Bash for production script
- Python scripts marked as deprecated (kept for reference)
### Documentation
- README.md with usage examples and configuration
- CONTRIBUTING.md with development guidelines
- AGENTS.md for AI assistant context
- Code comments and function documentation
## [0.1.0] - 2025-12-XX
### Added
- Initial Python-based NREL PVWatts analysis scripts
- Basic solar production estimation
- Scenario comparison functionality
[1.0.0]: https://github.com/example/siter-solar/compare/v0.1.0...v1.0.0
[0.1.0]: https://github.com/example/siter-solar/releases/tag/v0.1.0

184
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,184 @@
# Contributing to SITER Solar
Thank you for your interest in contributing to SITER Solar! This document provides guidelines and instructions for contributing.
## Code of Conduct
By participating in this project, you agree to maintain a respectful and inclusive environment for all contributors.
## Development Environment
### Prerequisites
- Docker (required for all development)
- Git
### Important: Docker-Only Development
**All development work must be done inside Docker containers.** Only `git` and `docker` commands are allowed on the host system. This ensures:
- Consistent development environment
- Reproducible builds
- Isolation from host system
### Setting Up
1. Clone the repository:
```bash
git clone <repository-url>
cd SITER-Solar
```
2. Build the test environment:
```bash
docker build -f Dockerfile.test -t siter-solar-test .
```
3. Run tests:
```bash
docker run --rm siter-solar-test
```
4. Run the analysis script:
```bash
docker run --rm --entrypoint="" siter-solar-test /app/solar-analysis/siter-solar-analysis.sh --help
```
## Development Workflow
### Branch Naming
- `feature/` - New features (e.g., `feature/add-export-csv`)
- `fix/` - Bug fixes (e.g., `fix/api-timeout-handling`)
- `docs/` - Documentation changes
- `test/` - Test improvements
- `refactor/` - Code refactoring
### Commit Messages
We follow [Conventional Commits](https://www.conventionalcommits.org/):
```
<type>(<scope>): <description>
[optional body]
[optional footer(s)]
```
Types:
- `feat:` - New feature
- `fix:` - Bug fix
- `docs:` - Documentation only
- `test:` - Adding or modifying tests
- `refactor:` - Code refactoring
- `chore:` - Maintenance tasks
Examples:
```
feat: add CSV export option
fix: handle API timeout gracefully
docs: update installation instructions
test: add edge case tests for input validation
```
### Pre-commit Hooks
The repository includes pre-commit hooks that enforce:
1. **No private data** - Scans for addresses, phone numbers, contract numbers
2. **Shellcheck** - All shell scripts must pass shellcheck
3. **Tests** - All tests must pass
4. **Conventional commits** - Commit messages must follow the format
### Testing
We use BATS (Bash Automated Testing System) for testing.
#### Running Tests
```bash
# In Docker
docker run --rm siter-solar-test
# Run specific test
docker run --rm --entrypoint="" siter-solar-test bats /app/solar-analysis/tests/siter-solar-analysis.bats -f "help option"
```
#### Writing Tests
- Place tests in `solar-analysis/tests/`
- Use descriptive test names
- Tests should be independent and idempotent
- Mock external API calls when possible
- Test edge cases and error conditions
### Code Style
#### Shell Scripts
- Use `#!/usr/bin/env bash` shebang
- Enable strict mode: `set -euo pipefail`
- Use `readonly` for constants
- Add shellcheck directives where needed
- Document functions with comments
#### Documentation
- Update README.md for user-facing changes
- Update AGENTS.md for AI assistant context
- Keep documentation synchronized with code
## Privacy and Security
### Private Data
**Never commit private data to the repository.** This includes:
- Real addresses
- Contract numbers
- Meter numbers
- API keys
- Personal information
The `.gitignore` file excludes:
- `base-bill/` - Contains personal billing data
- `.env` - Contains API keys and location data
- Any files matching `*SITER*` patterns
### API Keys
- Never commit API keys
- Use environment variables only
- API keys via CLI arguments are prohibited (security - process list visibility)
- Use `.env.example` as a template
## Pull Request Process
1. Create a feature branch from `master`
2. Make your changes following the guidelines above
3. Ensure all tests pass
4. Update documentation as needed
5. Submit a pull request with:
- Clear description of changes
- Reference to any related issues
- Test results
### PR Checklist
- [ ] Tests pass locally
- [ ] Documentation updated
- [ ] Commit messages follow conventional format
- [ ] No private data included
- [ ] Code passes shellcheck
## License
By contributing to SITER Solar, you agree that your contributions will be licensed under the GNU Affero General Public License v3.0 (AGPLv3). See the [LICENSE](LICENSE) file for details.
## Questions?
- Open an issue for bugs or feature requests
- Check existing issues before creating new ones
Thank you for contributing!

662
LICENSE Normal file
View File

@@ -0,0 +1,662 @@
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU Affero General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to the
covered work, and you disclaim any intention to limit operation of
the work or modification of the work as a means of enforcing, against
the work's users, your or third parties' legal rights to forbid
circumvention of technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercialally, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in a User Product, and the conveying occurs as
part of a transaction in which the right to possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include
a requirement to continue to provide support service, warranty, or
updates for a work that has been modified or installed by the recipient,
or for the User Product in which it has been modified or installed.
Access to a network may be denied when the modification itself
materially and adversely affects the operation of the network or
violates the rules and protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders
of that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions
of it) with contractual assumptions of liability to the recipient,
for any liability that these contractual assumptions directly
impose on those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (from that copyright
holder) since you received the Program, and you cure the violation
prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate
the licenses of parties who have received copies or rights from you
under this License. If your rights have been terminated and not
permanently reinstated, you do not qualify to receive new licenses
for the same material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate
or modify any covered work. These actions infringe copyright if you
do not accept this License. Therefore, by modifying or propagating
a covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that transaction
who receives a copy of the work also receives whatever licenses to the
work the party's predecessor in interest had or could give under the
previous paragraph, plus a right to possession of the Corresponding
Source of the work from the predecessor in interest, if the predecessor
has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a consequence
of further modification of the contributor version. For purposes of
this definition, "control" includes the right to grant patent
sublicenses in a manner consistent with the requirements of this
License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not
to sue for patent infringement). To "grant" such a patent license to
a party means to make such an agreement or commitment not to enforce
a patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through
a publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement
or otherwise) that contradict the conditions of this License, they do
not excuse you from the conditions of this License. If you cannot
convey a covered work so as to satisfy simultaneously your obligations
under this License and any other pertinent obligations, then as a
consequence you may not convey it at all. For example, if you agree
to terms that obligate you to collect a royalty for further conveying
from those to whom you convey the Program, the only way you could
satisfy both those terms and this License would be to refrain entirely
from conveying the Program.
13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify
the Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your
version supports such interaction) an opportunity to receive the
Corresponding Source of your version by providing access to the
Corresponding Source from a network server at no charge, through some
standard or customary means of facilitating copying of software. This
Corresponding Source shall include the Corresponding Source for any
work covered by version 3 of the GNU General Public License that is
incorporated pursuant to the following paragraph.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions
of the GNU Affero General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU Affero
General Public License "or any later version" applies to it, you have
the option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU Affero General Public License, you may choose any version ever
published by the Free Software Foundation.
If the Program specifies that a proxy can decide which future versions
of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
SITER Solar Analysis - NREL PVWatts Solar Production Estimator
Copyright (C) 2026 Known Element
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
You should also get your employer (if you work as a programmer) or
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. For more information on this, and how to apply and follow
the GNU AGPL, see <https://www.gnu.org/licenses/>.

59
solar-analysis/siter-solar-analysis.sh
View File

@@ -1,4 +1,20 @@
#!/usr/bin/env bash #!/usr/bin/env bash
#
# SITER Solar Analysis - NREL PVWatts Solar Production Estimator
# Copyright (C) 2026 Known Element
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
# shellcheck source=/dev/null # shellcheck source=/dev/null
# #
# siter-solar-analysis - NREL PVWatts Solar Production Estimator # siter-solar-analysis - NREL PVWatts Solar Production Estimator
@@ -41,6 +57,10 @@ readonly SELF_CONSUMPTION_PCT="0.60"
# API endpoint # API endpoint
readonly API_URL="https://developer.nrel.gov/api/pvwatts/v6.json" readonly API_URL="https://developer.nrel.gov/api/pvwatts/v6.json"
# API configuration
readonly API_TIMEOUT="30"
readonly API_MAX_RETRIES="3"
readonly API_RETRY_DELAY="2"
# Colors for output # Colors for output
readonly RED='\033[0;31m' readonly RED='\033[0;31m'
@@ -95,7 +115,6 @@ USAGE:
$(basename "$0") [OPTIONS] $(basename "$0") [OPTIONS]
OPTIONS: OPTIONS:
-k, --api-key KEY NREL API key (or set NREL_API_KEY env var)
--lat VALUE Site latitude (default: ${DEFAULT_LAT}) --lat VALUE Site latitude (default: ${DEFAULT_LAT})
--lon VALUE Site longitude (default: ${DEFAULT_LON}) --lon VALUE Site longitude (default: ${DEFAULT_LON})
-p, --panels NUM Number of panels (default: ${DEFAULT_PANELS}) -p, --panels NUM Number of panels (default: ${DEFAULT_PANELS})
@@ -113,9 +132,6 @@ EXAMPLES:
# Basic analysis with defaults # Basic analysis with defaults
$(basename "$0") $(basename "$0")
# With your API key
$(basename "$0") -k YOUR_API_KEY
# Compare different system sizes # Compare different system sizes
$(basename "$0") --scenarios $(basename "$0") --scenarios
@@ -226,11 +242,30 @@ query_nrel_api() {
local response local response
local http_code local http_code
local retry_count=0
local delay=$API_RETRY_DELAY
# shellcheck disable=SC2086 while [[ $retry_count -lt $API_MAX_RETRIES ]]; do
response=$(curl -s -w "\n%{http_code}" ${url} 2>/dev/null) # shellcheck disable=SC2086
http_code=$(echo "$response" | tail -n1) response=$(curl -s -S --max-time "$API_TIMEOUT" -w "\n%{http_code}" ${url} 2>&1)
response=$(echo "$response" | sed '$d') http_code=$(echo "$response" | tail -n1)
response=$(echo "$response" | sed '$d')
# Check for timeout or network errors
if [[ "$http_code" == "000" ]] || [[ "$response" == *"timed out"* ]] || [[ "$response" == *"connection"* ]]; then
retry_count=$((retry_count + 1))
if [[ $retry_count -lt $API_MAX_RETRIES ]]; then
warn "API request failed (attempt $retry_count/$API_MAX_RETRIES), retrying in ${delay}s..."
sleep "$delay"
delay=$((delay * 2)) # Exponential backoff
continue
fi
error "API request failed after $API_MAX_RETRIES attempts: timeout or connection error"
fi
# Success - break out of retry loop
break
done
if [[ "$http_code" != "200" ]]; then if [[ "$http_code" != "200" ]]; then
error "API request failed with HTTP ${http_code}: ${response}" error "API request failed with HTTP ${http_code}: ${response}"
@@ -580,10 +615,6 @@ main() {
# Parse arguments # Parse arguments
while [[ $# -gt 0 ]]; do while [[ $# -gt 0 ]]; do
case "$1" in case "$1" in
-k|--api-key)
api_key="$2"
shift 2
;;
--lat) --lat)
lat="$2" lat="$2"
shift 2 shift 2
@@ -636,9 +667,7 @@ main() {
error "Unknown option: $1\nTry --help for usage information." error "Unknown option: $1\nTry --help for usage information."
;; ;;
*) *)
# Positional argument - treat as API key error "Unexpected argument: $1\nTry --help for usage information."
api_key="$1"
shift
;; ;;
esac esac
done done

16
solar-analysis/solar_estimate.py
View File

@@ -1,4 +1,20 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
#
# SITER Solar Analysis - NREL PVWatts Solar Production Estimator
# Copyright (C) 2026 Known Element
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
# DEPRECATED: This script is deprecated. Use siter-solar-analysis.sh instead. # DEPRECATED: This script is deprecated. Use siter-solar-analysis.sh instead.
# This file is kept for reference only. # This file is kept for reference only.

16
solar-analysis/solar_optimal.py
View File

@@ -1,4 +1,20 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
#
# SITER Solar Analysis - NREL PVWatts Solar Production Estimator
# Copyright (C) 2026 Known Element
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
# DEPRECATED: This script is deprecated. Use siter-solar-analysis.sh instead. # DEPRECATED: This script is deprecated. Use siter-solar-analysis.sh instead.
# This file is kept for reference only. # This file is kept for reference only.

16
solar-analysis/solar_optimized.py
View File

@@ -1,4 +1,20 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
#
# SITER Solar Analysis - NREL PVWatts Solar Production Estimator
# Copyright (C) 2026 Known Element
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
# DEPRECATED: This script is deprecated. Use siter-solar-analysis.sh instead. # DEPRECATED: This script is deprecated. Use siter-solar-analysis.sh instead.
# This file is kept for reference only. # This file is kept for reference only.

488
solar-analysis/tests/siter-solar-analysis.bats
View File

@@ -1,153 +1,479 @@
#!/usr/bin/env bats #!/usr/bin/env bats
# #
# SITER Solar Analysis - BATS Test Suite
# Copyright (C) 2026 Known Element
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
#
# BATS tests for siter-solar-analysis.sh # BATS tests for siter-solar-analysis.sh
# Run with: bats tests/ # Run with: bats tests/
# #
SCRIPT_PATH="/app/solar-analysis/siter-solar-analysis.sh" SCRIPT_PATH="/app/solar-analysis/siter-solar-analysis.sh"
# Helper function to check if rate limited
is_rate_limited() {
local output="$1"
[[ "$output" == *"429"* ]] || [[ "$output" == *"OVER_RATE_LIMIT"* ]] || [[ "$output" == *"rate limit"* ]]
}
#######################################
# UNIT TESTS - Script validation
#######################################
@test "script exists and is executable" { @test "script exists and is executable" {
[ -f "$SCRIPT_PATH" ] [ -f "$SCRIPT_PATH" ]
[ -x "$SCRIPT_PATH" ] [ -x "$SCRIPT_PATH" ]
} }
@test "script has valid bash syntax" {
bash -n "$SCRIPT_PATH"
}
@test "script passes shellcheck" {
command -v shellcheck >/dev/null 2>&1 || skip "shellcheck not installed"
run shellcheck -s bash "$SCRIPT_PATH"
[ "$status" -eq 0 ]
}
@test "dependencies are available (curl, jq, bc)" {
command -v curl >/dev/null 2>&1
command -v jq >/dev/null 2>&1
command -v bc >/dev/null 2>&1
}
#######################################
# UNIT TESTS - Help and version
#######################################
@test "help option displays usage" { @test "help option displays usage" {
run "$SCRIPT_PATH" --help run "$SCRIPT_PATH" --help
[ "$status" -eq 0 ] [ "$status" -eq 0 ]
[[ "$output" == *"SITER Solar Analysis"* ]] [[ "$output" == *"SITER Solar Analysis"* ]]
[[ "$output" == *"USAGE:"* ]] [[ "$output" == *"USAGE:"* ]]
[[ "$output" == *"--api-key"* ]]
[[ "$output" == *"--scenarios"* ]] [[ "$output" == *"--scenarios"* ]]
[[ "$output" == *"NREL_API_KEY"* ]] [[ "$output" == *"NREL_API_KEY"* ]]
} }
@test "help does NOT show --api-key option (security)" {
run "$SCRIPT_PATH" --help
[ "$status" -eq 0 ]
[[ "$output" != *"--api-key"* ]]
[[ "$output" != *"-k KEY"* ]]
}
@test "version option displays version" { @test "version option displays version" {
run "$SCRIPT_PATH" --version run "$SCRIPT_PATH" --version
[ "$status" -eq 0 ] [ "$status" -eq 0 ]
[[ "$output" =~ "siter-solar-analysis version "[0-9]+\.[0-9]+\.[0-9]+ ]] [[ "$output" =~ "siter-solar-analysis version "[0-9]+\.[0-9]+\.[0-9]+ ]]
} }
@test "short -h option shows help" {
run "$SCRIPT_PATH" -h
[ "$status" -eq 0 ]
[[ "$output" == *"USAGE:"* ]]
}
@test "short -v option shows version" {
run "$SCRIPT_PATH" -v
[ "$status" -eq 0 ]
[[ "$output" == *"version"* ]]
}
#######################################
# UNIT TESTS - Input validation
#######################################
@test "invalid option returns error" { @test "invalid option returns error" {
run "$SCRIPT_PATH" --invalid-option run "$SCRIPT_PATH" --invalid-option
[ "$status" -eq 1 ] [ "$status" -eq 1 ]
[[ "$output" == *"Unknown option"* ]] [[ "$output" == *"Unknown option"* ]]
} }
@test "dependencies are available" { @test "invalid latitude (non-numeric) returns error" {
command -v curl
command -v jq
command -v bc
}
@test "invalid latitude returns error" {
run "$SCRIPT_PATH" --lat "invalid" run "$SCRIPT_PATH" --lat "invalid"
[ "$status" -eq 1 ] [ "$status" -eq 1 ]
[[ "$output" == *"Invalid"* ]] || [[ "$output" == *"must be a number"* ]]
} }
@test "out of range latitude returns error" { @test "invalid latitude (empty string) returns error" {
run "$SCRIPT_PATH" --lat "999" run "$SCRIPT_PATH" --lat ""
[ "$status" -eq 1 ] [ "$status" -eq 1 ]
} }
@test "invalid longitude returns error" { @test "latitude too high (>90) returns error" {
run "$SCRIPT_PATH" --lat "91"
[ "$status" -eq 1 ]
[[ "$output" == *"Invalid"* ]] || [[ "$output" == *"between"* ]]
}
@test "latitude too low (<-90) returns error" {
run "$SCRIPT_PATH" --lat "-91"
[ "$status" -eq 1 ]
}
@test "invalid longitude (non-numeric) returns error" {
run "$SCRIPT_PATH" --lon "abc" run "$SCRIPT_PATH" --lon "abc"
[ "$status" -eq 1 ] [ "$status" -eq 1 ]
} }
@test "JSON output is valid JSON" { @test "longitude too high (>180) returns error" {
run "$SCRIPT_PATH" --json run "$SCRIPT_PATH" --lon "181"
if [ "$status" -eq 0 ]; then [ "$status" -eq 1 ]
echo "$output" | jq . }
@test "longitude too low (<-180) returns error" {
run "$SCRIPT_PATH" --lon "-181"
[ "$status" -eq 1 ]
}
@test "invalid panels (non-numeric) returns error" {
run "$SCRIPT_PATH" -p "abc"
[ "$status" -eq 1 ]
}
@test "invalid watts (non-numeric) returns error" {
run "$SCRIPT_PATH" -w "xyz"
[ "$status" -eq 1 ]
}
@test "invalid tilt (non-numeric) returns error" {
run "$SCRIPT_PATH" -t "foo"
[ "$status" -eq 1 ]
}
@test "invalid azimuth (non-numeric) returns error" {
run "$SCRIPT_PATH" -a "bar"
[ "$status" -eq 1 ]
}
@test "invalid losses (non-numeric) returns error" {
run "$SCRIPT_PATH" -l "baz"
[ "$status" -eq 1 ]
}
#######################################
# UNIT TESTS - Boundary values
#######################################
@test "latitude at min boundary (-90) is valid" {
run "$SCRIPT_PATH" --lat "-90" --lon "0"
# Should not fail validation (API may fail, but not input validation)
if [ "$status" -eq 1 ]; then
[[ "$output" != *"Invalid latitude"* ]]
fi fi
} }
@test "JSON output has required fields" { @test "latitude at max boundary (90) is valid" {
run "$SCRIPT_PATH" --json run "$SCRIPT_PATH" --lat "90" --lon "0"
if [ "$status" -eq 0 ]; then if [ "$status" -eq 1 ]; then
echo "$output" | jq -e '.system' [[ "$output" != *"Invalid latitude"* ]]
echo "$output" | jq -e '.production'
echo "$output" | jq -e '.financials'
fi fi
} }
@test "longitude at min boundary (-180) is valid" {
run "$SCRIPT_PATH" --lat "0" --lon "-180"
if [ "$status" -eq 1 ]; then
[[ "$output" != *"Invalid longitude"* ]]
fi
}
@test "longitude at max boundary (180) is valid" {
run "$SCRIPT_PATH" --lat "0" --lon "180"
if [ "$status" -eq 1 ]; then
[[ "$output" != *"Invalid longitude"* ]]
fi
}
@test "zero panels is handled" {
run "$SCRIPT_PATH" -p 0
# Should either error or produce 0kW system
[ "$status" -eq 1 ] || [[ "$output" == *"0.0 kW"* ]] || [[ "$output" == *"0 kW"* ]]
}
@test "negative panels is handled" {
run "$SCRIPT_PATH" -p -5
# Should fail validation
[ "$status" -eq 1 ]
}
@test "negative watts is handled" {
run "$SCRIPT_PATH" -w -400
# Should fail or be handled gracefully
[ "$status" -eq 1 ] || true
}
#######################################
# UNIT TESTS - Environment variables
#######################################
@test "NREL_API_KEY from environment is used" {
# This test uses DEMO_KEY via environment
NREL_API_KEY=DEMO_KEY run "$SCRIPT_PATH" --json
if is_rate_limited "$output"; then
skip "API rate limited"
fi
[ "$status" -eq 0 ]
}
#######################################
# INTEGRATION TESTS - API calls (require network)
# These tests may be skipped if rate limited
#######################################
@test "JSON output is valid JSON with NREL API" {
run "$SCRIPT_PATH" --json
if is_rate_limited "$output"; then
skip "API rate limited"
fi
[ "$status" -eq 0 ]
echo "$output" | jq . >/dev/null
}
@test "JSON output has required system fields" {
run "$SCRIPT_PATH" --json
if is_rate_limited "$output"; then
skip "API rate limited"
fi
[ "$status" -eq 0 ]
echo "$output" | jq -e '.system.capacity_kw' >/dev/null
echo "$output" | jq -e '.system.panels' >/dev/null
echo "$output" | jq -e '.system.panel_watts' >/dev/null
}
@test "JSON output has required production fields" {
run "$SCRIPT_PATH" --json
if is_rate_limited "$output"; then
skip "API rate limited"
fi
[ "$status" -eq 0 ]
echo "$output" | jq -e '.production.annual_kwh' >/dev/null
echo "$output" | jq -e '.production.monthly_kwh' >/dev/null
echo "$output" | jq -e '.production.capacity_factor' >/dev/null
}
@test "JSON output has required financial fields" {
run "$SCRIPT_PATH" --json
if is_rate_limited "$output"; then
skip "API rate limited"
fi
[ "$status" -eq 0 ]
echo "$output" | jq -e '.financials.annual_kwh' >/dev/null
echo "$output" | jq -e '.financials.monthly_savings' >/dev/null
echo "$output" | jq -e '.financials.payback_years' >/dev/null
}
@test "text output shows expected sections" { @test "text output shows expected sections" {
run "$SCRIPT_PATH" run "$SCRIPT_PATH"
if [ "$status" -eq 0 ]; then if is_rate_limited "$output"; then
[[ "$output" == *"SITER SOLAR PROJECT"* ]] skip "API rate limited"
[[ "$output" == *"NREL PVWATTS ANALYSIS"* ]]
[[ "$output" == *"System Configuration:"* ]]
[[ "$output" == *"FINANCIAL ANALYSIS"* ]]
[[ "$output" == *"ROI ANALYSIS"* ]]
[[ "$output" == *"PAYBACK PERIOD"* ]]
fi fi
[ "$status" -eq 0 ]
[[ "$output" == *"SITER SOLAR PROJECT"* ]]
[[ "$output" == *"NREL PVWATTS ANALYSIS"* ]]
[[ "$output" == *"System Configuration:"* ]]
[[ "$output" == *"FINANCIAL ANALYSIS"* ]]
[[ "$output" == *"ROI ANALYSIS"* ]]
[[ "$output" == *"PAYBACK PERIOD"* ]]
} }
@test "monthly production table shows all months" { @test "monthly production table shows all months" {
run "$SCRIPT_PATH" run "$SCRIPT_PATH"
if [ "$status" -eq 0 ]; then if is_rate_limited "$output"; then
for month in Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec; do skip "API rate limited"
[[ "$output" == *"$month"* ]]
done
[[ "$output" == *"ANNUAL"* ]]
fi
}
@test "scenarios mode shows header" {
run "$SCRIPT_PATH" --scenarios
if [ "$status" -eq 0 ]; then
[[ "$output" == *"SYSTEM SIZE SCENARIOS"* ]]
fi
}
@test "scenarios shows panel options" {
run "$SCRIPT_PATH" --scenarios
if [ "$status" -eq 0 ]; then
[[ "$output" == *"250W"* ]]
[[ "$output" == *"400W"* ]]
fi
}
@test "scenarios JSON output is array" {
run "$SCRIPT_PATH" --scenarios --json
if [ "$status" -eq 0 ]; then
local type
type=$(echo "$output" | jq -r 'type')
[ "$type" == "array" ]
fi fi
[ "$status" -eq 0 ]
for month in Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec; do
[[ "$output" == *"$month"* ]]
done
[[ "$output" == *"ANNUAL"* ]]
} }
@test "custom panel configuration works" { @test "custom panel configuration works" {
run "$SCRIPT_PATH" -p 20 -w 400 run "$SCRIPT_PATH" -p 20 -w 400
if [ "$status" -eq 0 ]; then if is_rate_limited "$output"; then
[[ "$output" == *"20 × 400W"* ]] skip "API rate limited"
[[ "$output" == *"8.0 kW"* ]]
fi fi
[ "$status" -eq 0 ]
[[ "$output" == *"20 × 400W"* ]]
[[ "$output" == *"8.0 kW"* ]] || [[ "$output" == *"8 kW"* ]]
} }
@test "invalid API key returns error" { @test "scenarios mode shows header" {
run "$SCRIPT_PATH" -k "invalid_key_for_testing_12345" run "$SCRIPT_PATH" --scenarios
if is_rate_limited "$output"; then
skip "API rate limited"
fi
[ "$status" -eq 0 ]
[[ "$output" == *"SYSTEM SIZE SCENARIOS"* ]]
}
@test "scenarios shows panel options" {
run "$SCRIPT_PATH" --scenarios
if is_rate_limited "$output"; then
skip "API rate limited"
fi
[ "$status" -eq 0 ]
[[ "$output" == *"250W"* ]]
[[ "$output" == *"400W"* ]]
}
@test "scenarios JSON output is array" {
run "$SCRIPT_PATH" --scenarios --json
if is_rate_limited "$output"; then
skip "API rate limited"
fi
[ "$status" -eq 0 ]
local type
type=$(echo "$output" | jq -r 'type')
[ "$type" == "array" ]
}
@test "verbose flag enables info output" {
run "$SCRIPT_PATH" --verbose
if is_rate_limited "$output"; then
skip "API rate limited"
fi
[ "$status" -eq 0 ]
}
@test "location from SITER_LAT/SITER_LON environment variables" {
SITER_LAT=32.77 SITER_LON=-96.79 run "$SCRIPT_PATH"
if is_rate_limited "$output"; then
skip "API rate limited"
fi
[ "$status" -eq 0 ]
[[ "$output" == *"32.77"* ]]
[[ "$output" == *"-96.79"* ]]
}
#######################################
# UNIT TESTS - Financial calculations
#######################################
@test "financial calculations produce numeric values" {
run "$SCRIPT_PATH" --json
if is_rate_limited "$output"; then
skip "API rate limited"
fi
[ "$status" -eq 0 ]
local annual_kwh monthly_savings payback_years
annual_kwh=$(echo "$output" | jq -r '.production.annual_kwh')
monthly_savings=$(echo "$output" | jq -r '.financials.monthly_savings')
payback_years=$(echo "$output" | jq -r '.financials.payback_years')
# Must be numeric
[[ "$annual_kwh" =~ ^[0-9]+$ ]]
[[ "$monthly_savings" =~ ^[0-9]+\.[0-9]+$ ]]
[[ "$payback_years" =~ ^[0-9]+\.[0-9]+$ ]]
}
@test "annual production is positive" {
run "$SCRIPT_PATH" --json
if is_rate_limited "$output"; then
skip "API rate limited"
fi
[ "$status" -eq 0 ]
local annual_kwh
annual_kwh=$(echo "$output" | jq -r '.production.annual_kwh')
[ "$annual_kwh" -gt 0 ]
}
@test "monthly savings is positive" {
run "$SCRIPT_PATH" --json
if is_rate_limited "$output"; then
skip "API rate limited"
fi
[ "$status" -eq 0 ]
local monthly_savings
monthly_savings=$(echo "$output" | jq -r '.financials.monthly_savings')
# Use bc for floating point comparison
(( $(echo "$monthly_savings > 0" | bc -l) ))
}
@test "payback period is reasonable (1-30 years)" {
run "$SCRIPT_PATH" --json
if is_rate_limited "$output"; then
skip "API rate limited"
fi
[ "$status" -eq 0 ]
local payback_years
payback_years=$(echo "$output" | jq -r '.financials.payback_years')
# Payback should be between 1 and 30 years for a viable project
(( $(echo "$payback_years >= 1" | bc -l) ))
(( $(echo "$payback_years <= 30" | bc -l) ))
}
@test "self-consumption value is greater than export value" {
run "$SCRIPT_PATH" --json
if is_rate_limited "$output"; then
skip "API rate limited"
fi
[ "$status" -eq 0 ]
local self_consumption_value export_value
self_consumption_value=$(echo "$output" | jq -r '.financials.self_consumption_value')
export_value=$(echo "$output" | jq -r '.financials.export_value')
# Self-consumption rate ($0.085) is higher than export rate ($0.04)
(( $(echo "$self_consumption_value > $export_value" | bc -l) ))
}
@test "capacity factor is in reasonable range" {
run "$SCRIPT_PATH" --json
if is_rate_limited "$output"; then
skip "API rate limited"
fi
[ "$status" -eq 0 ]
local capacity_factor
capacity_factor=$(echo "$output" | jq -r '.production.capacity_factor')
# Capacity factor should be between 10% and 25% for fixed solar
(( $(echo "$capacity_factor >= 10" | bc -l) ))
(( $(echo "$capacity_factor <= 25" | bc -l) ))
}
#######################################
# ERROR HANDLING TESTS
#######################################
@test "invalid API key returns error (not 200)" {
# Use a clearly invalid API key
NREL_API_KEY="invalid_key_12345_test" run "$SCRIPT_PATH"
[ "$status" -eq 1 ] [ "$status" -eq 1 ]
} }
@test "location from environment variables" { @test "missing argument after option returns error" {
SITER_LAT=32.77 SITER_LON=-96.79 run "$SCRIPT_PATH" run "$SCRIPT_PATH" --lat
if [ "$status" -eq 0 ]; then [ "$status" -eq 1 ]
[[ "$output" == *"32.77"* ]]
[[ "$output" == *"-96.79"* ]]
fi
} }
@test "financial calculations are numeric" { @test "missing argument after -p returns error" {
run "$SCRIPT_PATH" --json -w 250 run "$SCRIPT_PATH" -p
if [ "$status" -eq 0 ]; then [ "$status" -eq 1 ]
local annual_kwh monthly_savings payback_years }
annual_kwh=$(echo "$output" | jq -r '.production.annual_kwh') @test "missing argument after -w returns error" {
monthly_savings=$(echo "$output" | jq -r '.financials.monthly_savings') run "$SCRIPT_PATH" -w
payback_years=$(echo "$output" | jq -r '.financials.payback_years') [ "$status" -eq 1 ]
[[ "$annual_kwh" =~ ^[0-9]+$ ]]
[[ "$monthly_savings" =~ ^[0-9]+\.[0-9]+$ ]]
[[ "$payback_years" =~ ^[0-9]+\.[0-9]+$ ]]
fi
} }